Skip to content

Latest commit

 

History

History
119 lines (103 loc) · 7.04 KB

UseCase-ParentChildProjects.md

File metadata and controls

119 lines (103 loc) · 7.04 KB
Raw

Use Case: parent-child projects

It is easy to clone a project in Octopus Deploy. However, once that is done, keeping the child project's process in sync with the parent project is very painful. You have to go into each child project and update it manually. The space cloner script was designed with this use case in mind.

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

Example - Parent / Child Projects Different Space

This example is syncing the parent project in the same space.

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

Options:

  • OverwriteExistingVariables - set to false to keep the differences preserved. Any new variable found will be added.
  • OverwriteExistingCustomStepTemplates - Set to true as you'll want to make sure you have the latest step templates.
  • OverwriteExistingLifecyclesPhases - Set to false because you've most likely have a unique lifecycle.
  • CloneProjectChannelRules - set to false as the project already exists with its own rules.
  • CloneProjectVersioningReleaseCreationSettings - set to false as you'll want to exclude 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.
CloneSpace.ps1 -SourceOctopusUrl "https://instance1.yoursite.com" `
    -SourceOctopusApiKey "SOME KEY" `
    -SourceSpaceName "My Space Name" `
    -DestinationOctopusUrl "https://instance1.yoursite.com" `
    -DestinationOctopusApiKey "My Key" `
    -DestinationSpaceName "New Space Name" `
    -ParentProjectName "Redgate - Feature Branch Example" `
    -ChildProjectsToSync "Redgate - Child*" `
    -OverwriteExistingVariables "false" `
    -OverwriteExistingCustomStepTemplates "true" `
    -OverwriteExistingLifecyclesPhases "false" `
    -CloneProjectChannelRules "false" `    
    -CloneProjectVersioningReleaseCreationSettings "false" `
    -CloneProjectRunbooks "true" `
    -CloneProjectDeploymentProcess "true"

Example - Parent / Child Projects Same Space

This example is syncing the parent project in the same space.

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

Options:

  • OverwriteExistingVariables - set to false to keep the differences preserved. Any new variable found will be added still.
  • CloneProjectChannelRules - set to false as its the same space in the same instance, and this makes no sense to rune.
  • CloneProjectVersioningReleaseCreationSettings - set to false as you'll want to exclude 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.
CloneSpace.ps1 -SourceOctopusUrl "https://instance1.yoursite.com" `
    -SourceOctopusApiKey "SOME KEY" `
    -SourceSpaceName "My Space Name" `
    -ParentProjectName "Redgate - Feature Branch Example" `
    -ChildProjectsToSync "Redgate - Child*" `  
    -OverwriteExistingVariables "false" `
    -CloneProjectChannelRules "false" `
    -CloneProjectVersioningReleaseCreationSettings "false" `
    -CloneProjectRunbooks "true" `
    -CloneProjectDeploymentProcess "true"

Example - Clone a runbook between projects in the same space

This example is syncing the parent project in the same space.

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

Options:

  • OverwriteExistingVariables - set to false to keep the differences preserved. Any new variable found will be added.
  • CloneProjectChannelRules - set to false as you are not cloning the deployment process.
  • CloneProjectVersioningReleaseCreationSettings - set to false as you are not cloning the deployment process.
  • CloneProjectDeploymentProcess - set to false as you are not cloning the deployment process.
  • CloneProjectLogos - set to false as you only want the runbook(s).
  • CloneProjectRunbooks - set to true as you want to clone runbooks.
  • ProcessCloningOption - set to KeepAdditionalDestinationSteps in the event you are cloning to an existing runbook
  • ProcessEnvironmentScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • ProcessChannelScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • ProcessTenantTagsScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • VariableChannelScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • VariableEnvironmentScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • VariableProcessOwnerScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • VariableActionScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • VariableMachineScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • VariableTenantTagsScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • VariableAccountScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
  • VariableCertificateScopingMatch - set to SkipUnlessPartialMatch as you are cloning in the same space.
CloneSpace.ps1 -SourceOctopusUrl "https://instance1.yoursite.com" `
    -SourceOctopusApiKey "SOME KEY" `
    -SourceSpaceName "My Space Name" `
    -DestinationOctopusUrl "https://instance1.yoursite.com" `
    -DestinationOctopusApiKey "My Key" `
    -DestinationSpaceName "New Space Name" `
    -ParentProjectName "Redgate - Feature Branch Example" `
    -ChildProjectsToSync "Redgate - Child*" `
    -RunbooksToClone "YOUR RUNBOOK NAME" `
    -OverwriteExistingVariables "false" `
    -CloneProjectChannelRules "false" `
    -CloneProjectVersioningReleaseCreationSettings "false" `
    -CloneProjectDeploymentProcess "false" `
    -CloneProjectLogos "false" `
    -CloneProjectRunbooks "true" `
    -ProcessCloningOption "KeepAdditionalDestinationSteps" `
    -ProcessEnvironmentScopingMatch "SkipUnlessPartialMatch" `
    -ProcessChannelScopingMatch "SkipUnlessPartialMatch" `
    -ProcessTenantTagsScopingMatch "SkipUnlessPartialMatch" `
    -VariableChannelScopingMatch "SkipUnlessPartialMatch" `
    -VariableEnvironmentScopingMatch "SkipUnlessPartialMatch" `
    -VariableProcessOwnerScopingMatch "SkipUnlessPartialMatch" `
    -VariableActionScopingMatch "SkipUnlessPartialMatch" `
    -VariableMachineScopingMatch "SkipUnlessPartialMatch" `
    -VariableTenantTagsScopingMatch "SkipUnlessPartialMatch" `
    -VariableAccountScopingMatch "SkipUnlessPartialMatch" `
    -VariableCertificateScopingMatch "SkipUnlessPartialMatch"