overrides/onPremAllInOne/xconnect-xp0.json
|
// -------------------------------------------------------------------------- //
// Sitecore Install Framework - XConnect XP0 Configuration // // // // Run this configuration to install a single instance of XConnect. // // // // NOTE: Only single line comments are accepted in configurations. // // -------------------------------------------------------------------------- // { "Parameters": { // Parameters are values that may be passed when Install-SitecoreConfiguration is called. // Parameters must declare a Type and may declare a DefaultValue and Description. // Parameters with no DefaultValue are required when Install-SitecoreConfiguration is called. "Package": { "Type": "string", "Description": "The path to the Web Deploy package to deploy." }, "LicenseFile": { "Type": "string", "Description": "The path to the Sitecore license file." }, "SiteName": { "Type": "string", "DefaultValue": "XConnect", "Description": "The name of the site to be deployed." }, "XConnectCert": { "Type": "string", "Description": "The certificate to use for encryption. Provide the name or the thumbprint." }, "SqlDbPrefix": { "Type": "string", "Description": "The prefix used for all Sql databases." }, "SolrCorePrefix": { "Type": "string", "Description": "The prefix used for all Solr cores." }, "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": "" }, "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." }, "SolrUrl": { "Type": "string", "DefaultValue": "https://localhost:8983/solr", "Description": "The Solr instance to use." }, "SqlCollectionUser": { "Type": "string", "DefaultValue": "collectionuser", "Description": "The Sql admin user account to use when installing databases." }, "SqlCollectionPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql admin password to use when installing databases." }, "SqlProcessingPoolsUser": { "Type": "string", "DefaultValue": "poolsuser", "Description": "The Sql user for the Processing Pools connection string in Sitecore." }, "SqlProcessingPoolsPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Processing Pools connection string in Sitecore." }, "SqlReferenceDataUser": { "Type": "string", "DefaultValue": "referencedatauser", "Description": "The Sql user for the Reference Data connection string in Sitecore." }, "SqlReferenceDataPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Reference Data connection string in Sitecore." }, "SqlMarketingAutomationUser": { "Type": "string", "DefaultValue": "marketingautomationuser", "Description": "The Sql user for the Marketing Automation connection string in Sitecore." }, "SqlMarketingAutomationPassword": { "Type": "string", "DefaultValue": "Test12345", "Description": "The Sql password for the Marketing Automation 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." }, "SqlServer": { "Type": "string", "DefaultValue": ".\\SQLSERVER", "Description": "The Sql Server where databases will be installed." }, "XConnectEnvironment": { "Type": "string", "DefaultValue": "Development", "Description": "The configuration environment for this instance." }, "XConnectLogLevel": { "Type": "string", "DefaultValue": "Information", "Description": "The level of log information to output." }, "InstallDirectory": { "Type": "string", "Description": "Installation directory" } }, "Variables": { // Variables are values calculated in a configuration. // They can reference Parameters, other Variables, and config functions. // The prefix for shards created by the tool "Sharding.Database.Prefix": "[concat(parameter('SqlDbPrefix'), '_Xdb.Collection.Shard')]", // The database names. "Sql.Database.ShardMapManager": "[concat(variable('Sharding.Database.Prefix'), 'MapManager')]", "Sql.Database.Shard0": "[concat(variable('Sharding.Database.Prefix'), '0')]", "Sql.Database.Shard1": "[concat(variable('Sharding.Database.Prefix'), '1')]", "Sql.Database.Pools": "[concat(parameter('SqlDbPrefix'), '_Processing.Pools')]", "Sql.Database.MarketingAutomation": "[concat(parameter('SqlDbPrefix'), '_MarketingAutomation')]", "Sql.Database.Messaging": "[concat(parameter('SqlDbPrefix'), '_Messaging')]", "Sql.Database.Reference": "[concat(parameter('SqlDbPrefix'), '_ReferenceData')]", // The security certificate details "Security.CertificateStore": "Cert:\\Localmachine\\My", "Security.SSL.CertificateThumbprint": "[GetCertificateThumbprint(parameter('SSLCert'), variable('Security.CertificateStore'))]", "Security.XConnect.CertificateThumbprint": "[GetCertificateThumbprint(parameter('XConnectCert'), variable('Security.CertificateStore'))]", "Security.XConnect.CertificatePath": "[joinpath(variable('Security.CertificateStore'), variable('Security.XConnect.CertificateThumbprint'))]", // The sites full path on disk "Site.PhysicalPath": "[parameter('InstallDirectory')]", "Site.DataFolder": "[joinpath(variable('Site.PhysicalPath'), 'App_Data')]", // The path to the index worker windows service "Services.IndexWorker.InstallPath": "[joinpath(variable('Site.DataFolder'), 'jobs','continuous','IndexWorker')]", "Services.IndexWorker.Name": "[concat(parameter('SiteName'), '-IndexWorker')]", // The path to the automation engine windows service "Services.MarketingAutomationEngine.InstallPath": "[joinpath(variable('Site.DataFolder'), 'jobs','continuous','AutomationEngine')]", "Services.MarketingAutomationEngine.Name": "[concat(parameter('SiteName'), '-MarketingAutomationService')]", // The marketing automation endpoint. "Endpoint.MarketingAutomation": "[concat('https://', parameter('SiteName'))]", // The reference data endpoint. "Endpoint.ReferenceData": "[concat(variable('Endpoint.MarketingAutomation'), '/refdata')]", // The sharding tool details. "Sharding.Root.Path": "[joinpath(variable('Site.DataFolder'), 'collectiondeployment')]", "Sharding.Tool.Path": "[joinpath(variable('Sharding.Root.Path'), 'Sitecore.Xdb.Collection.Database.SqlShardingDeploymentTool.exe')]", "Sharding.DacPac.Path": "[joinpath(variable('Sharding.Root.Path'), 'Sitecore.Xdb.Collection.Database.Sql.dacpac')]", "Sharding.Map.Names": [ "ContactIdShardMap", "DeviceProfileIdShardMap", "ContactIdentifiersIndexShardMap" ], "Sharding.DB.Connection": "[sqlconnectionstring(parameter('SqlServer'), '', parameter('SqlAdminUser'), parameter('SqlAdminPassword'))]", "Sharding.Edition": "Basic", "Sharding.SqlCmd.Path.CreateShardApplicationDatabaseServerLogin": "[joinpath(variable('Sharding.Root.Path'), 'CreateShardApplicationDatabaseServerLogin.sql')]", "Sharding.SqlCmd.Path.CreateShardManagerApplicationDatabaseUser": "[joinpath(variable('Sharding.Root.Path'), 'CreateShardManagerApplicationDatabaseUser.sql')]", "Sharding.SqlCmd.Path.CreateShardApplicationDatabaseUser": "[joinpath(variable('Sharding.Root.Path'), 'CreateShardApplicationDatabaseUser.sql')]", // The solr configuration details. "Xdb.Name": "[concat(parameter('SolrCorePrefix'), '_xdb')]", "Xdb.Rebuild.Name": "[concat(variable('Xdb.Name'), '_rebuild')]", "Solr.Url.Xdb": "[concat(parameter('SolrUrl'), '/', variable('Xdb.Name'))]", // The content at this path is installed by the wdp "Solr.Config.Path": "[joinpath(variable('Site.DataFolder'), 'solrcommands', 'schema.json')]" }, "Tasks": { // Tasks are separate units of work in a configuration. // Each task is an action that will be completed when Install-SitecoreConfiguration is called. // By default, tasks are applied in the order they are declared. // Tasks may reference Parameters, Variables, and config functions. "CreatePaths": { // Ensure the destination path for the site exists. "Type": "EnsurePath", "Params": { "Exists": [ "[variable('Site.PhysicalPath')]" ] } }, "CreateAppPool": { // Creates or updates the app pool. "Type": "AppPool", "Params": { "Name": "[parameter('SiteName')]", "Properties": { "ProcessModel": { "identityType": "ApplicationPoolIdentity" } } } }, "SetAppPoolCertStorePermissions": { // Set permissions for the App Pool User to access the client certificate. "Type": "FilePermissions", "Params": { "Path": "[ResolveCertificatePath(variable('Security.XConnect.CertificatePath'))]", "Rights": [ { "User": "[concat('IIS AppPool\\', parameter('SiteName'))]", "FileSystemRights": [ "Read" ], "InheritanceFlags": [ "None" ] } ] } }, "CreateWebsite": { // Creates or updates the IIS website instance. "Type": "Website", "Params": { "Name": "[parameter('SiteName')]", "ApplicationPool": "[parameter('SiteName')]", "PhysicalPath": "[variable('Site.PhysicalPath')]" } }, "StopWebsite": { // Stops the website if it is running. "Type": "ManageWebsite", "Params": { "Name": "[parameter('SiteName')]", "Action": "Stop" } }, "StopAppPool": { // Stops the app pool if it is running. "Type": "ManageAppPool", "Params": { "Name": "[parameter('SiteName')]", "Action": "Stop" } }, "StopServices": { // Stops the services if they running. "Type": "ManageService", "Params": [ { "Name": "[variable('Services.IndexWorker.Name')]", "Status": "Stopped", "PostDelay": 3000 }, { "Name": "[variable('Services.MarketingAutomationEngine.Name')]", "Status": "Stopped", "PostDelay": 3000 } ] }, "RemoveServices": { // Removes the current service. "Type": "RemoveService", "Params": [ { "Name": "[variable('Services.IndexWorker.Name')]" }, { "Name": "[variable('Services.MarketingAutomationEngine.Name')]" } ] }, "RemoveDefaultBinding": { // Removes the default *:80 web binding "Type": "WebBinding", "Params": { "SiteName": "[parameter('SiteName')]", "Remove": [ { "Port": "80", "IPAddress": "*" } ] } }, "CreateBindingsWithThumprint": { // Configures the site bindings for the website. "Type": "WebBinding", "Params": { "SiteName": "[parameter('SiteName')]", "Add": [ { "HostHeader": "[parameter('SiteName')]", "Protocol": "https", "SSLFlags": 1, "Thumbprint": "[variable('Security.SSL.CertificateThumbprint')]" } ] }, "Skip": "[not(parameter('SSLCert'))]" }, "SetClientCertificatePermissions": { "Type": "WebsiteClientCert", "Params": { "SiteName": "[parameter('SiteName')]", "Setting": "Accept" } }, "SupportListManagerLargeUpload": { "Type": "IISConfiguration", "Params": { "SiteName": "[parameter('SiteName')]", "ConfigPath": "system.webServer/serverRuntime", "Key": "uploadReadAheadSize", "Value": 491520000 } }, "CreateHostHeader": { // Sets a hostheader for the website. "Type": "HostHeader", "Params": { "HostName": "[parameter('SiteName')]" } }, "SetPermissions": { // Sets permissions for the app pool user. "Type": "FilePermissions", "Params": { "Path": "[variable('Site.PhysicalPath')]", "Rights": [ { "User": "[concat('IIS AppPool\\', parameter('SiteName'))]", "FileSystemRights": "FullControl", "InheritanceFlags": [ "ContainerInherit", "ObjectInherit" ] } ] } }, "InstallWDP": { // Syncs the web deploy package with the website. "Type": "WebDeploy", "Params": { "Verb": "Sync", "Arguments": { "Source": { "Package": "[resolvepath(parameter('Package'))]" }, "Dest": "Auto", "SetParam": [ { "Name": "IIS Web Application Name", "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": "Collection Database Server Name", "Value": "[parameter('SqlServer')]" }, { "Name": "Collection Shard Map Manager Database Name", "Value": "[variable('Sql.Database.ShardMapManager')]" }, { "Name": "Collection Shard 0 Database Name", "Value": "[variable('Sql.Database.Shard0')]" }, { "Name": "Collection Shard 1 Database Name", "Value": "[variable('Sql.Database.Shard1')]" }, { "Name": "Processing Pools Database Name", "Value": "[variable('Sql.Database.Pools')]" }, { "Name": "Marketing Automation Database Name", "Value": "[variable('Sql.Database.MarketingAutomation')]" }, { "Name": "Messaging Database Name", "Value": "[variable('Sql.Database.Messaging')]" }, { "Name": "Reference Data Database Name", "Value": "[variable('Sql.Database.Reference')]" }, { "Name": "Search SOLR Core Application Connection String", "Value": "[variable('Solr.Url.Xdb')]" }, { "Name": "XConnect Server Configuration Environment", "Value": "[parameter('XConnectEnvironment')]" }, { "Name": "XConnect Server Certificate Validation Thumbprint", "Value": "[variable('Security.XConnect.CertificateThumbprint')]" }, { "Name": "XConnect Server Log Level", "Value": "[parameter('XConnectLogLevel')]" }, { "Name": "Marketing Automation Engine Xconnect Collection Client Endpoint", "Value": "[variable('Endpoint.MarketingAutomation')]" }, { "Name": "Marketing Automation Engine Xconnect Collection Client Certificate Thumbprint", "Value": "[variable('Security.XConnect.CertificateThumbprint')]" }, { "Name": "Marketing Automation Engine Xdb Reference Data Endpoint", "Value": "[variable('Endpoint.ReferenceData')]" }, { "Name": "Marketing Automation Engine Xdb Reference Data Client Certificate Thumbprint", "Value": "[variable('Security.XConnect.CertificateThumbprint')]" }, { "Name": "Collection Database Application User Name", "Value": "[parameter('SqlCollectionUser')]" }, { "Name": "Collection Database Application User Password", "Value": "[parameter('SqlCollectionPassword')]" }, { "Name": "Processing Pool Database Application User Name", "Value": "[parameter('SqlProcessingPoolsUser')]" }, { "Name": "Processing Pool Database Application User Password", "Value": "[parameter('SqlProcessingPoolsPassword')]" }, { "Name": "Reference Data Database Application User Name", "Value": "[parameter('SqlReferenceDataUser')]" }, { "Name": "Reference Data Database Application User Password", "Value": "[parameter('SqlReferenceDataPassword')]" }, { "Name": "Marketing Automation Database Application User Name", "Value": "[parameter('SqlMarketingAutomationUser')]" }, { "Name": "Marketing Automation Database Application User Password", "Value": "[parameter('SqlMarketingAutomationPassword')]" }, { "Name": "Messaging Database Application User Name", "Value": "[parameter('SqlMessagingUser')]" }, { "Name": "Messaging Database Application User Password", "Value": "[parameter('SqlMessagingPassword')]" } ] } } }, "SetLicense": { // Copies the license file to the instance data folder. "Type": "Copy", "Params": { "Source": "[resolvepath(parameter('LicenseFile'))]", "Destination": "[variable('Site.DataFolder')]" } }, "CreateBindingsWithDevelopmentThumprint": { // Creates a new thumprint with a custom CA "Type": "AddWebFeatureSSL", "Params": { "HostName": "[parameter('SiteName')]", "OutputDirectory": "[variable('Site.DataFolder')]" }, "Skip": "[parameter('SSLCert')]" }, "SetServicesCertStorePermissions": { // Set permissions for the services to access the client certificate. "Type": "FilePermissions", "Params": { "Path": "[ResolveCertificatePath(variable('Security.XConnect.CertificatePath'))]", "Rights": [ { "User": "NT AUTHORITY\\LocalService", "FileSystemRights": [ "Read" ], "InheritanceFlags": [ "None" ] } ] } }, "CleanShards": { // Drop existing shards. "Type": "Command", "Params": { "Path": "[variable('Sharding.Tool.Path')]", "Arguments": [ "/operation", "drop", "/connectionstring", "[variable('Sharding.DB.Connection')]", "/dbedition", "[variable('Sharding.Edition')]", "/shardMapManagerDatabaseName", "[variable('Sql.Database.ShardMapManager')]", "/shardMapNames", "[join(variable('Sharding.Map.Names'))]" ], "TaskName": "ShardingTool - Clean" } }, "CreateShards": { // Create new shards. "Type": "Command", "Params": { "Path": "[variable('Sharding.Tool.Path')]", "Arguments": [ "/operation", "create", "/connectionstring", "[variable('Sharding.DB.Connection')]", "/dbedition", "[variable('Sharding.Edition')]", "/shardMapManagerDatabaseName", "[variable('Sql.Database.ShardMapManager')]", "/shardMapNames", "[join(variable('Sharding.Map.Names'))]", "/shardnumber", 2, "/shardnameprefix", "[variable('Sharding.Database.Prefix')]", "/shardnamesuffix", "\"\"", "/dacpac", "[variable('Sharding.DacPac.Path')]" ], "TaskName": "ShardingTool - Create" } }, "CreateShardApplicationDatabaseServerLoginSqlCmd": { // Create Collection Shard Database Server Login "Type": "Command", "Params": { "Path": "sqlcmd", "Arguments": [ "-i", "[variable('Sharding.SqlCmd.Path.CreateShardApplicationDatabaseServerLogin')]", "-S", "[parameter('SqlServer')]", "-U", "[parameter('SqlAdminUser')]", "-P", "[parameter('SqlAdminPassword')]", "-v", "[concat('UserName=',parameter('SqlCollectionUser'))]", "-v", "[concat('Password=',parameter('SqlCollectionPassword'))]" ] } }, "CreateShardManagerApplicationDatabaseUserSqlCmd": { // Create Collection Shard Manager Database User "Type": "Command", "Params": { "Path": "sqlcmd", "Arguments": [ "-i", "[variable('Sharding.SqlCmd.Path.CreateShardManagerApplicationDatabaseUser')]", "-S", "[parameter('SqlServer')]", "-U", "[parameter('SqlAdminUser')]", "-P", "[parameter('SqlAdminPassword')]", "-v", "[concat('UserName=',parameter('SqlCollectionUser'))]", "-v", "[concat('ShardMapManagerDatabaseName=',variable('Sql.Database.ShardMapManager'))]" ] } }, "CreateShard0ApplicationDatabaseUserSqlCmd": { // Create Collection Shard 0 Database User "Type": "Command", "Params": { "Path": "sqlcmd", "Arguments": [ "-i", "[variable('Sharding.SqlCmd.Path.CreateShardApplicationDatabaseUser')]", "-S", "[parameter('SqlServer')]", "-U", "[parameter('SqlAdminUser')]", "-P", "[parameter('SqlAdminPassword')]", "-v", "[concat('UserName=',parameter('SqlCollectionUser'))]", "-v", "[concat('ShardDatabaseName=',variable('Sql.Database.Shard0'))]" ] } }, "CreateShard1ApplicationDatabaseUserSqlCmd": { // Create Collection Shard 1 Database User "Type": "Command", "Params": { "Path": "sqlcmd", "Arguments": [ "-i", "[variable('Sharding.SqlCmd.Path.CreateShardApplicationDatabaseUser')]", "-S", "[parameter('SqlServer')]", "-U", "[parameter('SqlAdminUser')]", "-P", "[parameter('SqlAdminPassword')]", "-v", "[concat('UserName=',parameter('SqlCollectionUser'))]", "-v", "[concat('ShardDatabaseName=',variable('Sql.Database.Shard1'))]" ] } }, "CreateServicesLogPaths": { // Ensure the destination path for the site exists. "Type": "EnsurePath", "Params": { "Exists": [ "[joinpath(variable('Services.IndexWorker.InstallPath'), 'App_Data', 'Logs')]", "[joinpath(variable('Services.MarketingAutomationEngine.InstallPath'), 'App_Data', 'Logs')]" ] } }, "SetIndexWorkerServiceLicense": { // Copies the license file to the index worker service data folder. "Type": "Copy", "Params": { "Source": "[resolvepath(parameter('LicenseFile'))]", "Destination": "[joinpath(variable('Services.IndexWorker.InstallPath'), 'App_Data')]" } }, "SetMarketingAutomationServiceLicense": { // Copies the license file to the marketing automation service data folder. "Type": "Copy", "Params": { "Source": "[resolvepath(parameter('LicenseFile'))]", "Destination": "[joinpath(variable('Services.MarketingAutomationEngine.InstallPath'), 'App_Data')]" } }, "SetIndexWorkerServicePermissions": { // Set permissions for the Index Worker service. "Type": "FilePermissions", "Params": { "Path": "[joinpath(variable('Services.IndexWorker.InstallPath'), 'App_Data', 'Logs')]", "Rights": [ { "User": "NT AUTHORITY\\LocalService", "FileSystemRights": [ "FullControl" ], "InheritanceFlags": [ "ContainerInherit", "ObjectInherit" ] } ] } }, "SetMarketingAutomationServicePermissions": { // Set permissions for the Marketing Automation service. "Type": "FilePermissions", "Params": { "Path": "[joinpath(variable('Services.MarketingAutomationEngine.InstallPath'), 'App_Data', 'Logs')]", "Rights": [ { "User": "NT AUTHORITY\\LocalService", "FileSystemRights": [ "FullControl" ], "InheritanceFlags": [ "ContainerInherit", "ObjectInherit" ] } ] } }, "InstallServices": { // Installs the service. "Type": "Command", "Params": [ { "Path": "[joinpath(variable('Services.IndexWorker.InstallPath'), 'XConnectSearchIndexer.exe')]", "Arguments": [ "-i", "[variable('Services.IndexWorker.Name')]" ] }, { "Path": "[joinpath(variable('Services.MarketingAutomationEngine.InstallPath'), 'maengine.exe')]", "Arguments": [ "-i", "[variable('Services.MarketingAutomationEngine.Name')]" ] } ] }, "StartServices": { // Starts the service. "Type": "ManageService", "Params": [ { "Name": "[variable('Services.IndexWorker.Name')]", "Status": "Running" }, { "Name": "[variable('Services.MarketingAutomationEngine.Name')]", "Status": "Running" } ] }, "StartAppPool": { // Starts the app pool. "Type": "ManageAppPool", "Params": { "Name": "[parameter('SiteName')]", "Action": "Start" } }, "StartWebsite": { // Starts the website. "Type": "ManageWebsite", "Params": { "Name": "[parameter('SiteName')]", "Action": "Start" } }, "ConfigureSolrSchemas": { // Applies schema to the new cores. "Type": "ManageSolrSchema", "Params": [ { "Address": "[parameter('SolrUrl')]", "Core": "[variable('Xdb.Name')]", "ArgumentsFile": "[variable('Solr.Config.Path')]" }, { "Address": "[parameter('SolrUrl')]", "Core": "[variable('Xdb.Rebuild.Name')]", "ArgumentsFile": "[variable('Solr.Config.Path')]" } ] } } } |