Skip to content

Latest commit

 

History

History
108 lines (92 loc) · 6.33 KB

UseCase-BreakUpSpace.md

File metadata and controls

108 lines (92 loc) · 6.33 KB
Raw

Use Case: breaking up the default space

The next logical question was, how do I break up my massive default space into separate project spaces once spaces came around? The space cloner was designed with that use case in mind. However, it wasn't designed to determine all project dependencies (environments, variable sets, lifecycles, etc.).

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

Gotchas

The process does not attempt to walk a tree of dependencies. It loads up all the necessary data from the source and destination. When it comes across an ID in the source space, it will attempt to find the corresponding ID in the destination space using the name. If it cannot find a matching name, it removes that binding.

If that binding on a specific object is required, the script will fail.

Let's use environment scoping as an example. In my source space, I have a variable set called Global. That variable set has an environment scoped to environments.

In my destination space, I only have three of those four environments, Test, Staging, and Production. As a result, the cloned variable set still has the Development value, but it doesn't have a scope associated with it.

Example - CloneSpace.ps1

This example will clone a project from one space (along with its dependencies) to another in the same instance. It includes only dependencies the project cares about.

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

  • OverwriteExistingVariables - set to false to keep the differences preserved. Any new variable found will be added still.
  • OverwriteExistingCustomStepTemplates - Set to false so the step templates are not updated.
  • OverwriteExistingLifecyclesPhases - Set to false as the two spaces will have different phases.
  • 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.
  • CloneProjectLogos - set to true as you'll want to copy over the project logo.
CloneSpace.ps1 -SourceOctopusUrl "https://samples.octopus.app" `
    -SourceOctopusApiKey "SOME KEY" `
    -SourceSpaceName "Target - SQL Server" `
    -DestinationOctopusUrl "https://samples.octopus.app" `
    -DestinationOctopusApiKey "My Key" `
    -DestinationSpaceName "Redgate Space" `
    -EnvironmentsToClone "test,staging,production" `
    -WorkerPoolsToClone "AWS*" `
    -ProjectGroupsToClone "all" `
    -TenantTagsToClone "all" `
    -ExternalFeedsToClone "all" `
    -StepTemplatesToClone "all" `
    -ScriptModulesToClone "all" `
    -InfrastructureAccountsToClone "AWS*" `
    -LibraryVariableSetsToClone "AWS*,Global,Notification,SQL Server" `
    -LifeCyclesToClone "AWS*" `
    -ProjectsToClone "Redgate - Feature Branch Example" `
    -TenantsToClone "all" `
    -WorkersToCLone "AWS*" `
    -TargetsToClone "AWS*" `
    -MachinePoliciesToClone "all" `
    -SpaceTeamsToClone "all" `
    -PackagesToClone "Redgate.*" `
    -CertificatesToClone "MyCert::CertPassword,OtherCertName::OtherCertPassword" `
    -OverwriteExistingVariables "false" `
    -OverwriteExistingCustomStepTemplates "false" `
    -OverwriteExistingLifecyclesPhases "false" `
    -CloneProjectChannelRules "true" `
    -CloneTeamUserRoleScoping "true" `
    -CloneProjectVersioningReleaseCreationSettings "true" `
    -CloneProjectRunbooks "true" `
    -CloneProjectDeploymentProcess "true" `
    -CloneProjectLogos "true"

Example - CloneSpaceProject.ps1

This example will clone a project from one space (along with its dependencies) to another in the same instance. It includes only dependencies the project cares about.

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

  • OverwriteExistingVariables - set to false to keep the differences preserved. Any new variable found will be added still.
  • OverwriteExistingCustomStepTemplates - Set to false so the step templates are not updated.
  • OverwriteExistingLifecyclesPhases - Set to false as the two spaces will have different phases.
  • 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.
  • 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 "false" `
    -OverwriteExistingCustomStepTemplates "false" `
    -OverwriteExistingLifecyclesPhases "false" `
    -CloneProjectChannelRules "true" `
    -CloneTeamUserRoleScoping "true" `
    -CloneProjectVersioningReleaseCreationSettings "true" `
    -CloneProjectRunbooks "true" `
    -CloneProjectDeploymentProcess "true" `
    -CloneProjectLogos "true"