SIF/1002/Platform/sitecore-xp1-dds.json
{
"Parameters": { "Package": { "Type": "string", "Description": "The path to the Web Deploy package to deploy.", "DefaultValue": "" }, "LicenseFile": { "Type": "string", "Description": "The path to the Sitecore license file.", "DefaultValue": ".\\License.xml" }, "SqlDbPrefix": { "Type": "string", "Description": "The prefix used for all Sql databases.", "DefaultValue": "" }, "SolrCorePrefix": { "Type": "string", "Description": "The prefix used for all Solr cores.", "DefaultValue": "" }, "SSLCert": { "Type": "string", "Description": "The certificate to use for HTTPS web bindings. Provide the name or the thumbprint. If not provided a certificate will be generated.", "DefaultValue": "" }, "XConnectCert": { "Type": "string", "Description": "The certificate to use for encryption. Provide the name or the thumbprint.", "DefaultValue": "" }, "SiteName": { "Type": "string", "DefaultValue": "SitecoreDDS", "Description": "The name of the site to be deployed." }, "SiteRoot": { "Type": "String", "Description": "Root folder to install the site to. If left on the default [systemdrive]:\\inetpub\\wwwroot will be used.", "DefaultValue": "" }, "SitecoreAdminPassword": { "Type": "string", "DefaultValue": "b", "Description": "The admin password for the Sitecore instance." }, "SqlAdminUser": { "Type": "string", "DefaultValue": "sa", "Description": "The Sql admin user account to use when installing databases." }, "SqlAdminPassword": { "Type": "string", "DefaultValue": "12345", "Description": "The Sql admin password to use when installing databases." }, "SqlCoreUser": { "Type": "string", "DefaultValue": "coreuser", "Description": "The user to create and use in Core connection string." }, "SqlCorePassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Core connection string in Sitecore." }, "SqlSecurityUser": { "Type": "string", "DefaultValue": "securityuser", "Description": "The user to create and use in Security connection string." }, "SqlSecurityPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Security connection string in Sitecore." }, "SqlMasterUser": { "Type": "string", "DefaultValue": "masteruser", "Description": "The user to create and use in Master connection string." }, "SqlMasterPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Master connection string in Sitecore." }, "SqlWebUser": { "Type": "string", "DefaultValue": "webuser", "Description": "The user to create and use in Web connection string." }, "SqlWebPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Web connection string in Sitecore." }, "SqlReportingUser": { "Type": "string", "DefaultValue": "reportinguser", "Description": "The user to create and use in Reporting connection string." }, "SqlReportingPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Reporting connection string in Sitecore." }, "SqlReferenceDataUser": { "Type": "string", "DefaultValue": "referencedatauser", "Description": "The user to create and use in Reference Data connection string." }, "SqlReferenceDataPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Reference Data connection string in Sitecore." }, "SqlFormsUser": { "Type": "string", "DefaultValue": "formsuser", "Description": "The user to create and use in Experience Forms connection string." }, "SqlFormsPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Experience Forms connection string in Sitecore." }, "SqlExmMasterUser": { "Type": "string", "DefaultValue": "exmmasteruser", "Description": "The Sql user for the EXM Master connection string in Sitecore." }, "SqlExmMasterPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the EXM Master connection string in Sitecore." }, "SqlMessagingUser": { "Type": "string", "DefaultValue": "messaginguser", "Description": "The Sql user for the Messaging connection string in Sitecore." }, "SqlMessagingPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Messaging connection string in Sitecore." }, "SqlSessionsUser": { "Type": "string", "DefaultValue": "sa", "Description": "The Sql user for the Sessions connection string in Sitecore." }, "SqlSessionsPassword": { "Type": "string", "DefaultValue": "12345", "Description": "The Sql password for the Sessions connection string in Sitecore." }, "SqlServer": { "Type": "string", "DefaultValue": ".\\SQL2016", "Description": "The Sql Server where databases will be installed." }, "ExmEdsProvider": { "Type": "string", "DefaultValue": "CustomSMTP", "Description": "The default EDS provider to be used." }, "SolrUrl": { "Type": "string", "DefaultValue": "https://localhost:8983/solr", "Description": "The Solr instance to use." }, "ProcessingService": { "Type": "string", "DefaultValue": "https://SitecoreProcessing", "Description": "The url for the Processing Service." }, "ReportingService": { "Type": "string", "DefaultValue": "https://SitecoreReporting", "Description": "The url for the Reporting Service." }, "ReportingServiceApiKey": { "Type": "string", "DefaultValue": "00112233445566778899AABBCCDDEEFF", "Description": "The api key to use with the Reporting Service server must be at least 32 characters long. e.g 00112233445566778899AABBCCDDEEFF" }, "XConnectCollectionService": { "Type": "string", "DefaultValue": "https://XConnectCollection", "Description": "The url for the XConnect Collection Service." }, "XConnectCollectionSearchService": { "Type": "string", "DefaultValue": "https://XConnectCollectionSearch", "Description": "The url for the XConnect Collection Search Service." }, "XConnectReferenceDataService": { "Type": "string", "DefaultValue": "https://XConnectReferenceData", "Description": "The url for the XConnect Reference Data Service." }, "MarketingAutomationOperationsService": { "Type": "string", "DefaultValue": "http://XConnectMarketingAutomation", "Description": "The url for the XConnect Marketing Automation Service." }, "SitecoreIdentityAuthority": { "Type": "string", "DefaultValue": "https://SitecoreIdentityServerHost", "Description": "IdentityServer provider URI." }, "SitecoreIdentitySecret": { "Type": "string", "DefaultValue": "", "Description": "Client secret for Sitecore Identity server." }, "MarketingAutomationReportingService": { "Type": "string", "DefaultValue": "http://XConnectMarketingAutomationReporting", "Description": "The url for the XConnect Marketing Automation Reporting Service." }, "EXMCryptographicKey": { "Type": "string", "DefaultValue": "0x0000000000000000000000000000000000000000000000000000000000000000", "Description": "64 digits hexadecimal EXM Cryptographic Key. Takes the form 0x0000000000000000000000000000000000000000000000000000000000000000" }, "EXMAuthenticationKey": { "Type": "string", "DefaultValue": "0x0000000000000000000000000000000000000000000000000000000000000000", "Description": "64 digits hexadecimal EXM Authentication Key. Takes the form 0x0000000000000000000000000000000000000000000000000000000000000000" }, "EXMInternalApiKey": { "Type": "string", "DefaultValue": "0x0000000000000000000000000000000000000000000000000000000000000000", "Description": "64 digits hexadecimal EXM Internal API Key. Takes the form 0x0000000000000000000000000000000000000000000000000000000000000000" }, "HostMappingName": { "Type": "string", "Reference": "SiteName", "Description": "The host mapping name of the site." }, "DnsName": { "Type": "string", "Reference": "SiteName", "Description": "The dns name of the site." }, "PackagesTempLocation": { "Type": "String", "Description": "Alternative location to save WDP packages. If left on the default $Env:Temp will be used.", "DefaultValue": "", "Validate": "[TestPath(variable('Package.Download.Location'))]" }, "DownloadLocations": { "Type": "String", "Description": "File with URI and SHA256 hashes of dynamically downloadable WDPs.", "DefaultValue": ".\\downloads.json" } }, "Register": { "ConfigFunction": { "TestPath": "Test-Path", "SelectObject": "Select-Object", "SplitPath": "Split-Path", "GetVariable": "Get-Variable" }, "Tasks": { "RemoveItem": "Remove-Item" } }, "Variables": { "Sql.Database.Core.Name": "[concat(parameter('SqlDbPrefix'), '_Core')]", "Sql.Database.Security.Name": "[concat(parameter('SqlDbPrefix'), '_Core')]", "Sql.Database.Master.Name": "[concat(parameter('SqlDbPrefix'), '_Master')]", "Sql.Database.Web.Name": "[concat(parameter('SqlDbPrefix'), '_Web')]", "Sql.Database.Reporting.Name": "[concat(parameter('SqlDbPrefix'), '_Reporting')]", "Sql.Database.ReferenceData.Name": "[concat(parameter('SqlDbPrefix'), '_ReferenceData')]", "Sql.Database.Forms.Name": "[concat(parameter('SqlDbPrefix'), '_ExperienceForms')]", "Sql.Database.EXMMaster.Name": "[concat(parameter('SqlDbPrefix'), '_EXM.Master')]", "Sql.Database.Messaging.Name": "[concat(parameter('SqlDbPrefix'), '_Messaging')]", "Solr.Core.Core.Name": "[concat(parameter('SolrCorePrefix'), '_core_index')]", "Solr.Core.Master.Name": "[concat(parameter('SolrCorePrefix'), '_master_index')]", "Solr.Core.Web.Name": "[concat(parameter('SolrCorePrefix'), '_web_index')]", "Solr.Core.MarketingDefinitions.Master.Name": "[concat(parameter('SolrCorePrefix'), '_marketingdefinitions_master')]", "Solr.Core.MarketingDefinitions.Web.Name": "[concat(parameter('SolrCorePrefix'), '_marketingdefinitions_web')]", "Solr.Core.MarketingAssets.Master.Name": "[concat(parameter('SolrCorePrefix'), '_marketing_asset_index_master')]", "Solr.Core.MarketingAssets.Web.Name": "[concat(parameter('SolrCorePrefix'), '_marketing_asset_index_web')]", "Solr.Core.Testing.Name": "[concat(parameter('SolrCorePrefix'), '_testing_index')]", "Solr.Core.Suggested.Name": "[concat(parameter('SolrCorePrefix'), '_suggested_test_index')]", "Solr.Core.FXM.Master.Name": "[concat(parameter('SolrCorePrefix'), '_fxm_master_index')]", "Solr.Core.FXM.Web.Name": "[concat(parameter('SolrCorePrefix'), '_fxm_web_index')]", "Solr.Core.Personalization.Name": "[concat(parameter('SolrCorePrefix'), '_personalization_index')]", "Certificates.Store": "Cert:\\Localmachine\\My", "Certificates.Site.Thumbprint": "[GetCertificateThumbprint(parameter('SSLCert'), variable('Certificates.Store'))]", "Certificates.XConnect.Thumbprint": "[GetCertificateThumbprint(parameter('XConnectCert'), variable('Certificates.Store'))]", "Certificates.XConnect.Path": "[joinpath(variable('Certificates.Store'), variable('Certificates.XConnect.Thumbprint'))]", "Site.Path": "[if(variable('Site.Path.Test'),variable('Site.Path.Default'),variable('Site.Path.Custom'))]", "Site.Path.Default": "[joinpath(environment('SystemDrive'), 'inetpub', 'wwwroot', parameter('SiteName'))]", "Site.Path.Custom": "[joinpath(parameter('SiteRoot'),parameter('SiteName'))]", "Site.Path.Test": "[equal(parameter('SiteRoot'),'')]", "Site.DataFolder": "[joinpath(variable('Site.Path'), 'App_Data')]", "Packages.DownloadLocations.File": "[ReadJson(parameter('DownloadLocations'))]", "Packages.DownloadLocations.File.Test": "[TestPath(Path:Parameter('DownloadLocations'))]", "Package.Download.Identifier": "sitecore-xp1-dds.json", "Package.Download.Location": "[if(variable('Package.Download.Location.Test'),Environment('Temp'),parameter('PackagesTempLocation'))]", "Package.Download.Location.Test": "[equal(parameter('PackagesTempLocation'),'')]", "Package.Download.Object": "[SelectObject(InputObject:variable('Packages.DownloadLocations.File'),ExpandProperty:variable('Package.Download.Identifier'))]", "Package.Download.Uri": "[SelectObject(InputObject:variable('Package.Download.Object'),ExpandProperty:'Uri')]", "Package.Download.Hash": "[SelectObject(InputObject:variable('Package.Download.Object'),ExpandProperty:'Hash')]", "Package.Download.Path": "[JoinPath(variable('Package.Download.Location'),variable('Package.Download.Filename'))]", "Package.Download.Document": "[SplitPath(Path:variable('Package.Download.Uri'),Leaf:true)]", "Package.Download.Filename": "[Split(String:variable('Package.Download.Document'),Characters:'?')]", "Package": "[if(parameter('Package'),parameter('Package'),variable('Package.Download.Path'))]", "Package.Available": "[or(variable('Package.Provided'),not(variable('Packages.DownloadLocations.File.Test')))]", "Package.Provided": "[if(parameter('Package'),parameter('Package'),'')]" }, "Tasks": { "DownloadWDP": { "Description": "Download the WDP and verifies it against the stored hash.", "Type": "DownloadFile", "Params": { "SourceUri": "[variable('Package.Download.URI')]", "DestinationPath": "[variable('Package.Download.Path')]", "Hash": "[variable('Package.Download.Hash')]" }, "Skip": "[variable('Package.Available')]" }, "CreatePaths": { "Description": "Ensure the destination path for the site exists.", "Type": "EnsurePath", "Params": { "Exists": [ "[variable('Site.Path')]" ] } }, "CreateAppPool": { "Description": "Creates or updates the app pool.", "Type": "AppPool", "Params": { "Name": "[parameter('SiteName')]", "Properties": { "ProcessModel": { "identityType": "ApplicationPoolIdentity" } } } }, "CreateWebsite": { "Description": "Creates or updates the IIS website instance.", "Type": "Website", "Params": { "Name": "[parameter('SiteName')]", "ApplicationPool": "[parameter('SiteName')]", "PhysicalPath": "[variable('Site.Path')]" } }, "StopWebsite": { "Description": "Stops the website if it is running.", "Type": "ManageWebsite", "Params": { "Name": "[parameter('SiteName')]", "Action": "Stop" } }, "StopAppPool": { "Description": "Stops the app pool if it is running.", "Type": "ManageAppPool", "Params": { "Name": "[parameter('SiteName')]", "Action": "Stop" } }, "RemoveDefaultBinding": { "Description": "Removes the default *:80 web binding.", "Type": "WebBinding", "Params": { "SiteName": "[parameter('SiteName')]", "Remove": [ { "Port": "80", "IPAddress": "*" } ] } }, "CreateBindingsWithThumbprint": { "Description": "Configures the site bindings for the website.", "Type": "WebBinding", "Params": { "SiteName": "[parameter('SiteName')]", "Add": [ { "HostHeader": "[parameter('DnsName')]", "Protocol": "https", "SSLFlags": 1, "Thumbprint": "[variable('Certificates.Site.Thumbprint')]" } ] }, "Skip": "[not(parameter('SSLCert'))]" }, "CreateHostHeader": { "Description": "Sets a hostheader for the website.", "Type": "HostHeader", "Params": { "HostName": "[parameter('HostMappingName')]" }, "Skip": "[not(parameter('HostMappingName'))]" }, "SetPermissions": { "Description": "Sets permissions for the app pool user.", "Type": "FilePermissions", "Params": { "Path": "[variable('Site.Path')]", "Rights": [ { "User": "[concat('IIS AppPool\\', parameter('SiteName'))]", "FileSystemRights": "FullControl", "InheritanceFlags": [ "ContainerInherit", "ObjectInherit" ] } ] } }, "SetCertStorePermissions": { "Description": "Set permissions for the services to access the client certificate.", "Type": "FilePermissions", "Params": { "Path": "[ResolveCertificatePath(variable('Certificates.XConnect.Path'))]", "Rights": [ { "User": "[concat('IIS AppPool\\', parameter('SiteName'))]", "FileSystemRights": [ "Read" ], "InheritanceFlags": [ "None" ] } ] } }, "InstallWDP": { "Description": "Syncs the web deploy package with the website.", "Type": "WebDeploy", "Params": { "Verb": "Sync", "Arguments": { "Source": { "Package": "[resolvepath(variable('Package'))]" }, "Dest": "Auto", "Skip": [ { "ObjectName": "dbDacFx" }, { "ObjectName": "dbFullSql" } ], "SetParam": [ { "Name": "Application Path", "Value": "[parameter('SiteName')]" }, { "Name": "Database Server Name", "Value": "[parameter('SqlServer')]" }, { "Name": "Database Admin User Name", "Value": "[parameter('SqlAdminUser')]" }, { "Name": "Database Admin User Password", "Value": "[parameter('SqlAdminPassword')]" }, { "Name": "Core DB Name", "Value": "[variable('Sql.Database.Core.Name')]" }, { "Name": "Security DB Name", "Value": "[variable('Sql.Database.Security.Name')]" }, { "Name": "Master DB Name", "Value": "[variable('Sql.Database.Master.Name')]" }, { "Name": "Web DB Name", "Value": "[variable('Sql.Database.Web.Name')]" }, { "Name": "Reporting DB Name", "Value": "[variable('Sql.Database.Reporting.Name')]" }, { "Name": "XDB Reference Data DB Name", "Value": "[variable('Sql.Database.ReferenceData.Name')]" }, { "Name": "Experience Forms DB Name", "Value": "[variable('Sql.Database.Forms.Name')]" }, { "Name": "EXM Master DB Name", "Value": "[variable('Sql.Database.EXMMaster.Name')]" }, { "Name": "Messaging DB Name", "Value": "[variable('Sql.Database.Messaging.Name')]" }, { "Name": "Core DB User Name", "Value": "[parameter('SqlCoreUser')]" }, { "Name": "Core DB User Password", "Value": "[parameter('SqlCorePassword')]" }, { "Name": "Security DB User Name", "Value": "[parameter('SqlSecurityUser')]" }, { "Name": "Security DB User Password", "Value": "[parameter('SqlSecurityPassword')]" }, { "Name": "Master DB User Name", "Value": "[parameter('SqlMasterUser')]" }, { "Name": "Master DB User Password", "Value": "[parameter('SqlMasterPassword')]" }, { "Name": "Web DB User Name", "Value": "[parameter('SqlWebUser')]" }, { "Name": "Web DB User Password", "Value": "[parameter('SqlWebPassword')]" }, { "Name": "Reporting DB User Name", "Value": "[parameter('SqlReportingUser')]" }, { "Name": "Reporting DB User Password", "Value": "[parameter('SqlReportingPassword')]" }, { "Name": "XDB Reference Data DB User Name", "Value": "[parameter('SqlReferenceDataUser')]" }, { "Name": "XDB Reference Data DB User Password", "Value": "[parameter('SqlReferenceDataPassword')]" }, { "Name": "Experience Forms DB User Name", "Value": "[parameter('SqlFormsUser')]" }, { "Name": "Experience Forms DB User Password", "Value": "[parameter('SqlFormsPassword')]" }, { "Name": "EXM Master DB User Name", "Value": "[parameter('SqlExmMasterUser')]" }, { "Name": "EXM Master DB User Password", "Value": "[parameter('SqlExmMasterPassword')]" }, { "Name": "Messaging DB User Name", "Value": "[parameter('SqlMessagingUser')]" }, { "Name": "Messaging DB User Password", "Value": "[parameter('SqlMessagingPassword')]" }, { "Name": "XConnect Collection", "Value": "[parameter('XConnectCollectionService')]" }, { "Name": "XConnect Search", "Value": "[parameter('XConnectCollectionSearchService')]" }, { "Name": "Xdb Reference Data Client", "Value": "[parameter('XConnectReferenceDataService')]" }, { "Name": "XDB MA Reporting Client", "Value": "[parameter('MarketingAutomationReportingService')]" }, { "Name": "XDB MA Ops Client", "Value": "[parameter('MarketingAutomationOperationsService')]" }, { "Name": "XConnect Server Certificate Validation Thumbprint", "Value": "[variable('Certificates.XConnect.Thumbprint')]" }, { "Name": "Processing Site URL", "Value": "[parameter('ProcessingService')]" }, { "Name": "Reporting Site URL", "Value": "[parameter('ReportingService')]" }, { "Name": "Reporting API Key", "Value": "[parameter('ReportingServiceApiKey')]" }, { "Name": "SOLR Connection String", "Value": "[parameter('SolrUrl')]" }, { "Name": "Solr Core Index Name", "Value": "[variable('Solr.Core.Core.Name')]" }, { "Name": "Solr Master Index Name", "Value": "[variable('Solr.Core.Master.Name')]" }, { "Name": "Solr Web Index Name", "Value": "[variable('Solr.Core.Web.Name')]" }, { "Name": "Solr Marketing Definitions Master Index Name", "Value": "[variable('Solr.Core.MarketingDefinitions.Master.Name')]" }, { "Name": "Solr Marketing Definitions Web Index Name", "Value": "[variable('Solr.Core.MarketingDefinitions.Web.Name')]" }, { "Name": "Solr Marketing Asset Master Index Name", "Value": "[variable('Solr.Core.MarketingAssets.Master.Name')]" }, { "Name": "Solr Marketing Asset Web Index Name", "Value": "[variable('Solr.Core.MarketingAssets.Web.Name')]" }, { "Name": "Solr Testing Index Name", "Value": "[variable('Solr.Core.Testing.Name')]" }, { "Name": "Solr Suggested Index Name", "Value": "[variable('Solr.Core.Suggested.Name')]" }, { "Name": "Solr FXM Master Index Name", "Value": "[variable('Solr.Core.FXM.Master.Name')]" }, { "Name": "Solr FXM Web Index Name", "Value": "[variable('Solr.Core.FXM.Web.Name')]" }, { "Name": "Solr Personalization Index Name", "Value": "[variable('Solr.Core.Personalization.Name')]" }, { "Name": "Sitecore Identity Authority", "Value": "[parameter('SitecoreIdentityAuthority')]" }, { "Name": "Sitecore Identity Secret", "Value": "[parameter('SitecoreIdentitySecret')]" }, { "Name": "EXM Cryptographic Key", "Value": "[parameter('EXMCryptographicKey')]" }, { "Name": "EXM Authentication Key", "Value": "[parameter('EXMAuthenticationKey')]" }, { "Name": "EXM EDS Provider", "Value": "[parameter('ExmEdsProvider')]" }, { "Name": "EXM Internal Api Key", "Value": "[parameter('EXMInternalApiKey')]" } ] } } }, "CreateBindingsWithDevelopmentThumbprint": { "Description": "Creates a new thumbprint with a custom CA.", "Type": "AddWebFeatureSSL", "Params": { "SiteName": "[parameter('SiteName')]", "HostName": "[parameter('DnsName')]", "OutputDirectory": "[variable('Site.DataFolder')]" }, "Skip": "[parameter('SSLCert')]" }, "SetLicense": { "Description": "Copies the license file to the instance data folder.", "Type": "Copy", "Params": { "Source": "[resolvepath(parameter('LicenseFile'))]", "Destination": "[variable('Site.DataFolder')]" } }, "StartAppPool": { "Description": "Starts the app pool.", "Type": "ManageAppPool", "Params": { "Name": "[parameter('SiteName')]", "Action": "Start" } }, "StartWebsite": { "Description": "Starts the website.", "Type": "ManageWebsite", "Params": { "Name": "[parameter('SiteName')]", "Action": "Start" } } }, "UninstallTasks": { "StopWebsite": { "Description": "Stops the website if it is running.", "Type": "ManageWebsite", "Params": { "Name": "[parameter('SiteName')]", "Action": "Stop", "ErrorAction": "SilentlyContinue" } }, "StopAppPool": { "Description": "Stops the app pool if it is running.", "Type": "ManageAppPool", "Params": { "Name": "[parameter('SiteName')]", "Action": "Stop", "ErrorAction": "SilentlyContinue" } }, "RemoveWebsite": { "Description": "Removes the IIS website.", "Type": "RemoveWebsite", "Params": { "Name": "[parameter('SiteName')]" } }, "RemoveAppPool": { "Description": "Removes the IIS application pool.", "Type": "RemoveAppPool", "Params": { "Name": "[parameter('SiteName')]" } }, "RemoveContent": { "Description": "Removes website content.", "Type": "RemoveItem", "Params": { "Path": "[variable('Site.Path')]", "Recurse": true, "ErrorAction": "SilentlyContinue" } }, "RemoveHostHeader": { "Description": "Removes the website host name.", "Type": "HostHeader", "Params": { "HostName": "[parameter('SiteName')]", "Action": "Remove" } } } } |