Skip to content

UseCase-CopyToTestInstance.md

Latest commit

 

History

History
104 lines (92 loc) · 6.06 KB

UseCase-CopyToTestInstance.md

File metadata and controls

104 lines (92 loc) · 6.06 KB
Raw

Use Case: copying to and from test instance

Many customers like to stand up a test instance to verify upgrades. They want a set of projects that mimic the common deployment processes as their production instance.

This use case is supported in with the Space Cloner script.

Please refer to the how it works page to get a full list of items cloned and not cloned.

Example - CloneSpace.ps1

In this use case, you probably want to copy everything, but only include a handful of projects. The example script below will copy everything in a space plus a set of specific projects. It will only copy targets and workers related to the projects you wish to clone.

Please refer to the Parameter reference page for more details on the parameters.

The other options are:

  • OverwriteExistingVariables - set to True, so variables are always overwritten (except for sensitive variables).
  • OverwriteExistingCustomStepTemplates - Set to True so the step templates are kept in sync. You might have made some recent changes to the step template. It is important to keep them up to date.
  • OverwriteExistingLifecyclesPhases - Set to True since this is a full clone the overwrite existing lifecycle phases has been set to true as well.
  • CloneProjectChannelRules - set to true as you'll want to include the channel rules with the project.
  • CloneTeamUserRoleScoping - set to true as you'll want to include all the scoped permissions with the teams.
  • CloneProjectVersioningReleaseCreationSettings - set to true as you'll want to include the release creation settings.
  • CloneProjectDeploymentProcess - set to true as you'll want to include the project deployment process.
  • CloneProjectRunbooks - set to true as you'll want to include the project runbooks.
  • CloneTenantVariables - set to true as you'll want to include the tenant variables.
  • CloneProjectLogos - set to true as you'll want to copy over the project logo.
CloneSpace.ps1 -SourceOctopusUrl "https://instance1.yoursite.com" `
    -SourceOctopusApiKey "SOME KEY" `
    -SourceSpaceName "My Space Name" `
    -DestinationOctopusUrl "https://instance2.yoursite.com" `
    -DestinationOctopusApiKey "My Key" `
    -DestinationSpaceName "My Space Name" `
    -EnvironmentsToClone "all" `
    -WorkerPoolsToClone "all" `
    -ProjectGroupsToClone "all" `
    -TenantTagsToClone "all" `
    -ExternalFeedsToClone "all" `
    -StepTemplatesToClone "all" `
    -ScriptModulesToClone "all" `
    -InfrastructureAccountsToClone "all" `
    -LibraryVariableSetsToClone "all" `
    -LifeCyclesToClone "all" `
    -ProjectsToClone "Redgate - Feature Branch Example,DBUp SQL Server" `
    -TenantsToClone "all" `
    -WorkersToCLone "AWS*" `
    -TargetsToClone "AWS*" `
    -MachinePoliciesToClone "all" `
    -SpaceTeamsToClone "all" `
    -PackagesToClone "Redgate.*,DBUp.*" `
    -CertificatesToClone "MyCert::CertPassword,OtherCertName::OtherCertPassword" `
    -OverwriteExistingVariables "true" `
    -OverwriteExistingCustomStepTemplates "true" `
    -OverwriteExistingLifecyclesPhases "true" `
    -CloneProjectChannelRules "true" `
    -CloneTeamUserRoleScoping "true" `
    -CloneProjectVersioningReleaseCreationSettings "true" `
    -CloneProjectRunbooks "true" `
    -CloneTenantVariables "true" `
    -CloneProjectDeploymentProcess "true" `
    -CloneProjectLogos "true"

Example - CloneSpaceProject.ps1

In this use case, you probably want to copy everything, but only include a handful of projects. The example script below will copy everything in a space plus a set of specific projects. It will only copy targets and workers related to the projects you wish to clone.

Please refer to the Parameter reference page for more details on the parameters.

The other options are:

  • OverwriteExistingVariables - set to True, so variables are always overwritten (except for sensitive variables).
  • OverwriteExistingCustomStepTemplates - Set to True so the step templates are kept in sync. You might have made some recent changes to the step template. It is important to keep them up to date.
  • OverwriteExistingLifecyclesPhases - Set to True since this is a full clone the overwrite existing lifecycle phases has been set to true as well.
  • CloneProjectChannelRules - set to true as you'll want to include the channel rules with the project.
  • CloneTeamUserRoleScoping - set to true as you'll want to include all the scoped permissions with the teams.
  • CloneProjectVersioningReleaseCreationSettings - set to true as you'll want to include the release creation settings.
  • CloneProjectDeploymentProcess - set to true as you'll want to include the project deployment process.
  • CloneProjectRunbooks - set to true as you'll want to include the project runbooks.
  • CloneTenantVariables - set to true as you'll want to include the tenant variables.
  • CloneProjectLogos - set to true as you'll want to copy over the project logo.
CloneSpaceProject.ps1 -SourceOctopusUrl "https://samples.octopus.app" `
    -SourceOctopusApiKey "SOME KEY" `
    -SourceSpaceName "Target - SQL Server" `
    -DestinationOctopusUrl "https://samples.octopus.app" `
    -DestinationOctopusApiKey "My Key" `
    -DestinationSpaceName "Redgate Space" `
    -ProjectsToClone "Redgate - Feature Branch Example" `
    -CertificatesToClone "MyCert::CertPassword,OtherCertName::OtherCertPassword" `
    -EnvironmentsToExclude $null `
    -WorkersToExclude $null `
    -TargetsToExclude $null `
    -TenantsToExclude $null `
    -OverwriteExistingVariables "true" `
    -OverwriteExistingCustomStepTemplates "true" `
    -OverwriteExistingLifecyclesPhases "true" `
    -CloneProjectChannelRules "true" `
    -CloneTeamUserRoleScoping "true" `
    -CloneProjectVersioningReleaseCreationSettings "true" `
    -CloneProjectRunbooks "true" `
    -CloneTenantVariables "true" `
    -CloneProjectDeploymentProcess "true" `
    -CloneProjectLogos "true"