xd7deliverycontroller
Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 3.8.0 < 6.0.0
Start using this module
Add this module to your Puppetfile:
mod 'virtualdesktopdevops-xd7deliverycontroller', '2.0.0'
Learn more about managing modules with a PuppetfileDocumentation
Citrix XenDesktop 7 delivery controller Puppet Module
Puppet module installing a production grade Citrix XenDesktop 7.x Delivery Controller, including XenDesktop site creation, high availability configuration and administrator rights setup.
The following options are available for a production-grade installation :
- Fault tolerance : AlwaysOn database membership activation for Citrix databases created by the package
- Sécurity : SSL configuration to secure communications with the Citrix XML Broker Service
Requirements
The minimum Windows Management Framework (PowerShell) version required is 5.0 or higher, which ships with Windows 10 or Windows Server 2016, but can also be installed on Windows 7 SP1, Windows 8.1, Windows Server 2008 R2 SP1, Windows Server 2012 and Windows Server 2012 R2.
This module requires SQLServer powershell module v21.0.17199. The module will install this dependancy :
- From Powershell Gallery if sqlservermodulesource parameter is set to internet
- From an enterprise location if sqlservermodulesource parameter is set to offline. In this case, the ZIP file containing the SQLServer v21.0.17199 (sqlserver_powershell_21.0.17199.zip) has to be manually downloaded from Powershell Gallery using the
Save-Module -Name SqlServer -Path <path> -RequiredVersion 21.0.17199
powershell command.
This module requires a custom version of the puppetlabs-dsc module compiled with XenDesktop Powershell DSC Resource as a dependency. Ready to use virtualdesktopdevops/dsc v1.5.0 puppet module provided on Puppet Forge.
Change log
A full list of changes in each version can be found in the change log.
Integration informations
The Citrix databases will be installed in the default MSSQLSERVER SQL Server instance. This module does not provide the capability to install the databases in another SQL intance.
The database failover mecanism integrated in this module is SQL Server AlwaysOn.
The SSL certificate provided needs to be a password protected p12/pfx certificate including the private key.
The module can be installed on a Standard, Datacenter version of Windows 2012R2 or Windows 2016. Core version is not supported by Citrix for delivery Controller installation.
Migrated puppet example code in README.md to future parser syntax (4.x). Impact on parameters refering to remote locations (file shares) which have to be prefixed with \\ instead of the classical \. This is because of Puppet >= 4.x parsing \ as a single \ in single-quoted strings. Use parser = future in puppet 3.x /etc/puppet/puppet.conf to use this new configuration in your Puppet 3.x and prepare Puppet 4.x migration.
Usage
Mandatory parameters :
[String]
setup_svc_username (Required): Privileged account used by Puppet for installing the software and the Xendesktop Site (cred_ssp server and client, SQL server write access, local administrator privilèges needed)
[String]
setup_svc_password (Required): Password of the privileged account. Should be encrypted with hiera-eyaml.[String]
sourcepath (Required): Path of a folder containing the Xendesktop 7.x installer (unarchive the ISO image in this folder). Has to be prefixed with \\ instead of the classical \ if using UNC Path and Puppet >= 4.x or Puppet 3.x future parser.[String]
sitename (Required): Name of the Xendesktop site[String]
role (Required[primary|secondary]
): Needs to be 'primary' for the first Citrix Delivery Controller of a site to initialize the databases and the Xendesktop site. Configure as 'secondary' for all other delivery Controllers of the site as they will join an existing Xendesktop site.
Required parameters if role='primary' :
[String]
databaseserver (Required if role='primary'): FQDN of the SQL server used for citrix database hosting. If using a AlwaysOn SQL cluster, use the Listener FQDN.[String]
licenceserver (Required if role='primary'): FQDN of the Citrix Licence server.[String]
xd7administrator (Required if role='primary'): ActiveDirectory user or group which will be granted Citrix Administrator rights.
Required parameters if role='secondary' :
[String]
site_primarycontroller (Required if role='secondary'): Primary controller of the existing Xendesktop site to which the newly configured Delivery Controller has to be joined.
Optional parameters :
[String]
sitedatabasename (Optional, default is CitrixSiteDB): Name of the citrix site database to be created[String]
loggingdatabasename (Optional, default is CitrixLogDB): Name of the citrix logging database to be created[String]
monitordatabasename (Optional, default is CitrixMonitorDB): Name of the citrix monitor database to be created[Boolean]
sqlalwayson (Optional, default is false): Activate database AlwaysOn availability group membership ? Default is false. Needs to be true for a production grade environment[String]
sqlavailabilitygroup (Required if sqlalwayson = true): Name of the SQL AlwaysOn availability group.[String]
sqldbbackuppath (Required if sqlalwayson = true): UNC path of a writable network folder to backup/restore databases during AlwaysOn availability group membership configuration. needs to be writable from the sql server nodes. Has to be prefixed with \\ instead of the classical \ if using Puppet >= 4.x or Puppet 3.x future parser.
[String]
sqlservermodulesource (Optional,[internet|offline]
): Source of SQLServer Powershell module v21.0.17199 (see requirements at the beginning of this readme). Valid values are internet or offline. Default is 'internet'.[String]
sqlservermodulesourcepath (Required if sqlservermodulesource = 'offline' ): Path of the SQLServer Powershell module v21.0.17199 ZIP file. Can be a local or an UNC path.
[Boolean]
https (Optional, default is false): Deploy SSL certificate and activate SSL access to Citrix XML service ? Default : false[String]
sslCertificateSourcePath (Required if https = true): Location of the SSL certificate (p12 / PFX format with private key). Can be local folder, UNC path, HTTP URL). Has to be prefixed with \\ instead of the classical \ if using UNC Path and Puppet >= 4.x or Puppet 3.x future parser.[String]
sslCertificatePassword (Required if https = true): Password protecting the p12/pfx SSL certificate file.[String]
sslCertificateThumbprint (Required if https = true): Thumbprint of the SSL certificate (available in the SSL certificate).
Installing a Citrix Delivery Controller
node 'CXDC01' {
class{'xd7deliverycontroller':
setup_svc_username => 'TESTLAB\svc-puppet',
setup_svc_password => 'P@ssw0rd',
sourcepath => '\\\\fileserver\xendesktop715',
sitename => 'XD7TestSite',
role => 'primary'
databaseserver => 'CLSDB01LI.TESTLAB.COM',
licenceserver => 'LICENCE.TESTLAB.COM',
xd7administrator => 'TESTLAB\Domain Admins',
sitedatabasename => 'SITE_DB',
loggingdatabasename => 'LOG_DB',
monitordatabasename => 'MONITOR_DB',
sqlalwayson => true,
sqlavailabilitygroup => 'CLSDB01',
sqldbbackuppath => '\\\\fileserver\backup\sql',
https => true,
sslCertificateSourcePath => '\\\\fileserver\ssl\cxdc.pfx',
sslCertificatePassword => 'P@ssw0rd',
sslCertificateThumbprint => '44cce73845feef4da4d369a37386c862eb3bd4e1'
}
}
node 'CXDC02' {
class{'xd7deliverycontroller':
setup_svc_username => 'TESTLAB\svc-puppet',
setup_svc_password => 'P@ssw0rd',
sourcepath => '\\\\fileserver\xendesktop715',
sitename => 'XD7TestSite',
role => 'secondary',
site_primarycontroller => 'CXDC01',
https => true,
sslCertificateSourcePath => '\\\\fileserver\ssl\cxdc.pfx',
sslCertificatePassword => 'P@ssw0rd',
sslCertificateThumbprint => '44cce73845feef4da4d369a37386c862eb3bd4e1'
}
}
Changelog - xd7deliverycontroller
Version 2.0.0
- BREAKING CHANGE : Merged xd7mastercontroller and xd7slavecontroller into xd7deliverycontroller. Added a role parameter to install a primary controller with XenDesktop site creation or a secondary controller joined to an existing XenDesktop site.
- BREAKING CHANGE : Require virtualdesktopdevops/dsc >= 1.5.0 (puppetlabs/dsc fork compiled with XenDesktop7 DSC resource)
- BREAKING CHANGE : Removed unneeded $domainNetbiosName parameter.
- BREAKING CHANGE : Migrated puppet example code in README.md to future parser syntax (4.x). Impact on parameters refering to remote locations (file shares) which have to be prefixed with \\ instead of the classical \. This is because of Puppet >= 4.x parsing \ as a single \ in single-quoted strings. Use parser = future in puppet 3.x /etc/puppet/puppet.conf to use this new configuration in your Puppet 3.x and prepare Puppet 4.x migration.
- BREAKING CHANGE : Changed all module parameters to lowercase to comply with puppet guidelines.
- BREAKING CHANGE : Removed SQLServer Powershell resource from the module. Added sqlservermodulesource and sqlservermodulesourcepath parameters to install is from the internet or from an enterprise file share.
- Compliance with puppet language style guide and puppet forge standards.
- Class parameters data types.
Version 1.1.0
- Initial release
- Module compatible with xSQLServer <= 9.0.0.0
Dependencies
- reidmv/unzip (>= 0.1.2)
- puppetlabs/registry (>= 1.1.4)
- virtualdesktopdevops/dsc (>= 1.5.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.