diff --git a/.vscode/extensions.json b/.vscode/extensions.json index b47edf7593..5bf8d295e7 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -3,9 +3,11 @@ "astro-build.astro-vscode", "esbenp.prettier-vscode", "yzhang.markdown-all-in-one", + "docsmsft.docs-markdown", "ms-playwright.playwright", "streetsidesoftware.code-spell-checker", - "unifiedjs.vscode-mdx" + "unifiedjs.vscode-mdx", + "DavidAnson.vscode-markdownlint" ], "unwantedRecommendations": [] } \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index b6183d5798..83be52780a 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,4 +5,10 @@ }, "[markdown]": { }, + "markdownlint.run": "onSave", + "markdownlint.config": { + "emphasis": { "style": "asterisk" }, + "no-inline-html": false, + "ul-style": { "style": "dash" } + }, } \ No newline at end of file diff --git a/README.md b/README.md index df53d5d4b8..6b50875607 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ +# Octopus docs + This repository contains the documentation for [Octopus Deploy](https://octopus.com/docs). Contributions to help improve this documentation are welcome, however, you must sign the [Contribution License Agreement (CLA)](https://cla-assistant.io/OctopusDeploy/docs) before we can accept your contribution. See the [Octopus style guide](https://www.octopus.design/932c0f1a9/p/26f741-writing) for information including: -* [Markdown quick reference](https://www.octopus.design/932c0f1a9/p/074e30-markdown-reference) -* [Capitalization](https://www.octopus.design/932c0f1a9/p/457bc4-grammar-rules/t/03e016) -* [Working with images](https://www.octopus.design/932c0f1a9/p/5061d7-working-with-images) +- [Markdown quick reference](https://www.octopus.design/932c0f1a9/p/074e30-markdown-reference) +- [Capitalization](https://www.octopus.design/932c0f1a9/p/457bc4-grammar-rules/t/03e016) +- [Working with images](https://www.octopus.design/932c0f1a9/p/5061d7-working-with-images) ## How to contribute a change to the docs -* The `main` branch has the latest version of the docs -* Fork this repo and create a branch for your changes -* Make the changes you'd like to contribute -* Submit a pull request (PR) to master with your changes and include a comment explaining the changes -* Sign the [Contribution License Agreement (CLA)](https://cla-assistant.io/OctopusDeploy/docs) -* We'll review your PR and accept it or suggest changes +- The `main` branch has the latest version of the docs +- Fork this repo and create a branch for your changes +- Make the changes you'd like to contribute +- Submit a pull request (PR) to master with your changes and include a comment explaining the changes +- Sign the [Contribution License Agreement (CLA)](https://cla-assistant.io/OctopusDeploy/docs) +- We'll review your PR and accept it or suggest changes ### Default values @@ -39,7 +41,7 @@ When you raise a pull request, the following checks will take place: You can run the tests locally using: -``` +```bash pnpm test ``` @@ -52,7 +54,7 @@ The most common failures are: You can run the spell check locally using: -``` +```bash pnpm spellcheck ``` @@ -103,13 +105,13 @@ You can use the Front Matter dashboard to find content, media, and snippets - or The pages are in the exact page shown on the website, so you can easily translate them. For example: -``` +```bash https://octopus.com/docs/infrastructure/deployment-targets/tentacle ``` Can be found in the exact same path within `src/pages/` -``` +```bash \docs\src\pages\docs\infrastructure\deployment-targets\tentacle ``` @@ -123,17 +125,17 @@ No page should ever be deleted! When a page moves or is retired, it should be ch The below shows the complete contents of a redirect page that sends users from: -``` +```bash /docs/administration/authentication/authentication-providers/azure-ad-authentication ``` To the new location: -``` +```bash /docs/security/authentication/azure-ad-authentication ``` -``` +```yaml --- layout: src/layouts/Redirect.astro title: Redirect @@ -195,13 +197,15 @@ Within an MDX file, this looks like a code block and will error. Escape the stat ## Switching between spaces \{#switching-between-spaces} ``` +MDX files don't allow short-form links, instead of using `` use `[https://example.com](https://example.com)`, or even better - put in useful link text, like `[example website](https://example.com)`. + ## Docs page layout guidelines ### Title icons If you are updating a page in Docs which doesn't already have a title icon, please add one. Title icons can be added in the frontmatter for each page by adding a Font Awesome class in the `icon` entry: -``` +```yaml --- layout: src/layouts/Default.astro pubDate: 2023-01-01 @@ -221,7 +225,7 @@ hideInThisSectionHeader: true Product screenshots used in Docs should reflect the UI in the latest version of Octopus. The `figure` component will automatically add a curved border and outline to your image: -``` +```markdown :::figure ![](/docs/octopus-cloud/images/octopus-cloud-architecture-diagram.png) ::: @@ -233,6 +237,6 @@ Images should be uploaded to the folder that relates to the position of the page Do not use call out / info boxes in the main body of docs pages to reference how features worked in earlier versions of Octopus. This information should be moved to the bottom of docs pages under an 'Older versions' heading. For example, you might add a note like this under the 'Older versions' heading: -``` +```markdown In versions earlier than 2024.x, you'll find the page to add a feed under the Projects menu -> Tenant Variables ``` diff --git a/cspell.json b/cspell.json index 36757ebe95..3909ddf083 100644 --- a/cspell.json +++ b/cspell.json @@ -18,6 +18,7 @@ "pnpm-lock.yaml", "docs/credits.md", ".octopus/**", + ".vscode/**", ".github/**", "src/pages/report/**", "public/docs/js/**", diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt index e6ba846986..192a5fb0b5 100644 --- a/dictionary-octopus.txt +++ b/dictionary-octopus.txt @@ -107,6 +107,7 @@ emptytitle entra environmentids eprintfn +esac expressjs externalgroups externalusers @@ -392,6 +393,7 @@ SSPI SSRS statefulset statefulsets +stepsprodpackages.blob.core.windows.net sthumb strconv struct @@ -417,6 +419,7 @@ tfvar tfvars TFVC thepassword +timespan tlsv1 tmpfs Toolsets diff --git a/public/docs/deployments/kubernetes/object-status/helm-step-verification.png b/public/docs/deployments/kubernetes/object-status/helm-step-verification.png new file mode 100644 index 0000000000..89829eb4ac Binary files /dev/null and b/public/docs/deployments/kubernetes/object-status/helm-step-verification.png differ diff --git a/public/docs/infrastructure/deployment-targets/azure/web-app-targets/create-azure-web-app-target.png b/public/docs/infrastructure/deployment-targets/azure/web-app-targets/create-azure-web-app-target.png index ba40ee07f3..9ec27ad9b4 100644 Binary files a/public/docs/infrastructure/deployment-targets/azure/web-app-targets/create-azure-web-app-target.png and b/public/docs/infrastructure/deployment-targets/azure/web-app-targets/create-azure-web-app-target.png differ diff --git a/public/docs/infrastructure/deployment-targets/azure/web-app-targets/deployment-targets-web-app-healthy.png b/public/docs/infrastructure/deployment-targets/azure/web-app-targets/deployment-targets-web-app-healthy.png index a32d3f7515..db48a7cdaf 100644 Binary files a/public/docs/infrastructure/deployment-targets/azure/web-app-targets/deployment-targets-web-app-healthy.png and b/public/docs/infrastructure/deployment-targets/azure/web-app-targets/deployment-targets-web-app-healthy.png differ diff --git a/src/pages/docs/administration/migrate-spaces-with-octoterra/index.md b/src/pages/docs/administration/migrate-spaces-with-octoterra/index.md index 7abed34eb1..01957ed632 100644 --- a/src/pages/docs/administration/migrate-spaces-with-octoterra/index.md +++ b/src/pages/docs/administration/migrate-spaces-with-octoterra/index.md @@ -91,7 +91,7 @@ These are the prerequisites for migrating an Octopus space with the Octoterra Wi * [Backup](https://octopus.com/docs/administration/data/backup-and-restore) and [update](https://octopus.com/docs/administration/upgrading) your Octopus instance. * [Backup](https://octopus.com/docs/administration/data/backup-and-restore) your Octopus instance again before the migration. -* Download the Octoterra Wizard from [GitHub](https://github.com/mcasperson/OctoterraWizard). +* Download the Octoterra Wizard from [GitHub](https://github.com/OctopusSolutionsEngineering/OctoterraWizard). * Install [Terraform](https://developer.hashicorp.com/terraform/install) on your local workstation. * [Create an API key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key) for the source Octopus instance. * [Create an API key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key) for the destination Octopus instance. @@ -112,7 +112,7 @@ The final prompts do not involve any input. They automate the process of install Each sensitive variable must have a unique name and no scopes in order for Octopus to expose sensitive variables defined in the project and in library variable sets to the Terraform module created by Octoterra. -However, it is common for sensitive variables to share a name use scopes to define unique values for different contexts. For example, you may have two sensitive variables called `Database.Password`, with the first variable scoped to the `Dev` environment, and the second scoped to the `Production` environment. This is demonstrated in the screenshot below: +However, it is common for sensitive variables to share a name and use scopes to define unique values for different contexts. For example, you may have two sensitive variables called `Database.Password`, with the first variable scoped to the `Dev` environment, and the second scoped to the `Production` environment. This is demonstrated in the screenshot below: ![Sensitive project variables](/docs/administration/migrate-spaces-with-octoterra/sensitive-variables.png) @@ -255,12 +255,12 @@ The first approach is to apply these changes in multiple steps: The second approach is to delete any projects on the destination server and recreate them with the new settings: 1. On the source server, create the new space level resources and update projects to point to them. -2. One the destination server, delete any projects that were modified on the source server. +2. On the destination server, delete any projects that were modified on the source server. 3. At this point no projects on either the source or destination server refer to the old space level resources. 4. Deploy both the space and project level changes to the destination server. :::div{.hint} -Projects are configured to ignore changes to the `project_group_id` and `name` with the following [lifecycle meta-argument](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle: +Projects are configured to ignore changes to the `project_group_id` and `name` with the following [lifecycle meta-argument](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle): ``` lifecycle { diff --git a/src/pages/docs/best-practices/deployments/variables.md b/src/pages/docs/best-practices/deployments/variables.md index dea1de75ab..4b3cef17cc 100644 --- a/src/pages/docs/best-practices/deployments/variables.md +++ b/src/pages/docs/best-practices/deployments/variables.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-10-04 +modDate: 2023-11-18 title: Variable Recommendations description: Guidelines and recommendations for configuring variables in Octopus Deploy. navOrder: 60 @@ -74,8 +74,6 @@ For configurations that differ per environment, our recommendation is to use a c Octopus Deploy can set an environment variable or configuration value during deployment to indicate which environment-specific configuration file to use. Or, if you are using .NET Framework, you can leverage [configuration file transforms](/docs/projects/steps/configuration-features/configuration-transforms). -For other items, - ## Variable Sets [Variable Sets](/docs/projects/variables/library-variable-sets) are a great way to share variables between projects. We recommend the following when creating variable sets. diff --git a/src/pages/docs/deployments/azure/cloud-services/getting-started-with-azure-cloud-services.md b/src/pages/docs/deployments/azure/cloud-services/getting-started-with-azure-cloud-services.md index c3e70aef17..0de26c0c72 100644 --- a/src/pages/docs/deployments/azure/cloud-services/getting-started-with-azure-cloud-services.md +++ b/src/pages/docs/deployments/azure/cloud-services/getting-started-with-azure-cloud-services.md @@ -1,9 +1,9 @@ --- layout: src/layouts/Redirect.astro title: Redirect -redirect: https://octopus.com/docs/deployments/azure/cloud-services +redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure pubDate: 2023-01-01 navSearch: false navSitemap: false navMenu: false ---- +--- \ No newline at end of file diff --git a/src/pages/docs/deployments/azure/cloud-services/index.md b/src/pages/docs/deployments/azure/cloud-services/index.md new file mode 100644 index 0000000000..1ec753541e --- /dev/null +++ b/src/pages/docs/deployments/azure/cloud-services/index.md @@ -0,0 +1,10 @@ +--- +layout: src/layouts/Redirect.astro +title: Redirect +redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure +pubDate: 2023-01-01 +navSearch: false +navSitemap: false +navMenu: false +hideInThisSectionHeader: true +--- \ No newline at end of file diff --git a/src/pages/docs/deployments/azure/cloud-services/index.mdx b/src/pages/docs/deployments/azure/cloud-services/index.mdx deleted file mode 100644 index 343b0f7b74..0000000000 --- a/src/pages/docs/deployments/azure/cloud-services/index.mdx +++ /dev/null @@ -1,188 +0,0 @@ ---- -layout: src/layouts/Default.astro -pubDate: 2023-01-01 -modDate: 2023-01-01 -title: Azure Cloud Services -description: Octopus Deploy can help you perform repeatable and controlled deployments to Azure Cloud Services. -hideInThisSectionHeader: true ---- -import AzureCloudServicesDeprecated from 'src/shared-content/deprecated-items/azure-cloud-services-deprecated.include.md'; - - - -Octopus Deploy supports deployment of [Azure Cloud Services](http://azure.microsoft.com/en-us/services/cloud-services/). This page will walk you through, step by step, setting up a deployment using the Octopus built-in **Deploy an Azure Cloud Service** step. - -## Step 1: Packaging - -An Azure cloud service package is normally compiled into a `.cspkg` file. This file will need to be [re-packed into a supported package](/docs/packaging-applications) for Octopus to consume. The easiest way to do this currently is to either create a simple zip file or use the [NuGet.exe command line tool](https://docs.microsoft.com/en-us/nuget/tools/nuget-exe-cli-reference). For example, the resulting NuGet package will look like this: - -:::figure -![](/docs/deployments/azure/cloud-services/3278363.png "width=500") -::: - -### Upload to a NuGet feed - -In order to make the NuGet package accessible to Octopus it needs to be uploaded to a [package repository](/docs/packaging-applications/package-repositories). The built-in Octopus package repository is accessible from **Library ➜ Packages** and is a suitable place to upload your Cloud Service NuGet package: - -:::figure -![Package feed](/docs/deployments/azure/cloud-services/package-feed.png "width=500") -::: - -## Step 2: Create an Azure account - -If you haven't already, create an [Azure Management Certificate Account](/docs/infrastructure/accounts/azure) to grant Octopus Deploy access to your Azure Subscription. - -## Step 3: Create the Azure Cloud Service deployment step - -Add a new Azure Cloud Service Deployment Step to your project. For information about adding a step to the deployment process, see the [add step](/docs/projects/steps) section. - -:::figure -![](/docs/deployments/azure/cloud-services/5865904.png "width=170") -::: - -## Step 4: Configure your Azure Cloud Service step - -Once an Account is selected, the list of Cloud Services and Storage Accounts available to the Azure subscription associated with the chosen Account will be populated for you to choose from. - -| Setting | Default | Description | -| --------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Account | | The [Azure Account](/docs/infrastructure/accounts/azure/) you want to target when deploying this cloud service. Select one from the list, or use a [variable binding](/docs/projects/variables/variable-substitutions) to select an account by its name or ID. | -| Cloud Service | | The actual cloud service you want to target. Select one from the list, or use a [variable binding](/docs/projects/variables/variable-substitutions) to define the name of the cloud service. | -| Storage Account | | The Azure Storage Account where the Cloud Service Package (`*.cspkg`) file will be pushed in order to be deployed. | -| Slot | | You can choose to deploy to either the Staging or Production slot. | -| Swap | | Azure allows staging and production deployments to be swapped, by switching virtual IP addresses. When deploying to production, Octopus can detect whether the current staging deployment can be swapped, and if so, it can do a swap rather than a new deployment.
If **Always deploy** is selected, the package will always be deployed to the selected Slot.
If **Swap staging to production if possible** is selected and the selected Slot is Production, then a swap will occur between Production and Staging (if there is a deployment in the Staging slot).
See [VIP Swap](/docs/deployments/azure/cloud-services/vip-swap) for more information on how to configure a VIP swap. | -| Instance Count | | If you have scaled your Windows Azure service using the management portal (for example, changing the role count from 1 to 4), during a deployment Octopus can be configured to keep the existing instance counts rather than using the instance counts defined in your cloud service configuration file. | - -:::div{.success} -**Use variable binding expressions** -Any of the settings above can be switched to use a variable binding expression. A common example is when you use a naming convention for your different cloud services, like **MyCloudService_Production** and **MyCloudService_Test** - you can use environment-scoped variables to automatically configure this step depending on the environment you are targeting. -::: - -### Deployment features available to Azure Cloud Service steps - -The following features are available when deploying a package to an Azure Cloud Service: - -- [Custom Scripts](/docs/deployments/custom-scripts) -- [Configuration Variables](/docs/projects/steps/configuration-features/xml-configuration-variables-feature) -- [.NET Configuration Transforms](/docs/projects/steps/configuration-features/configuration-transforms) -- [Structured configuration variables](/docs/projects/steps/configuration-features/structured-configuration-variables-feature) -- [Substitute variables in templates](/docs/projects/steps/configuration-features/substitute-variables-in-templates) - -Please note these features actually run on the Octopus Server prior to deploying the Cloud Service package to Azure. They don't execute in the Azure Cloud Service instances you are eventually targeting. - -#### Using custom scripts - -[Custom scripts](/docs/deployments/custom-scripts) typically rely on specific tools being available when they execute. - -It is best that you control the version of these tools - your scripts will rely on a specific version that they are compatible with to function correctly. - -The easiest way to achieve this is to use an [execution container](/docs/projects/steps/execution-containers-for-workers) for your step. - -If this is not an option in your scenario, we recommend that you provision your own tools on your worker. - -:::div{.warning} -Using the Azure tools bundled with Octopus Deploy is not recommended. Octopus bundles versions of the Azure Resource Manager Powershell modules (AzureRM) and Azure CLI. These were originally provided as convenience mechanisms for users wanting to run scripts against Azure targets. The versions bundled are now out of date, and we will not be updating them further. - -From **Octopus 2021.2**, a warning will also appear in the deployment logs if the Azure tools bundled with Octopus Deploy are used in a step. - -We recommend you configure Octopus Deploy to use your own [version of the Azure PowerShell cmdlets](/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-powershell-modules/) and [version of the Azure CLI](/docs/deployments/azure/running-azure-powershell/configuring-the-version-of-the-azure-cli). -::: - -If the Azure PowerShell module is available, it will be loaded for your convenience, and the subscription from the account associated with the target will be selected. This means you don't have to worry about loading the Azure PowerShell module nor authenticating with Azure yourself. - -You can write very straightforward scripts like the example below: - -```powershell -# Swap the staging slot into production -$ServiceName = $OctopusParameters["Octopus.Action.Azure.CloudServiceName"] -$Deployment = Get-AzureDeployment -Slot "Staging" -ServiceName $ServiceName -if ($Deployment -ne $null -AND $Deployment.DeploymentId -ne $null) { - Write-Host ("Current Status of staging slot for {0}" -f $ServiceName) - $Deployment - $MoveStatus = Move-AzureDeployment -ServiceName $ServiceName - Write-Host ("Vip swap of {0} status: {1}" -f $ServiceName, $MoveStatus.OperationStatus) -} else { - Write-Host ("There is no deployment in staging slot of {0} to swap." -f $ServiceName) -} -``` -See the [Azure PowerShell documentation](/docs/deployments/azure/running-azure-powershell) for more information. - -## Deployment process - -Deployment to an Azure Cloud Service proceeds as follows (more details provided below): - -1. Download the package from the [package repository](/docs/packaging-applications/package-repositories). -2. Extract the package on the Octopus Server to a temporary location. -3. Extract the Cloud Service package (`.cspkg`) to a temporary location. -4. Any configured or packaged `PreDeploy` scripts are executed. -5. Variable substitutions in Cloud Service configuration file (`.cscfg`). -6. [Substitute variables in templates](/docs/projects/steps/configuration-features/substitute-variables-in-templates) (if configured). -7. [.NET XML configuration transformations](/docs/projects/steps/configuration-features/configuration-transforms) (if configured) are performed. -8. [.NET XML configuration variables](/docs/projects/steps/configuration-features/xml-configuration-variables-feature) (if configured) are replaced. -9. Any configured or package `Deploy` scripts are executed. -10. Re-package the Cloud Service Package. -11. Upload the Cloud Service Package to Azure Storage. -12. Deploy the Cloud Service Package (see 'Customizing the deployment process' section below). -13. Any configured or packaged `PostDeploy` scripts are executed. - -### Extract the Cloud Service package - -Cloud Service Package files are extracted during deployment, in order to make available features such as .NET Configuration Transforms and Variable Substitution. - -To extract the Cloud Service Package, it is first converted to the CTP format (also known as V20120315). This is the format described by Microsoft [documentation](https://msdn.microsoft.com/en-us/library/azure/jj151522.aspx), but is not used by default by the [CSPack ](https://msdn.microsoft.com/en-us/library/azure/gg432988.aspx)utility (passing the `/useCtpPackageFormat` switch is required for this format to be used). This is just an implementation detail, but the documented archive layout gives a good starting point to understanding the layout of the extracted package. - -Setting the `Octopus.Action.Azure.LogExtractedCspkg` variable to `true` will cause the layout of the extracted package to be written into the Task Log. This may assist with finding the path to a particular file. - -:::div{.warning} -**Disable Package Extraction and Re-Packaging** - -Based on customer reports and Azure community discussions, we believe Microsoft is no longer recommending Azure Cloud Services: https://docs.microsoft.com/en-us/azure/architecture/guide/technology-choices/compute-decision-tree. Several customers have reported timeout issues in regards to Azure Cloud Services and slow re-packing of CTP packages. Unfortunately, we cannot fix this issue, [as noted here](https://github.com/OctopusDeploy/Issues/issues/6111). - -The issues around timeouts and slow re-repackaging can be mitigated by passing in the variable `Octopus.Action.Azure.CloudServicePackageExtractionDisabled` and setting the value to `true`. However, in doing so, variable substitution will no longer be available. -::: - -### Variable substitutions in Cloud Service configuration file - -Octopus will attempt to modify your `.cscfg` file. For example, take the following configuration: - -```xml - - - - - - - - - - - - - - - - -``` - -If a variable named `HelloMessage` is defined in your Octopus project variables, Octopus will automatically update it in the configuration file. You can also name the variable `Humpty.Worker/HelloMessage` to scope the setting to a specific web/worker role. - -### Customizing the deployment process - -The deployment is performed using the [open-source Calamari project](https://github.com/OctopusDeploy/Calamari). For backwards compatibility, Octopus will look for a PowerShell script called `DeployToAzure.ps1`. If a file with this name exists within your package, Octopus will invoke it. Otherwise, Octopus will continue to use it's bundled [Sashimi.AzureCloudService](https://github.com/OctopusDeploy/Sashimi.AzureCloudService) library. - -:::div{.hint} -If you choose to override the deployment script, remember that your `DeployToAzure.ps1` file must exist at **the root** of your package. It cannot be located in a subfolder. For reference, you can see how this filename is detected in your extracted package [here](https://github.com/OctopusDeploy/Sashimi.AzureCloudService/blob/main/source/Calamari/DeployAzureCloudServicePackageBehaviour.cs). -::: - -## Deploying to multiple geographic regions - -When your application is deployed to more than one geographic region, you are likely to need per-region configuration settings. You can achieve this result in many different ways, but the two most popular methods we have seen are: - -1. [Cloud Regions](/docs/infrastructure/deployment-targets/cloud-regions/): enable [rolling deployments](/docs/deployments/patterns/rolling-deployments-with-octopus) across multiple geographic regions. -2. Environment-per-region: by creating an environment per region you can leverage [lifecycles](/docs/releases/lifecycles) to create a strict release promotion process. - -Both methods allow you to modify your deployment process and variables per-region, but have slightly different release promotion paths. Choose the one that suits you best. - -## Learn more - -- Generate an Octopus guide for [Azure and the rest of your CI/CD pipeline](https://octopus.com/docs/guides?destination=Azure%20websites). diff --git a/src/pages/docs/deployments/azure/cloud-services/vip-swap.md b/src/pages/docs/deployments/azure/cloud-services/vip-swap.md new file mode 100644 index 0000000000..b38f7ce103 --- /dev/null +++ b/src/pages/docs/deployments/azure/cloud-services/vip-swap.md @@ -0,0 +1,9 @@ +--- +layout: src/layouts/Redirect.astro +title: Redirect +redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure +pubDate: 2023-01-01 +navSearch: false +navSitemap: false +navMenu: false +--- \ No newline at end of file diff --git a/src/pages/docs/deployments/azure/cloud-services/vip-swap.mdx b/src/pages/docs/deployments/azure/cloud-services/vip-swap.mdx deleted file mode 100644 index 22819ae3f1..0000000000 --- a/src/pages/docs/deployments/azure/cloud-services/vip-swap.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: src/layouts/Default.astro -pubDate: 2023-01-01 -modDate: 2023-01-01 -title: VIP swap with Octopus -navTitle: VIP swap -description: The guide demonstrates how to perform a VIP swap when deploying to Azure Cloud Services. -navOrder: 1 ---- -import AzureCloudServicesDeprecated from 'src/shared-content/deprecated-items/azure-cloud-services-deprecated.include.md'; - - - -The guide demonstrates how to perform a VIP swap when deploying to Azure Cloud Services. - -## Using VIP swaps for blue/green deployments - -VIP swap is a great way for you to implement [blue/green deployments](https://octopus.com/devops/software-deployments/blue-green-deployment/) using Azure Cloud Services and Octopus Deploy. The typical process is to: - -1. Deploy a fully configured application into the "staging" slot in Azure. -2. Run manual/automated tests on your "staging" slot. -3. Perform a VIP swap, which simply swaps the "staging" and "production" slots over, resulting in your newly deployed application moving into the "production" slot and beginning to accept requests, and your previous production instance being moved down into the "staging" slot, at which point you can: - * Delete the "staging" slot to free up resources/costs. - * Keep the previous version in "staging" in case you want to roll back - which is as easy as performing another VIP swap. - -In order to complete this guide you should have a Cloud Service project set up in Octopus Deploy that is deploying to the staging or production slot. Please see our documentation for [setting up an Azure Cloud Services deployment in Octopus](/docs/deployments/azure/cloud-services) for more information. - -## Environment configuration - -The easiest way to configure Octopus for VIP swapping is to map Cloud Service slots to Octopus environments. By default a Cloud Service has a staging and production slot. In order to map this in Octopus, create Staging and Production environments: - -:::figure -![](/docs/deployments/azure/cloud-services/environments.png "width=500") -::: - -## Enabling VIP swap \{#VIPSwap-EnablingVIPswap} - -In order to enable VIP swapping, edit the process of your Cloud Service project and toggle the Swap setting to "Swap staging to production if possible": - -:::figure -![](/docs/deployments/azure/cloud-services/vip-swap.png "width=500") -::: - -With this setting enabled Octopus will attempt to swap the staging and production slots but, in the example above, it is always deploying to the staging slot. In order to perform a VIP swap we want to first deploy to Staging and then Production. In order to do this in Octopus, edit the Cloud Service process and replace the Slot setting with a variable that resolves the environment name. Press the square to the right of the Slot field to enable variable binding and enter `#{Octopus.Environment.Name}`: - -:::figure -![](/docs/deployments/azure/cloud-services/vip-swap-binding.png "width=500") -::: - -## Performing a VIP swap - -In order to perform a VIP swap you must have a deployment in your Cloud Service production slot. The first time you create a release and deploy it to Staging and then Production it will not VIP swap. On subsequent deployments to Staging and then Production a VIP swap will occur: - -:::figure -![](/docs/deployments/azure/cloud-services/vip-task-log.png "width=500") -::: - -## Automatic VIP swap \{#VIPSwap-AutomaticVIPswap} - -A production VIP swap can be automatically performed after a successful staging deployment through the use of lifecycles. A lifecycle should be configured with two phases: Staging and Production. The Staging phase contains the Staging environment and the Production phase contains the Production environment. The Production environment should be configured with "Deploy automatically to this environment as soon as the release enters this phase.": - -:::figure -![](/docs/deployments/azure/cloud-services/vip-lifecycles.png "width=500") -::: - -Configure the Cloud Service project to use the newly created lifecycle from the project process tab: - -:::figure -![](/docs/deployments/azure/cloud-services/vip-project-lifecycle.png "width=500") -::: - -Now each time a release is deployed to staging it will automatically perform a VIP swap with production. diff --git a/src/pages/docs/deployments/azure/deploying-a-package-to-an-azure-cloud-service/index.md b/src/pages/docs/deployments/azure/deploying-a-package-to-an-azure-cloud-service/index.md index c3e70aef17..9211fcbdaf 100644 --- a/src/pages/docs/deployments/azure/deploying-a-package-to-an-azure-cloud-service/index.md +++ b/src/pages/docs/deployments/azure/deploying-a-package-to-an-azure-cloud-service/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Redirect.astro title: Redirect -redirect: https://octopus.com/docs/deployments/azure/cloud-services +redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure pubDate: 2023-01-01 navSearch: false navSitemap: false diff --git a/src/pages/docs/deployments/custom-scripts/index.md b/src/pages/docs/deployments/custom-scripts/index.md index 98d8e861aa..108cbc2d95 100644 --- a/src/pages/docs/deployments/custom-scripts/index.md +++ b/src/pages/docs/deployments/custom-scripts/index.md @@ -94,7 +94,7 @@ Learn about [script integrity](/docs/security/script-integrity). We recommend the following approaches for developing and testing your scripts, in order of preference: - 1. Build your script to use script arguments as inputs so it can be invoked with equal fidelity from Octopus or directly in your development environment. You can test your scripts by invoking them directly in a development environment with a very fast feedback cycle. Learn about [passing parameters to scripts](passing-parameters-to-scripts/). The only difference in this approach may be the user context the script runs in. + 1. Build your script to use script arguments as inputs so it can be invoked with equal fidelity from Octopus or directly in your development environment. You can test your scripts by invoking them directly in a development environment with a very fast feedback cycle. Learn about [passing parameters to scripts](/docs/deployments/custom-scripts/passing-parameters-to-scripts). The only difference in this approach may be the user context the script runs in. 2. Build your script as a reusable step template and test it using the `Run Now` feature. [Learn about step templates](/docs/projects/custom-step-templates). The only difference to this approach is the absence of deployment-specific variables provided by Octopus when actually running a deployment. 3. Put your script in a test process and run that process in a test environment. 4. Put your script in a real process and run that process in a test environment. diff --git a/src/pages/docs/deployments/custom-scripts/run-a-script-step.md b/src/pages/docs/deployments/custom-scripts/run-a-script-step.md index 746e83890e..83f5a52572 100644 --- a/src/pages/docs/deployments/custom-scripts/run-a-script-step.md +++ b/src/pages/docs/deployments/custom-scripts/run-a-script-step.md @@ -147,6 +147,17 @@ If the package reference was _not_ configured to be extracted, then the un-extra These locations were designed to be convenient for use from custom scripts, as the relative path can be predicted, e.g. `./Acme` or `./Acme.zip`. If the absolute path is required the variables above may be used. +#### Docker image package variables +In the scenario where your package reference is a Docker image some additional variables will be contributed. These variables are (assuming a package-reference named `Acme`): + +| Variable name and description | Example | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| `Octopus.Action.Package[Acme].Image`
The fully qualified image name | *index.docker.io/Acme:1.4.0* | +| `Octopus.Action.Package[Acme].Registry`
The URI of the registry from the feed where the image was acquired from | *index.docker.io* | +| `Octopus.Action.Package[Acme].Version`
The version of the image included in the release | *1.4.0* | +| `Octopus.Action.Package[Acme].Feed.UserName`
The username from the feed where the image was acquired from (if the feed is configured to use credentials) | *Alice* | +| `Octopus.Action.Package[Acme].Feed.Password`
The password from the feed where the image was acquired from (if the feed is configured to use credentials) | *Password01!* | + ## Older versions Scripts sourced from your Projects Git Repository was added in Octopus **2024.1**. In Octopus versions prior, the Git Repository source is not available. diff --git a/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md b/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md index 346d37d63b..5ff6fdc970 100644 --- a/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md +++ b/src/pages/docs/deployments/custom-scripts/scripts-in-packages/index.md @@ -59,7 +59,7 @@ However, not all package steps support script hooks. As a general rule, any of t ## Running a script when a step fails -You can create a file named `DeployFailed.`, which will be invoked if the step fails. Our blog post about this feature [describes how DeployFailed. works](https://octopus.com/blog/deployfailed). +You can create a file named `DeployFailed.`, which will be invoked if the step fails. ## How Octopus executes your scripts @@ -115,4 +115,4 @@ If you are using OctoPack to package a Windows Service or console application, s Read more about [using OctoPack](/docs/packaging-applications/create-packages/octopack). -If the scripts in your package are still not running, make sure someone has not set a project variable called `Octopus.Action.Package.RunScripts` to `false` for the step where the scripts should run. \ No newline at end of file +If the scripts in your package are still not running, make sure someone has not set a project variable called `Octopus.Action.Package.RunScripts` to `false` for the step where the scripts should run. diff --git a/src/pages/docs/deployments/terraform/index.md b/src/pages/docs/deployments/terraform/index.md index 927df27df7..f1974bc998 100644 --- a/src/pages/docs/deployments/terraform/index.md +++ b/src/pages/docs/deployments/terraform/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-01-01 +modDate: 2024-12-23 title: Terraform description: Terraform deployments navOrder: 100 @@ -16,7 +16,7 @@ Octopus Deploy provides first-class support for deploying Terraform templates. The `Plan to apply a Terraform template` will generate a plan for the result of running `apply` on a template, while `Plan a Terraform destroy` will generate a plan for the result of running `destroy` on the template. -Similarly, the `Apply a Terraform template` step can be used to create or update a resources from a Terraform template, while the `Destroy Terraform resources` step can be used to destroy existing Terraform resources. +Similarly, the `Apply a Terraform template` step can be used to create or update resources from a Terraform template, while the `Destroy Terraform resources` step can be used to destroy existing Terraform resources. The built-in Octopus Terraform steps are created to help you follow a pipeline using the following process: @@ -31,12 +31,12 @@ The built-in Octopus Terraform steps are created to help you follow a pipeline u All Terraform steps execute on a worker. By default, that will be the built-in worker in the Octopus Server. Learn about [workers](/docs/infrastructure/workers) and the different configuration options. :::div{.warning} -If the Terraform tool is updated above version `0.11`, you are using an Octopus version prior to **2020.5.0**, and you are using the **Source Code** option within a Terraform step, you will receive syntax warnings within Octopus. You can update the Terraform tool to a version higher than `0.11` without issue in an Octopus version prior to **2020.5.0** only if you use the **File inside a package** option within the terraform step. +If the Terraform tool is updated above version `0.11`, you are using an Octopus version prior to **2020.5.0**, and you are using the **Source Code** option within a Terraform step, you will receive syntax warnings within Octopus. You can update the Terraform tool to a version higher than `0.11` without issue in an Octopus version prior to **2020.5.0** only if you use the **File inside a package** option within the Terraform step. ::: ## Special variables -Setting the variable `Octopus.Action.Terraform.CustomTerraformExecutable` to the absolute path of a custom Terraform executable will result in the step using that executable instead of the one shipped with Octopus. You can use this variable to force the Terraform steps to use a specific version of Terraform, or to use the x64 version if you wish. +Setting the variable `Octopus.Action.Terraform.CustomTerraformExecutable` to the absolute path of a custom Terraform executable will result in the step using that executable instead of the one shipped with Octopus. You can use this variable to force the Terraform steps to use a specific version of Terraform or to use the x64 version if you wish. For example, setting `Octopus.Action.Terraform.CustomTerraformExecutable` to `C:\Apps\terraform.exe` will cause the steps to execute `C:\Apps\terraform.exe` rather than the built in copy of Terraform. @@ -48,7 +48,7 @@ The Terraform steps have some unique messages that may be displayed in the outpu ### Terraform-Configuration-UntestedTerraformCLIVersion -The Terraform steps in Octopus Deploy are tested against a range of versions of the Terraform CLI from 0.11.15 to 1.0.0. As new versions of Terraform are released, testing will be expanded to include these versions to ensure that they are compatible with the Terraform steps in Octopus. In the meantime, if the Terraform CLI version used in a step is outside the tested range a message will be displayed in the output indicating this. The Terraform step will likely continue to run successfully even if the CLI version being used has not been tested in Octopus. If the step succeeds, then the message will be informational only, and there is no action that needs to be taken. If the step resulted in an error, then the message will be a warning; however, the error may not be related to the version of Terraform being used. +The Terraform steps in Octopus Deploy are tested against a range of versions of the Terraform CLI. If the Terraform CLI version used in a step is outside the tested range, a message will be displayed in the output indicating this. The Terraform step will likely continue to run successfully even if the CLI version being used has not been tested in Octopus. If the step succeeds, then the message will be informational only, and there is no action that needs to be taken. If the step resulted in an error, then the message will be a warning; however, the error may not be related to the version of Terraform being used. ## Learn more diff --git a/src/pages/docs/infrastructure/accounts/google-cloud/index.md b/src/pages/docs/infrastructure/accounts/google-cloud/index.md index 381e3443d9..d446b191ec 100644 --- a/src/pages/docs/infrastructure/accounts/google-cloud/index.md +++ b/src/pages/docs/infrastructure/accounts/google-cloud/index.md @@ -8,18 +8,46 @@ navOrder: 30 --- :::div{.hint} -Google Cloud Accounts were added in Octopus **2021.2**. +Google Cloud Accounts were added in Octopus **2021.2**, Generic OpenId Connect Accounts were added in **2025.1** ::: -To deploy infrastructure to Google Cloud Platform, you can define a Google cloud account in Octopus. +To deploy infrastructure to Google Cloud Platform, you can define a Google cloud or Generic OpenId Connect account in Octopus. -Octopus manages the GCP credentials used by the Google cloud steps. +The Generic OpenId Connect Account generates a JWT that can be used for [OpenID Connect](/docs/infrastructure/accounts/openid-connect) authentication. The Google cloud account uses the JSON key file credentials that can be retrieved from the service account assigned to the instance that is executing the deployment. -The Google cloud account is the JSON key file credentials that can be retrieved from the service account assigned to the instance that is executing the deployment. +## Generic OpenId Connect Account +Google Cloud steps can use a Generic OpenId Connect Account for authentication. + +1. Navigate to **Infrastructure ➜ Accounts**, click the **ADD ACCOUNT** and select **Generic Oidc Account**. +1. Add a memorable name for the account. +1. Set the [Deployments and Runbooks](/docs/infrastructure/accounts/openid-connect#subject-key-parts) subject generator +1. set an audience, this should match the audience set on the Workload Identity Federation. By default this is `https://iam.googleapis.com/projects/{project-id}/locations/global/workloadIdentityPools/{pool-id}/providers/{provider-id}` +1. Click the **SAVE**, to test the account set it as the account on a gcloud script step. + +See the [Google cloud documentation](https://cloud.google.com/iam/docs/workload-identity-federation-with-other-providers) for instructions on creating and configuring a Workload Identity Federation. + +Behind the scenes Octopus calls the gcloud cli with the following command to authenticate: + +```bash +gcloud iam workload-identity-pools create-cred-config \ + \ + --service-account= \ + --service-account-token-lifetime-seconds=3600 \ + --output-file= \ + --credential-source-file= \ + --credential-source-type=text \ + --subject-token-type=urn:ietf:params:oauth:token-type:jwt \ + --app-id-uri= +``` + + +:::div{.hint} +The default audience format is `https://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID` while `workload-identity-pools create-cred-config` command expects the audience without `https://iam.googleapis.com`. In this scenario Octopus expects the full audience value to be set on the account including `https://iam.googleapis.com` but will trim the `https://iam.googleapis.com` when running the create-cred-config command. +::: ## Create a Google cloud account -Google Cloud steps can use an Octopus managed account for authentication. +Google Cloud steps can use a Google Cloud Account for authentication. 1. Navigate to **Infrastructure ➜ Accounts**, click the **ADD ACCOUNT** and select **Google Cloud Account**. 1. Add a memorable name for the account. diff --git a/src/pages/docs/infrastructure/azure-cloud-service-target.md b/src/pages/docs/infrastructure/azure-cloud-service-target.md index b3c23dd5b0..9211fcbdaf 100644 --- a/src/pages/docs/infrastructure/azure-cloud-service-target.md +++ b/src/pages/docs/infrastructure/azure-cloud-service-target.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Redirect.astro title: Redirect -redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure/cloud-service-targets +redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure pubDate: 2023-01-01 navSearch: false navSitemap: false diff --git a/src/pages/docs/infrastructure/azure/cloud-service-targets/index.md b/src/pages/docs/infrastructure/azure/cloud-service-targets/index.md index b3c23dd5b0..9211fcbdaf 100644 --- a/src/pages/docs/infrastructure/azure/cloud-service-targets/index.md +++ b/src/pages/docs/infrastructure/azure/cloud-service-targets/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Redirect.astro title: Redirect -redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure/cloud-service-targets +redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure pubDate: 2023-01-01 navSearch: false navSitemap: false diff --git a/src/pages/docs/infrastructure/deployment-targets/azure/cloud-service-targets/index.md b/src/pages/docs/infrastructure/deployment-targets/azure/cloud-service-targets/index.md index 378ea2b68c..b38f7ce103 100644 --- a/src/pages/docs/infrastructure/deployment-targets/azure/cloud-service-targets/index.md +++ b/src/pages/docs/infrastructure/deployment-targets/azure/cloud-service-targets/index.md @@ -1,55 +1,9 @@ --- -layout: src/layouts/Default.astro -pubDate: 2023-01-01 -modDate: 2024-06-27 -title: Azure Cloud Service targets -description: Azure Cloud Service deployment targets allow you to reference existing classic Cloud Services in your Azure subscription, that you can then reference by target tag during deployments. -navOrder: 100 ---- - -Azure Cloud Service deployment targets allow you to reference existing classic Cloud Services in your Azure subscription, that you can then reference by [target tag](/docs/infrastructure/deployment-targets/target-tags) during deployments. - -:::div{.warning} -Microsoft [announced](https://blogs.msdn.microsoft.com/appserviceteam/2018/03/12/deprecating-service-management-apis-support-for-azure-app-services/) that from June 30th 2018 they are retiring support for Azure Service Management API (which indicates Cloud Services). Microsoft stated that _"Cloud Services is similar to Service Fabric in degree of control versus ease of use, but it's now a legacy service and Service Fabric is recommended for new development"_ ([source](https://docs.microsoft.com/en-us/azure/app-service/choose-web-site-cloud-service-vm)). - -Support for this feature will be deprecated in Octopus Server from the `2024.1` release. -::: - -## Requirements - -You can read more about all the PaaS targets [in our blog](https://octopus.com/blog/paas-targets). - -- You will need an [Azure Management Certificate account](/docs/infrastructure/accounts/azure/#azure-management-certificate) that references your Azure subscription. - -- Once your Azure account is setup, you will then need an existing Azure Cloud Service (classic) setup within your Azure subscription. To learn more about App Services, the Azure team provide [useful documentation on App Services](https://docs.microsoft.com/en-us/azure/cloud-services/) that can help you get started. If you are dynamically creating the cloud services during your deployment, check our section about [creating Cloud Service targets by scripts using service messages](#creating-cloud-service-targets-by-scripts). - -## Creating Cloud Service targets - -Once you have a Cloud Service setup within your Azure subscription, you are then ready to map that to an Octopus deployment target. - -To create an Azure Cloud Service target within Octopus: - -- Go to **Infrastructure ➜ Deployment Targets ➜ Add Deployment Target**. -- Select **Azure Cloud Service** from the list of available targets and click _Next_. -- Fill out the necessary fields, being sure to provide a unique target tag that clearly identifies your Azure Cloud Service target. - -:::figure -![](/docs/infrastructure/deployment-targets/azure/cloud-service-targets/create-azure-cloud-service-target.png) -::: - -- After clicking _Save_, your deployment target will be added and go through a health check to ensure Octopus can connect to it. -- If all goes well, you should see your newly created target in your **Deployment Targets** list, with a status of _Healthy_. - -### Creating Cloud Service targets by scripts - -Azure Cloud Service targets can also be created via a PowerShell cmdlet within a Deployment Process, this can be especially handy if you are also creating the Azure Cloud Service via a script. - -See [Creating Resources by script](/docs/infrastructure/deployment-targets/dynamic-infrastructure) for more information on creating Azure Cloud Services via a script. - -## Deploying to Cloud Service targets - -See our [documentation about this topic](/docs/deployments/azure/cloud-services) - -## Troubleshooting - -If your Azure Cloud Service target is not completing a health check successfully, you may need to check that your Octopus Server can communicate with Azure. It may be worth checking that your Azure Account is able to complete a _Save and Test_ to ensure Octopus can communicate with Azure and the management certificate referenced by the account is valid. If your Octopus Server is behind a proxy or firewall, you will need to consult with your Systems Administrator to ensure it is able to communicate with Azure. +layout: src/layouts/Redirect.astro +title: Redirect +redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure +pubDate: 2023-01-01 +navSearch: false +navSitemap: false +navMenu: false +--- \ No newline at end of file diff --git a/src/pages/docs/infrastructure/deployment-targets/azure/index.md b/src/pages/docs/infrastructure/deployment-targets/azure/index.md index 08fe4ec9fa..3b713dcfe5 100644 --- a/src/pages/docs/infrastructure/deployment-targets/azure/index.md +++ b/src/pages/docs/infrastructure/deployment-targets/azure/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-06-27 +modDate: 2024-12-12 title: Azure targets description: Configure your Azure infrastructure navOrder: 40 @@ -16,8 +16,11 @@ The currently supported Azure targets are: - [Azure Service Fabric Clusters](/docs/infrastructure/deployment-targets/azure/service-fabric-cluster-targets). - [Azure Web Apps](/docs/infrastructure/deployment-targets/azure/web-app-targets) (also works for Azure Functions). -- [Azure Cloud Services](/docs/infrastructure/deployment-targets/azure/cloud-service-targets). +- Azure Kubernetes Service via the [Kubernetes Agent](/docs/kubernetes/targets/kubernetes-agent) and [Kubernetes API](/docs/kubernetes/targets/kubernetes-api) deployment targets. +- Azure VM via [Tentacle using Desired State Configuration (DSC)](/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template-with-dsc). :::div{.warning} -Regarding Azure Cloud Services, Microsoft [announced](https://blogs.msdn.microsoft.com/appserviceteam/2018/03/12/deprecating-service-management-apis-support-for-azure-app-services/) that from June 30th 2018 they are retiring support for Azure Service Management API (which indicates Cloud Services). Microsoft stated that _"Cloud Services is similar to Service Fabric in degree of control versus ease of use, but it's now a legacy service and Service Fabric is recommended for new development"_ ([source](https://docs.microsoft.com/en-us/azure/app-service/choose-web-site-cloud-service-vm)). +Azure Cloud Services are no longer supported in Octopus Deploy as of `2025.1`. + +Microsoft has deprecated these Azure services, and as of October 1st 2024 shut down existing Cloud Service deployments. ([Source](https://learn.microsoft.com/en-us/azure/cloud-services/cloud-services-choose-me)) ::: diff --git a/src/pages/docs/infrastructure/deployment-targets/azure/web-app-targets/index.md b/src/pages/docs/infrastructure/deployment-targets/azure/web-app-targets/index.md index 567569a3b0..7b7a57415f 100644 --- a/src/pages/docs/infrastructure/deployment-targets/azure/web-app-targets/index.md +++ b/src/pages/docs/infrastructure/deployment-targets/azure/web-app-targets/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-06-27 +modDate: 2024-12-12 title: Azure Web App targets description: Azure Web App deployment targets allow you to reference existing Web Apps in your Azure subscription, that you can then reference by target tag during deployments. navOrder: 20 @@ -17,7 +17,7 @@ From version 2022.1 Octopus can discover Azure Web App targets using tags on you - You need an [Azure Service Principal account](/docs/infrastructure/accounts/azure/#azure-service-principal) that references your Azure subscription. -- Once your Azure account is setup, you need an existing Azure Web App / App Service setup within your Azure subscription. To learn more about App Services, see the [Azure App Services documentation](https://docs.microsoft.com/en-us/azure/app-service/) that can help you get started. If you are dynamically creating the web app during your deployment, check our section about [creating Web App targets by scripts using service messages](#creating-web-app-targets-by-scripts). +- Once your Azure account is setup, you need an existing Azure Web App / App Service setup within your Azure subscription. To learn more about App Services, see the [Azure App Services documentation](https://docs.microsoft.com/en-us/azure/app-service/) that can help you get started. If you are dynamically creating the web app during your deployment, check our section about [discovering web app targets](#discovering-web-app-targets) or [creating Web App targets by scripts using service messages](#creating-web-app-targets-by-scripts). ## Discovering web app targets @@ -47,8 +47,8 @@ Once you have an App Service configured within your Azure subscription, you are To create an Azure Web App target within Octopus: -- Navigate to **Infrastructure ➜ Deployment Target ➜ Add Deployment Target**. -- Select **Azure Web App** from the list of available targets and click _Next_. +- Navigate to **Deploy ➜ Infrastructure ➜ Deployment Targets ➜ Add Deployment Target**. +- Select **Azure tab** and then select **Azure Web App** from the list of available targets and click _Next_. - Fill out the necessary fields, being sure to provide a unique target tag (formerly target role) that clearly identifies your Azure Web App target. :::figure diff --git a/src/pages/docs/infrastructure/deployment-targets/dynamic-infrastructure/azure-cloud-service-target.md b/src/pages/docs/infrastructure/deployment-targets/dynamic-infrastructure/azure-cloud-service-target.md new file mode 100644 index 0000000000..b38f7ce103 --- /dev/null +++ b/src/pages/docs/infrastructure/deployment-targets/dynamic-infrastructure/azure-cloud-service-target.md @@ -0,0 +1,9 @@ +--- +layout: src/layouts/Redirect.astro +title: Redirect +redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure +pubDate: 2023-01-01 +navSearch: false +navSitemap: false +navMenu: false +--- \ No newline at end of file diff --git a/src/pages/docs/infrastructure/deployment-targets/dynamic-infrastructure/azure-cloud-service-target.mdx b/src/pages/docs/infrastructure/deployment-targets/dynamic-infrastructure/azure-cloud-service-target.mdx deleted file mode 100644 index 1a53440521..0000000000 --- a/src/pages/docs/infrastructure/deployment-targets/dynamic-infrastructure/azure-cloud-service-target.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: src/layouts/Default.astro -pubDate: 2023-01-01 -modDate: 2024-06-27 -title: Create Azure Cloud Service target command -description: Cmdlet for creating an Azure Cloud Service target -navOrder: 40 ---- -import CreateDeploymentTargetsHint from 'src/shared-content/infrastructure/create-deployment-targets-hint.include.md'; - -## Azure Cloud Service - -Command: **_New-OctopusAzureCloudServiceTarget_** - -| Parameter | Value | -| ------------------------------------| --------------------------------------------------------------------------------------- | -| `-name` | Name for the Octopus deployment target | -| `-azureCloudServiceName` | Name of the Azure Cloud Service | -| `-azureStorageAccount` | Name of the Azure Storage Account | -| `-azureDeploymentSlot` | Deployment slot.
Options are `staging` (default), `production` | -| `-swap` | Swap staging to production, or just deploy.
Options are `swap` (default), `deploy` | -| `-instanceCount` | Use the current instance count from Azure, or use the value in the configuration file.
Options are `current` (default), `configuration` | -| `-octopusAccountIdOrName` | Name or Id of the Account Resource in Octopus. Must be a Management Certificate Account | -| `-octopusRoles` | Comma separated list of [target tags](/docs/infrastructure/deployment-targets/target-tags) to assign | -| `-updateIfExisting` | Will update an existing Cloud Service target with the same name, create if it doesn't exist | -| `-octopusDefaultWorkerPoolIdOrName` | Name or Id of the Worker Pool for the deployment target to use. (Optional). Added in 2020.6.0. | - -Example: -```powershell -# Using default options -New-OctopusAzureCloudServiceTarget -name "My Azure Cloud Service Target" ` - -azureCloudServiceName "CloudService1" ` - -azureStorageAccount "MyAzureCloudStorageAccount" ` - -octopusAccountIdOrName "Service Management Cert Account" ` - -octopusRoles "AzureCloudService" ` - -updateIfExisting - -# Overriding default values -New-OctopusAzureCloudServiceTarget -name "My Azure Cloud Service Target" ` - -azureCloudServiceName "CloudService1" ` - -azureStorageAccount "MyAzureCloudStorageAccount" ` - -azureDeploymentSlot "production" ` - -swap "deploy" ` - -instanceCount "configuration" ` - -octopusAccountIdOrName "Service Management Cert Account" ` - -octopusDefaultWorkerPoolIdOrName "Azure Worker Pool" ` - -octopusRoles "AzureCloudService" -``` - - \ No newline at end of file diff --git a/src/pages/docs/infrastructure/deployment-targets/linux/index.md b/src/pages/docs/infrastructure/deployment-targets/linux/index.md index 9f620fe5cb..d7a50ccbc1 100644 --- a/src/pages/docs/infrastructure/deployment-targets/linux/index.md +++ b/src/pages/docs/infrastructure/deployment-targets/linux/index.md @@ -40,7 +40,6 @@ The following platforms are explicitly supported (we run automated tests against - Redhat (RHEL) 8.10 - Amazon Linux 2 - Debian 11 -- Fedora 39 - MacOS 12.6.3 - openSUSE 15.6 - SUSE LES 15 SP5 diff --git a/src/pages/docs/infrastructure/deployment-targets/linux/ssh-deployments.md b/src/pages/docs/infrastructure/deployment-targets/linux/ssh-deployments.md index 4dd0aa4748..75658e79ed 100644 --- a/src/pages/docs/infrastructure/deployment-targets/linux/ssh-deployments.md +++ b/src/pages/docs/infrastructure/deployment-targets/linux/ssh-deployments.md @@ -29,17 +29,18 @@ If you are writing a cross-platform script, be aware of the differences between :::div{.hint} **Bash (and other shell) variables** Octopus Deploy will log into the SSH target via a non-interactive shell. Because of this, startup files like `.bashrc` are not fully evaluated. If you are referencing bash variables `export`ed in these files, you should move them before the following common code block at the top of the file: -``` + +```bash # If not running interactively, don't do anything case $- in *i*) ;; *) return;; esac ``` + This will ensure that they are evaluated on non-interactive logins. ::: - ### Example: Using variables in Bash Your script can use a [variable value](/docs/projects/variables) by invoking the `get_octopusvariable` function. For example, to echo out the installation directory call @@ -48,17 +49,17 @@ Your script can use a [variable value](/docs/projects/variables) by invoking the You can also set an [output variable](/docs/projects/variables/output-variables): -> ``` -> set_octopusvariable RandomNumber 3 -> ``` +```bash +set_octopusvariable RandomNumber 3 +``` ### Example: Collecting an artifact Your script can tell Octopus to collect a file and store it as a [deployment artifact](/docs/projects/deployment-process/artifacts): -> ``` -> new_octopusartifact "./subdir/anotherdir/myfile" -> ``` +```bash +new_octopusartifact "./subdir/another_dir/my_file" +``` which results in the server retrieving that file, at the end of that step. Keep in mind that this means the file must be accessible over SFTP using the same credentials as that used during execution. @@ -76,11 +77,11 @@ By making all paths relative to the user's home directory, you can then theoreti ## Package acquisition -Leveraging Calamari means that the deployment can obtain the package via the same methods as a target running the Tentacle agent; either pushed from the server or directly from a NuGet repository. There is therefore no bottleneck in acquisition if there are multiple SSH endpoints all trying to retrieve the same package independently. +Leveraging Calamari means that the deployment can obtain the package via the same methods as a target running the Tentacle agent; either pushed from the server or directly from a supported [external repository](/docs/packaging-applications/package-repositories). There is therefore no bottleneck in acquisition if there are multiple SSH endpoints all trying to retrieve the same package independently. ## Calamari -Calamari is the tool Octopus uses to execute deployments on a remote computer. Before any processing is begun we do an initial check to ensure the available Calamari executable on the endpoint is up to date with the server. If not, we push up the latest Calamari package and then recommence the task. The Calamari package is sent as a `.tar.gz` so it can be extracted with minimal dependencies. This means the server needs to be able to un-tar that package, however, this should be available by default in most distros. +Calamari is the tool Octopus uses to execute deployments on a remote computer. Before any processing is begun we do an initial check to ensure the available Calamari executable on the endpoint is up to date with the server. If not, we push up the latest Calamari package and then recommence the task. The Calamari package is sent as a `.tar.gz` so it can be extracted with minimal dependencies. This means the server needs to be able to un-tar that package, however, this should be available by default in most distributions. ## Learn more diff --git a/src/pages/docs/kubernetes/resources/index.md b/src/pages/docs/kubernetes/resources/index.md index e47e2d79aa..222fa80dba 100644 --- a/src/pages/docs/kubernetes/resources/index.md +++ b/src/pages/docs/kubernetes/resources/index.md @@ -27,6 +27,7 @@ Octopus will also show a snapshot (from the moment of deployment) of deployed ob Kubernetes Object status is available for these steps. * Deploy Kubernetes YAML +* Deploy a Helm Chart * Deploy with Kustomize * Configure and apply Kubernetes resources (except for the Blue/Green deployment strategy) * Configure and apply a Kubernetes ConfigMap @@ -36,8 +37,21 @@ Kubernetes Object status is available for these steps. Object status is disabled for all steps added before the feature was introduced and enabled by default in all the new steps added later. + ## How to configure +### Helm + +Use the `Step Verification` section on the step configuration page. + +:::figure +![A screenshot of the Helm Step Verification configuration section](/docs/deployments/kubernetes/object-status/helm-step-verification.png) +::: + +Enabling the option will add the Helm [`--wait`](https://helm.sh/docs/helm/helm_upgrade/#options) parameter to the upgrade command. Additionally, when enabled, you can also enable the use of the Helm parameter [`--wait-for-jobs`](https://helm.sh/docs/helm/helm_upgrade/#options) to wait for jobs to run before determining step success. + +### Other steps + Use the `Kubernetes Object Status Check` section on the step configuration page. :::figure @@ -46,7 +60,7 @@ Use the `Kubernetes Object Status Check` section on the step configuration page. Use the first option to enable the feature (`Check that Kubernetes objects are running successfully`). Choosing `Don't do any verification checks` will disable the feature. -One can configure two extra parameters. +One can configure two extra parameters: * **Step timeout** refers to the maximum time a deployment step can run before termination (determined in seconds). This setting is intended to prevent a step from running indefinitely or causing delays in the overall deployment process. If one disables the parameter (checkbox), you allow the step to run indefinitely. @@ -57,6 +71,12 @@ A user needs to create and deploy a new release after one saves the new configur ## How it works +### Helm + +Helm has an existing mechanism for tracking the status of deployed resources, the [`--wait`](https://helm.sh/docs/helm/helm_upgrade/#options) parameter on the upgrade command. Rather than Octopus providing another mechanism on top of this, Octopus adds this parameter to the upgrade parameters and relies on Helm to track the deployed resources and fail the step if the resource fails + +### Other steps + When a deployment to a Kubernetes cluster is created, Octopus identifies the objects to create or update during this deployment. It then checks the status of these objects continuously throughout the deployment process. Apart from the objects that are defined directly in the project, Octopus also grabs the status of any children objects of them. For example, ReplicaSets and Pods that belong to a Deployment are included along with the Deployment itself, despite they are not defined directly. The step will succeed as soon as Kubernetes achieves the desired state. diff --git a/src/pages/docs/kubernetes/targets/kubernetes-agent/index.md b/src/pages/docs/kubernetes/targets/kubernetes-agent/index.md index a367eac560..db3f6ce06f 100644 --- a/src/pages/docs/kubernetes/targets/kubernetes-agent/index.md +++ b/src/pages/docs/kubernetes/targets/kubernetes-agent/index.md @@ -73,11 +73,17 @@ The Kubernetes agent follows [semantic versioning](https://semver.org/), so a ma | Kubernetes agent | Octopus Server | Kubernetes cluster | | ---------------- | ------------------------ | -------------------- | -| 1.\*.\* | **2024.2.6580** or newer | **1.26** to **1.29** | -| 2.\*.\* | **2024.2.9396** or newer | **1.26** to **1.29** | +| 1.0.0 - 1.16.1 | **2024.2.6580** or newer | **1.26** to **1.29** | +| 1.17.0 - 1.19.2 | **2024.2.6580** or newer | **1.27** to **1.30** | +| 1.20.0 - 1.\*.\* | **2024.2.6580** or newer | **1.28** to **1.31** | +| 2.0.0 - 2.2.1 | **2024.2.9396** or newer | **1.26** to **1.29** | +| 2.3.0 - 2.8.2 | **2024.2.9396** or newer | **1.27** to **1.30** | +| 2.9.0 - 2.\*.\* | **2024.2.9396** or newer | **1.28** to **1.31** | Additionally, the Kubernetes agent only supports **Linux AMD64** and **Linux ARM64** Kubernetes nodes. +See our [support policy](/docs/kubernetes/targets/kubernetes-agent/supported-versions-policy) for more information. + ## Installing the Kubernetes agent The Kubernetes agent is installed using [Helm](https://helm.sh) via the [octopusdeploy/kubernetes-agent](https://hub.docker.com/r/octopusdeploy/kubernetes-agent) chart. diff --git a/src/pages/docs/kubernetes/targets/kubernetes-agent/permissions.md b/src/pages/docs/kubernetes/targets/kubernetes-agent/permissions.md index 0a6750c88f..d9ed20d3e2 100644 --- a/src/pages/docs/kubernetes/targets/kubernetes-agent/permissions.md +++ b/src/pages/docs/kubernetes/targets/kubernetes-agent/permissions.md @@ -34,7 +34,7 @@ The service account for script pods can be customized in a few ways: |:----------------------------------------------|:-----------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `scriptPods.serviceAccount.targetNamespaces` | Limit the namespaces that the service account can interact with. | `[]`
(When empty, all namespaces are allowed.) | | `scriptPods.serviceAccount.clusterRole.rules` | Give the service account custom rules | 
- apiGroups:
  - '\*'
  resources:
  - '\*'
  verbs:
  - '\*'
- nonResourceURLs:
  - '\*'
  verbs:
  - '\*'
| -| `scriptPods.serviceAccount.name` | The name of the scriptPods service account | `-tentacle` | +| `scriptPods.serviceAccount.name` | The name of the scriptPods service account | `-scripts` | | `scriptPods.serviceAccount.annotations` | Annotations given to the service account | `[]` | ### Examples @@ -118,4 +118,4 @@ oci://registry-1.docker.io/octopusdeploy/kubernetes-agent # NFS Server Pod Permissions -If you have not provided a predefined storageClassName for persistence, an NFS pod will be used. This NFS Server pod requires `privileged` access. For more information see [Kubernetes agent Storage](/docs/infrastructure/deployment-targets/kubernetes/kubernetes-agent/storage#nfs-storage). \ No newline at end of file +If you have not provided a predefined storageClassName for persistence, an NFS pod will be used. This NFS Server pod requires `privileged` access. For more information see [Kubernetes agent Storage](/docs/infrastructure/deployment-targets/kubernetes/kubernetes-agent/storage#nfs-storage). diff --git a/src/pages/docs/kubernetes/targets/kubernetes-agent/supported-versions-policy.md b/src/pages/docs/kubernetes/targets/kubernetes-agent/supported-versions-policy.md new file mode 100644 index 0000000000..c85ed2f8df --- /dev/null +++ b/src/pages/docs/kubernetes/targets/kubernetes-agent/supported-versions-policy.md @@ -0,0 +1,26 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2024-12-11 +modDate: 2024-12-11 +title: Support Policy for Kubernetes Versions +navTitle: Supported Versions Policy +navSection: Kubernetes agent +description: Policy for which versions of Kubernetes are supported by the Kubernetes agent +navOrder: 100 +--- + +[The Kubernetes project](https://kubernetes.io/releases/version-skew-policy/#supported-versions) maintains release branches for the most recent three minor releases of Kubernetes. + +Octopus aims to follow this support policy as closely as makes sense. + +## Kubernetes Agent + +The Kubernetes agent uses the [Kubernetes C# client](https://github.com/kubernetes-client/csharp) to interact with the Kubernetes API, so we are bound to their release cadence. The Kubernetes agent will receive an update within **3 months** of a new major release of the Kubernetes C# client being released. + +If your use case requires the latest and greatest version of Kubernetes before we have released a new version, please [contact support](https://octopus.com/company/contact) to discuss options. + +### Support for older versions + +Each time the Kubernetes agent is updated to support a new version of Kubernetes, support for older versions will be dropped in line with the Kubernetes project's supported versions. Historically, the APIs in use have been stable and the Kubernetes agent has remained compatible with older version of Kubernetes, however we can make no guarantees of this in the future. + +We strongly recommend leaving automatic Kubernetes agent updates enabled and keeping your Kubernetes cluster up to date in line with the latest support version. If you must maintain support for older versions, you can configure how the Kubernetes agent is automatically updated with [machine policies](/docs/infrastructure/deployment-targets/machine-policies#configure-machine-updates). \ No newline at end of file diff --git a/src/pages/docs/octopus-cloud/frequently-asked-questions.md b/src/pages/docs/octopus-cloud/frequently-asked-questions.md index 14c620da1c..d151454331 100644 --- a/src/pages/docs/octopus-cloud/frequently-asked-questions.md +++ b/src/pages/docs/octopus-cloud/frequently-asked-questions.md @@ -185,12 +185,17 @@ We publish our [release updates](https://octopus.com/whatsnew) and provide a [re ### What is Octopus Cloud’s uptime SLO? -Octopus Cloud's monthly [uptime SLO](/docs/octopus-cloud/uptime-slo) is 99.5%, measured for the 95th percentile of Cloud instances. This target includes all downtime, including scheduled maintenance. +Octopus Cloud's monthly [uptime SLO](/docs/octopus-cloud/uptime-slo) is 99.99%, measured for the 95th percentile of paid Cloud instances. We calculate uptime as 100% of the month, less all unplanned downtime. ### How is uptime monitored? Our Cloud Platform team observes uptime and planned downtime durations as part of frequent health checks. We use a third-party vendor to assess availability every minute of the day. +### Where can I see Octopus Cloud uptime data? + +We publish Octopus Cloud’s [uptime track record](/docs/octopus-cloud/uptime-slo) monthly. + + ### How can we check Octopus Cloud's status? We publish Octopus Cloud's [operational status](https://status.octopus.com/). You can subscribe to status change emails from our [operational status page](https://status.octopus.com/). diff --git a/src/pages/docs/octopus-cloud/maintenance-window.md b/src/pages/docs/octopus-cloud/maintenance-window.md index 8ab54cfee6..b680ef57b4 100644 --- a/src/pages/docs/octopus-cloud/maintenance-window.md +++ b/src/pages/docs/octopus-cloud/maintenance-window.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-09-23 +modDate: 2024-11-27 title: Octopus Cloud Maintenance Window navOrder: 55 description: Details about the Octopus Cloud maintenance window @@ -13,18 +13,20 @@ Most of these won't affect your instance's availability, but occasionally, we mi :::div{.hint} We don’t need to perform actions on your instance daily, and most of our maintenance actions won’t take your instance offline. At most, you might notice a performance impact. The steps that require an outage typically only take a short time to complete. -::: - -At the time of publishing this (April 2024), our maintenance tasks require an average of 15 minutes downtime per week. +In the 4 months up to and including October 2024, Octopus Cloud instances: +- Had an average downtime of fewer than 8 minutes per week +- Experienced any downtime on average fewer than 2 days a week +::: ## You’re in control of the schedule + You get to choose a two-hour time slot for maintenance activities. Pick a time outside your regular business hours to minimize potential impact. You can adjust your maintenance window anytime, but make sure to do it before your current window begins to avoid interrupting ongoing maintenance tasks. - ## View or change your maintenance window + Setting up your maintenance window to suit your business needs is easy. Just follow these steps: 1. Log in to [Octopus.com](https://octopus.com). @@ -33,13 +35,12 @@ Setting up your maintenance window to suit your business needs is easy. Just fol 4. Scroll down to the **Maintenance window** section. 5. Select the time in UTC, providing a window of at least two hours and click **Submit**. - - ## During a Maintenance Window At the start of each window, an evaluation is performed to determine which maintenance operations need to be performed on each Octopus Cloud instance. There may be several operations that need to be performed in sequence on your instance during a single maintenance window. Those tasks include (but are not limited to) the following: + - Database maintenance. This involves reindexing and compacting your Octopus Cloud instance database so that it can perform at its best. - Performing any Octopus Server software upgrades. - Moving your instance to new infrastructure. These operations don't happen as often, but are required when we roll out improvements to the underlying infrastructure. @@ -56,6 +57,7 @@ Upgrading an instance is the primary cause of outages. The most noticeable impac ::: ## Taking your instance offline + If we need to take your instance offline to perform any maintenance: - Your instance will be given a few minutes to shut down cleanly. This will allow any in-progress tasks to complete. Any tasks still running at the end of the timeout will be abandoned. - A maintenance page will be displayed to users and any requests to the API will return a 503 Service Unavailable status code. @@ -65,5 +67,6 @@ If we need to take your instance offline to perform any maintenance: ## How we communicate maintenance windows + - **Routine maintenance:** During a regular maintenance window, a maintenance page will be displayed to users, and any requests to the API will return a 503 Service Unavailable status code - **Other maintenance:** There may be rare occasions outside of your normal maintenance window where we need to perform maintenance on your instance. Our Support team will contact you in these scenarios to coordinate the work. diff --git a/src/pages/docs/octopus-cloud/uptime-slo.md b/src/pages/docs/octopus-cloud/uptime-slo.md index 02a5c372bb..dcac9c0c55 100644 --- a/src/pages/docs/octopus-cloud/uptime-slo.md +++ b/src/pages/docs/octopus-cloud/uptime-slo.md @@ -1,21 +1,53 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-04-05 +modDate: 2024-12-02 title: Octopus Cloud Uptime SLO navOrder: 50 description: The uptime SLO for Octopus Cloud instances --- -Each Octopus Cloud customer has their own instance of the Octopus Server and can use [dynamic workers](/docs/infrastructure/workers/dynamic-worker-pools). As the name implies, these workers are assigned to a cloud instance dynamically and are spun up and down as required by the Deployment or Runbook executed. The following uptime SLO (service level objective), therefore, refers to the customer's Cloud instance. +Each Octopus Cloud customer has their own Octopus Server delivered as a highly available, scalable, secure SaaS application hosted for you. Octopus Deploy manages maintenance and resource provisioning for these hosted servers, letting our customers focus on happy deployments. -Each customer's instance may experience its own series of maintenance operations and reprovisioning for operational and upgrade reasons. Therefore the 95th percentile of monthly uptime is used as the basis for the Octopus Cloud uptime SLO. Operational downtime is, other than in exceptional circumstances, scheduled in the customer's [maintenance window](/docs/octopus-cloud/maintenance-window). All downtime (unplanned and planned) is used in the determination of the uptime SLO. +Octopus Cloud's monthly uptime SLO is 99.99%. -## Uptime SLO -Monthly uptime SLO: 99.5% +We calculate uptime as 100% of the month, less all unplanned downtime. -**“Monthly uptime of an instance”** means 100% minus the percentage of downtime (planned and unplanned) minutes out of the total minutes in a calendar month. +Planned maintenance is a key benefit of Octopus Cloud and is scheduled in advance, so we exclude it from our uptime SLO calculation. Other than in exceptional circumstances, planned maintenance occurs during the customer’s [maintenance window](/docs/octopus-cloud/maintenance-window). In the 4 months ending October 2024, planned maintenance averaged fewer than 8 minutes of downtime per week. -**“Downtime of an instance”** means a period of time where the customer instance is unavailable according to Octopus Deploy's internal and external monitoring systems. +## Uptime Track Record + +This table lists Octopus Cloud's monthly uptime statistics for the last 12 months. + +We list our achieved uptime percentage and the average amount of unplanned downtime for each month. We also show these data points including planned maintenance. + +| Month | Uptime % | Average weekly unplanned downtime | Uptime % incl. planned maintenance | Average weekly downtime incl. planned maintenance | +| :----- | ------: | ------: |------: | ------: | +| November 2024 | 100% | 2s | 99.8895% | 446s | +| October 2024 | 99.9973% | 5s | 99.917% | 309s | +| September 2024 | 99.9977% | 4s | 99.9165% | 313s | +| August 2024 | 99.9955% | 8s | 99.8978% | 447s | +| July 2024 | 99.9978% | 6s | 99.8602% | 616s | +| June 2024 | 99.9931% | 9s | 99.9196% | * 279s | +| May 2024 | 99.9976% | 11s |- | - | +| April 2024 | 99.9687% | 17s |- | - | +| March 2024 | 99.9914% | 10s |- | - | +| February 2024 | 100% | 2s |- | - | +| January 2024 | 99.9976% | 3s |- | - | +| December 2023 | 99.998% | 5s |- | - | + +\* We began capturing planned downtime metrics on June 10, 2024. + +### How we calculate uptime + +We calculate uptime as 100% minus the percentage of unplanned downtime seconds out of the total seconds in a calendar month. We measure uptime performance at the 95th percentile of all paid subscriptions (95% of customers experienced at minimum the listed uptime %). + +We exclude downtime that arises from planned or customer-requested maintenance from our uptime SLO calculation, but we measure and report it for transparency. +Some Octopus Cloud customers use [dynamic workers](/docs/infrastructure/workers/dynamic-worker-pools). As the name implies, these workers are dynamically assigned to a cloud instance and are spun up and down as required by the Deployment or Runbook executed. We exclude Dynamic Workers from our calculation of uptime. + +**“Downtime”** means a period where the customer instance is unavailable, according to Octopus Deploy's internal and external monitoring systems. + +**"Average weekly unplanned downtime"** is measured in seconds per week, as an arithmetic mean across all paid customers. It excludes planned maintenance and customer-requested maintenance. + +**"Average weekly downtime incl. planned maintenance"** is measured in seconds per week, as an arithmetic mean across all paid customers. It includes planned maintenance and customer-requested maintenance. -**Basis:** 95th percentile of the monthly average of paid subscriptions (95% of customers would be above 99.5%). Included in the downtime is any planned downtime during the customer's maintenance window. diff --git a/src/pages/docs/octopus-rest-api/calamari.md b/src/pages/docs/octopus-rest-api/calamari.md index 7abcc24c00..f9fd752200 100644 --- a/src/pages/docs/octopus-rest-api/calamari.md +++ b/src/pages/docs/octopus-rest-api/calamari.md @@ -1,26 +1,12 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-01-01 +modDate: 2024-12-11 title: Calamari -description: Calamari is the command-line tool invoked by Tentacle during a deployment. It knows how to extract and install NuGet packages, run the Deploy.ps1 etc. conventions, modify configuration files, and all the other things that happen during an deployment. navOrder: 70 +description: Calamari is the command-line tool invoked by Tentacle during a deployment. It knows how to deploy to Kubernetes, extract and install packages, run scripts and conventions, modify configuration files, and all the other things that happen during a deployment. --- -Prior to **Octopus 3.0**, Tentacles were responsible for performing deployment steps. Tentacles were *smart*. They knew how to transform configuration files, modify IIS, and much, much more. - -:::figure -![](/docs/octopus-rest-api/images/3278198.png) -::: - -There were a few cons to this architecture: - -- To add or modify features, a new version of the Tentacle service was required. And some folks have a *lot* of Tentacles. -- Deploying to a target which shouldn't require a Tentacle (e.g. an Azure WebSite), required that the deployment go via a Tentacle. -- This wouldn't support SSH targets. All SSH can do is to run commands and move files. All the logic and conventions for .NET configuration transforms, etc. would need to be pushed from the Octopus Server. - -And so the *communication channel* (Tentacle) was decoupled from the *deployment engine*: Calamari was born. - Calamari is an [open-source](https://github.com/OctopusDeploy/Calamari), console-application. It supports many commands, which are responsible for performing deployment-steps. For example: ```bash @@ -29,13 +15,15 @@ Calamari deploy-package --package MyPackage.nupkg --variables Variables.json Calamari has commands to support: +- Deploying to Kubernetes via Helm/Kustomize/Yaml. - Deploying NuGet packages. - Running scripts (PowerShell, ScriptCS, Bash, F#). -- Deploying packages to Azure targets (Cloud Services, WebApps). +- Deploying packages to Cloud services (WebApps, Functions etc.). - Various other deployment related activities. -Each deployment, if it is not already present, the latest version of the Calamari executable is pushed to wherever it needs to be. This may be to: +On each deployment, if it is not already present, the latest version of the Calamari executable is pushed to wherever it needs to be. This may be to: +- A Kubernetes Agent - A Tentacle. - Via SSH to a Linux machine. - A network-drive for Offline-Package-Drop targets. @@ -48,7 +36,7 @@ Deployments now proceed as follows: 3. The deployment target invokes Calamari to perform each deployment step. 4. Calamari performs the deployment step. -Now that Calamari is open-source, it might help answer any questions you had around what happens during a deployment. For example, did you ever wonder what order conventions run in when deploying a package? +Since Calamari is open-source, you can see the actions that are performed during a deployment. For example, did you ever wonder what order conventions run in when deploying a package? ```csharp var conventions = new List @@ -78,4 +66,4 @@ var conventions = new List }; ``` -Calamari is published under the Apache license, and we'll continue to work on it in the open. One of the benefits of this architecture is that you can [fork the project](https://github.com/OctopusDeploy/Calamari), make your own changes, and then tell your **Octopus 3.0** server to use your own Calamari package. +Calamari is published under the Apache license, you can find the source code [here](https://github.com/OctopusDeploy/Calamari). diff --git a/src/pages/docs/octopus-rest-api/cli/index.md b/src/pages/docs/octopus-rest-api/cli/index.md index a31ac25314..f9f82b9582 100644 --- a/src/pages/docs/octopus-rest-api/cli/index.md +++ b/src/pages/docs/octopus-rest-api/cli/index.md @@ -38,6 +38,9 @@ The Octopus CLI is built and maintained by the Octopus Deploy team, but it is al - **[octopus account gcp](/docs/octopus-rest-api/cli/octopus-account-gcp)**: Manage Google Cloud accounts. - **[octopus account gcp create](/docs/octopus-rest-api/cli/octopus-account-gcp-create)**: Create a Google Cloud account. - **[octopus account gcp list](/docs/octopus-rest-api/cli/octopus-account-gcp-list)**: List Google Cloud accounts. +- **[octopus account generic-oidc](/docs/octopus-rest-api/cli/octopus-account-generic-oidc)**: Manage Generic OpenID Connect accounts. +- **[octopus account generic-oidc create](/docs/octopus-rest-api/cli/octopus-account-generic-oidc-create)**: Create an Generic OpenID Connect account. +- **[octopus account generic-oidc list](/docs/octopus-rest-api/cli/octopus-account-generic-oidc-list)**: List Generic OpenID Connect accounts. - **[octopus account list](/docs/octopus-rest-api/cli/octopus-account-list)**: List accounts. - **[octopus account ssh](/docs/octopus-rest-api/cli/octopus-account-ssh)**: Manage SSH Key Pair accounts. - **[octopus account ssh create](/docs/octopus-rest-api/cli/octopus-account-ssh-create)**: Create a SSH Key Pair account. diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-create.mdx index dc29813470..238e75ea20 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-create.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account aws create description: Create an AWS account navOrder: 3 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx index 2b7743acb6..af7e1cc1e9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws-list.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account aws list description: List AWS accounts navOrder: 4 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws.mdx index 7684dbc52e..d7a4cad4b4 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-aws.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-aws.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account aws description: Manage AWS accounts navOrder: 2 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-create.mdx index e3c785623f..0d54fc0ff2 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-create.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account azure create description: Create an Azure subscription account navOrder: 6 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-list.mdx index 4f8f307ff4..ac21d1a36c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-list.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account azure list description: List Azure subscription accounts navOrder: 7 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create.mdx index af8a7f8591..34dcf62315 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-create.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account azure-oidc create description: Create an Azure OpenID Connect account navOrder: 9 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-list.mdx index 068b106d9e..3ef9ed0539 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc-list.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account azure-oidc list description: List Azure OpenID Connect accounts navOrder: 10 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc.mdx index d036d58321..fbbb15576a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure-oidc.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account azure-oidc description: Manage Azure OpenID Connect accounts navOrder: 8 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure.mdx index 331ac1daa6..d59de0919a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-azure.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-azure.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account azure description: Manage Azure subscription accounts navOrder: 5 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-create.mdx index 3ee480ef7b..d43b82343c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-create.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account create description: Create an account navOrder: 11 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-delete.mdx index 4b8c24e956..e012a53bf2 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-delete.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account delete description: Delete an account navOrder: 12 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-create.mdx index 7e45eb23e0..ca22333d82 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-create.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account gcp create description: Create a Google Cloud account navOrder: 14 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-list.mdx index 78aa3dc5d5..268b6635f3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp-list.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account gcp list description: List Google Cloud accounts navOrder: 15 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp.mdx index 097e9ba13a..ec5d7cff18 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-gcp.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account gcp description: Manage Google Cloud accounts navOrder: 13 diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-create.mdx new file mode 100644 index 0000000000..9841f5d5fa --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-create.mdx @@ -0,0 +1,49 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2024-12-05 +title: octopus account generic-oidc create +description: Create an Generic OpenID Connect account +navOrder: 17 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Create an Generic OpenID Connect account in Octopus Deploy + +``` +Usage: + octopus account generic-oidc create [flags] + +Aliases: + create, new + +Flags: + -d, -- string A summary explaining the use of the account to other users. + --audience string The audience claim for the federated credentials. Defaults to api://default + -D, --description-file file Read the description from file + -e, --environment stringArray The environments that are allowed to use this account + -E, --execution-subject-keys stringArray The subject keys used for a deployment or runbook + -n, --name string A short, memorable, unique name for this account. + + +Global Flags: + -h, --help Show help for a command + --no-prompt Disable prompting in interactive mode + -f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table") + -s, --space string Specify the space for operations + +``` + +## Examples + + + +``` +$ octopus account generic-oidc create + +``` + +## Learn more + +- [Octopus CLI](/docs/octopus-rest-api/cli) +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-list.mdx new file mode 100644 index 0000000000..ea1deab3c4 --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc-list.mdx @@ -0,0 +1,40 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2024-12-05 +title: octopus account generic-oidc list +description: List Generic OpenID Connect accounts +navOrder: 18 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +List Generic OpenID Connect accounts in Octopus Deploy + +``` +Usage: + octopus account generic-oidc list [flags] + +Aliases: + list, ls + +Global Flags: + -h, --help Show help for a command + --no-prompt Disable prompting in interactive mode + -f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table") + -s, --space string Specify the space for operations + +``` + +## Examples + + + +``` +$ octopus account generic-oidc list + +``` + +## Learn more + +- [Octopus CLI](/docs/octopus-rest-api/cli) +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc.mdx new file mode 100644 index 0000000000..a3da997453 --- /dev/null +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-generic-oidc.mdx @@ -0,0 +1,44 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2024-12-05 +title: octopus account generic-oidc +description: Manage Generic OpenID Connect accounts +navOrder: 16 +--- +import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; + +Manage Generic OpenID Connect accounts in Octopus Deploy + +``` +Usage: + octopus account generic-oidc [command] + +Available Commands: + create Create an Generic OpenID Connect account + help Help about any command + list List Generic OpenID Connect accounts + +Global Flags: + -h, --help Show help for a command + --no-prompt Disable prompting in interactive mode + -f, --output-format string Specify the output format for a command ("json", "table", or "basic") (default "table") + -s, --space string Specify the space for operations + + +Use "octopus account generic-oidc [command] --help" for more information about a command. +``` + +## Examples + + + +``` +$ octopus account generic-oidc list + +``` + +## Learn more + +- [Octopus CLI](/docs/octopus-rest-api/cli) +- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key) \ No newline at end of file diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-list.mdx index 155ee3690b..76a4c8ea7c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account list description: List accounts -navOrder: 16 +navOrder: 19 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-create.mdx index 3883a22d3f..1aef82471c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account ssh create description: Create a SSH Key Pair account -navOrder: 18 +navOrder: 21 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-list.mdx index 4880b861f0..fa44a82741 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account ssh list description: List SSH Key Pair accounts -navOrder: 19 +navOrder: 22 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh.mdx index ba9725bea6..c5b3850279 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-ssh.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account ssh description: Manage SSH Key Pair accounts -navOrder: 17 +navOrder: 20 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-token-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-token-create.mdx index b262922617..3173bec22b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-token-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-token-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account token create description: Create a Token account -navOrder: 21 +navOrder: 24 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-token-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-token-list.mdx index 08e2cc80c7..4141ff670c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-token-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-token-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account token list description: List Token accounts -navOrder: 22 +navOrder: 25 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-token.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-token.mdx index 0be4b7682d..dd01ba30a9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-token.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-token.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account token description: Manage Token accounts -navOrder: 20 +navOrder: 23 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-username-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-username-create.mdx index c59bc9cae2..0b2af4c3ca 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-username-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-username-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account username create description: Create a Username/Password account -navOrder: 24 +navOrder: 27 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-username-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-username-list.mdx index c2042d2bad..1b6defb71a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-username-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-username-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account username list description: List Username/Password accounts -navOrder: 25 +navOrder: 28 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account-username.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account-username.mdx index e3bc7199bf..e8742beead 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account-username.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account-username.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account username description: Manage Username/Password accounts -navOrder: 23 +navOrder: 26 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-account.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-account.mdx index d331631e94..21f7e9098f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-account.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-account.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus account description: Manage accounts navOrder: 1 @@ -21,6 +21,7 @@ Available Commands: create Create an account delete Delete an account gcp Manage Google Cloud accounts + generic-oidc Manage Generic OpenID Connect accounts help Help about any command list List accounts ssh Manage SSH Key Pair accounts diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-bulk-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-bulk-delete.mdx index e0bd3159db..4b8b0eb279 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-bulk-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-bulk-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus build-information bulk-delete description: Bulk delete build information -navOrder: 27 +navOrder: 30 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-delete.mdx index d563a2285e..3713eabc9d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus build-information delete description: Delete a build information -navOrder: 28 +navOrder: 31 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-list.mdx index 4e8de2e995..5391ba53e6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus build-information list description: List build information -navOrder: 29 +navOrder: 32 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-upload.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-upload.mdx index aa9757969e..11de7bbc58 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-upload.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-upload.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus build-information upload description: upload build information for one or more packages to Octopus Deploy -navOrder: 30 +navOrder: 33 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-view.mdx index b7d6b4f809..ec92c622dc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus build-information view description: View a build information -navOrder: 31 +navOrder: 34 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-build-information.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-build-information.mdx index 5b1b6a062a..10ce5b5764 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-build-information.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-build-information.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus build-information description: Manage build information -navOrder: 26 +navOrder: 29 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-channel-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-channel-create.mdx index 6fe0a12756..df2941c145 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-channel-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-channel-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus channel create description: Create a channel -navOrder: 33 +navOrder: 36 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-channel.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-channel.mdx index bdd1b52a55..441869acbd 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-channel.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-channel.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus channel description: Manage channels -navOrder: 32 +navOrder: 35 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx index 44390e3bb8..4892ccb670 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-config-get.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus config get description: Gets the value of config key for Octopus CLI -navOrder: 35 +navOrder: 38 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx index d154f2c723..eea7e3a59b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-config-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus config list description: List values from config file -navOrder: 36 +navOrder: 39 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx index 87e031d980..5ff7cdab74 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-config-set.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus config set description: Set will write the value for given key to Octopus CLI config file -navOrder: 37 +navOrder: 40 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-config.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-config.mdx index 36ee8d9eda..e87791f5d1 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-config.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-config.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus config description: Manage CLI configuration -navOrder: 34 +navOrder: 37 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-create.mdx index f3b36d0763..8ecfdfd418 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target azure-web-app create description: Create an Azure Web App deployment target -navOrder: 40 +navOrder: 43 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-list.mdx index e52d146af6..0eae4836ae 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target azure-web-app list description: List Azure Web App deployment targets -navOrder: 41 +navOrder: 44 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-view.mdx index a5990c673d..4d93c62f7e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target azure-web-app view description: View an Azure Web App deployment target -navOrder: 42 +navOrder: 45 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app.mdx index cd0468e575..382442d69f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-azure-web-app.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target azure-web-app description: Manage Azure Web App deployment targets -navOrder: 39 +navOrder: 42 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-create.mdx index 9ff4daf516..eb5a2b79b7 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target cloud-region create description: Create a Cloud Region deployment target -navOrder: 44 +navOrder: 47 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-list.mdx index babeb24d6d..b7120b84ba 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target cloud-region list description: List Cloud Region deployment targets -navOrder: 45 +navOrder: 48 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-view.mdx index d1aa170e71..7086b034fc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target cloud-region view description: View a Cloud Region deployment target -navOrder: 46 +navOrder: 49 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region.mdx index 65acb49266..35c2c04bec 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-cloud-region.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target cloud-region description: Manage Cloud Region deployment targets -navOrder: 43 +navOrder: 46 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-delete.mdx index 30b3fcb440..285a2f58db 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target delete description: Delete a deployment target -navOrder: 47 +navOrder: 50 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-create.mdx index 2df91ddb50..58193c06e1 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target kubernetes create description: Create a Kubernetes deployment target -navOrder: 49 +navOrder: 52 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-list.mdx index 97d4d0fb6d..61babdfefb 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target kubernetes list description: List Kubernetes deployment targets -navOrder: 50 +navOrder: 53 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-view.mdx index a9dfbb3f97..08c890dbbd 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target kubernetes view description: View a Kubernetes deployment target -navOrder: 51 +navOrder: 54 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes.mdx index 1048b66f57..611e0a3808 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-kubernetes.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target kubernetes description: Manage Kubernetes deployment targets -navOrder: 48 +navOrder: 51 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-list.mdx index b3c35e4dc3..5ea409a0ae 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target list description: List deployment targets -navOrder: 52 +navOrder: 55 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-create.mdx index 549ef97098..81f05f0da1 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target listening-tentacle create description: Create a Listening Tentacle deployment target -navOrder: 54 +navOrder: 57 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-list.mdx index 8d497e557b..89cb3b6d35 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target listening-tentacle list description: List Listening Tentacle deployment targets -navOrder: 55 +navOrder: 58 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-view.mdx index 61ffc4c73b..f9d77ca737 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target listening-tentacle view description: View a Listening Tentacle deployment target -navOrder: 56 +navOrder: 59 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle.mdx index 6c577ba203..89ca94578d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-listening-tentacle.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target listening-tentacle description: Manage Listening Tentacle deployment targets -navOrder: 53 +navOrder: 56 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-list.mdx index beefd26ab4..ee7f91cd55 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target polling-tentacle list description: List Polling Tentacle deployment targets -navOrder: 58 +navOrder: 61 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-view.mdx index 995b436aeb..a8136d0524 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target polling-tentacle view description: View a Polling Tentacle deployment target -navOrder: 59 +navOrder: 62 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle.mdx index 08a50ea517..c3b6f657ba 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-polling-tentacle.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target polling-tentacle description: Manage Polling Tentacle deployment targets -navOrder: 57 +navOrder: 60 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-create.mdx index 8d3a514f38..59fd940052 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target ssh create description: Create a SSH deployment target -navOrder: 61 +navOrder: 64 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-list.mdx index 65f2c2e6be..e67b32ae46 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target ssh list description: List SSH deployment targets -navOrder: 62 +navOrder: 65 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-view.mdx index 8310db9249..459f7241bc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target ssh view description: View a SSH deployment target -navOrder: 63 +navOrder: 66 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh.mdx index 1d77a8f892..d15805664a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-ssh.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target ssh description: Manage SSH deployment targets -navOrder: 60 +navOrder: 63 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-view.mdx index a4f593daac..3c4557ed95 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target view description: View a deployment target -navOrder: 64 +navOrder: 67 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target.mdx index ae1360c69a..bacff32506 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-deployment-target.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus deployment-target description: Manage deployment targets -navOrder: 38 +navOrder: 41 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-environment-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment-create.mdx index 9501d9970e..596c239fca 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-environment-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus environment create description: Create an environment -navOrder: 66 +navOrder: 69 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-environment-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment-delete.mdx index c28faf3995..ef1110bdf1 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-environment-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus environment delete description: Delete an environment -navOrder: 67 +navOrder: 70 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-environment-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment-list.mdx index 124baafa11..459823e97c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-environment-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus environment list description: List environments -navOrder: 68 +navOrder: 71 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-environment.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-environment.mdx index 167109ae3c..c74fd5bd2e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-environment.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-environment.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus environment description: Manage environments -navOrder: 65 +navOrder: 68 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-login.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-login.mdx index c5b55ed67c..2b6b44830f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-login.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-login.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus login description: Login to Octopus -navOrder: 69 +navOrder: 72 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; @@ -17,6 +17,7 @@ Usage: Flags: --api-key string The API key to login with if using API keys --id-token string The ID token from your OIDC provider to login with if using OIDC + --ignore-ssl-errors Whether to ignore SSL errors --server string The URL of the Octopus Server to login to --service-account-id string The ID of the service account to login with if using OIDC diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-logout.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-logout.mdx index 44cf20ae92..3308534f95 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-logout.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-logout.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus logout description: Logout of Octopus -navOrder: 70 +navOrder: 73 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-delete.mdx index ab1ace3d9c..3dc291d6c3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package delete description: Delete a package -navOrder: 72 +navOrder: 75 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-list.mdx index 4b89fce6c4..186b4ad46b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package list description: List packages -navOrder: 73 +navOrder: 76 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget-create.mdx index 7c0ef54c65..460c524034 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package nuget create description: Create nuget -navOrder: 75 +navOrder: 78 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget.mdx index 6a5b71cca6..1f5c6f3d6f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-nuget.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package nuget description: Package as NuPkg -navOrder: 74 +navOrder: 77 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-upload.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-upload.mdx index 537b455a8e..26598a33ad 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-upload.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-upload.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package upload description: Upload one or more packages to Octopus Deploy -navOrder: 76 +navOrder: 79 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-versions.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-versions.mdx index 38967976c4..20ee0795af 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-versions.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-versions.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package versions description: List versions of a package -navOrder: 77 +navOrder: 80 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-zip-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-zip-create.mdx index d74bdbac10..c0d49da35f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-zip-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-zip-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package zip create description: Create zip -navOrder: 79 +navOrder: 82 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package-zip.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package-zip.mdx index 13fdbc948b..a3c02cd141 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package-zip.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package-zip.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package zip description: Package as zip -navOrder: 78 +navOrder: 81 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-package.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-package.mdx index d50aa1df7d..344889feea 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-package.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-package.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus package description: Manage packages -navOrder: 71 +navOrder: 74 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-create.mdx index 5032201331..c07cae1804 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project branch create description: Create a Git branch for a project -navOrder: 82 +navOrder: 85 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-list.mdx index 540de8c47d..81e13427ff 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project branch list description: List project branches -navOrder: 83 +navOrder: 86 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch.mdx index 5c711f7155..c6f852a22d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-branch.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-branch.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project branch description: Manage project branches -navOrder: 81 +navOrder: 84 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-clone.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-clone.mdx index bdad6d0857..9ae3d9e227 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-clone.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-clone.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project clone description: Clone a project -navOrder: 84 +navOrder: 87 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-connect.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-connect.mdx index 482e2440bf..4ce17cf5c6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-connect.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-connect.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project connect description: Connect a tenant to a project -navOrder: 85 +navOrder: 88 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-convert.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-convert.mdx index 4b44fd651e..02bf6d709b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-convert.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-convert.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project convert description: Convert a project to use Config As Code -navOrder: 86 +navOrder: 89 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-create.mdx index 7407669838..084f8b9249 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project create description: Create a project -navOrder: 87 +navOrder: 90 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-delete.mdx index 2507fafeba..ae9f66d8e2 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project delete description: Delete a project -navOrder: 88 +navOrder: 91 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-disable.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-disable.mdx index 76db9b1c73..bfe3fd7bc8 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-disable.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-disable.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project disable description: Disable a project -navOrder: 89 +navOrder: 92 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-disconnect.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-disconnect.mdx index 7d85173054..ebf2669842 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-disconnect.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-disconnect.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project disconnect description: Disconnect a tenant from a project -navOrder: 90 +navOrder: 93 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-enable.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-enable.mdx index f8191ff08f..4d26f5ad01 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-enable.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-enable.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project enable description: Enable a project -navOrder: 91 +navOrder: 94 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-create.mdx index 3155b1502b..b40d409973 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project-group create description: Create a project group -navOrder: 103 +navOrder: 106 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-delete.mdx index 923410c0ce..a62b2b969a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project-group delete description: Delete a project group -navOrder: 104 +navOrder: 107 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-list.mdx index 77165f1e6f..c5fc96ddb8 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project-group list description: List project groups -navOrder: 105 +navOrder: 108 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-view.mdx index 3e1cfc7aeb..e9c32cb673 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project-group view description: View a project group -navOrder: 106 +navOrder: 109 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-group.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-group.mdx index 5e9d8f2252..08e8407450 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-group.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-group.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project-group description: Manage project groups -navOrder: 102 +navOrder: 105 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-list.mdx index a8418336cf..579fe65874 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project list description: List projects -navOrder: 92 +navOrder: 95 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-create.mdx index fc4a4f6b50..42433bc27d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project variables create description: Create a variable for a project -navOrder: 94 +navOrder: 97 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-delete.mdx index bff28fe19a..d163103287 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project variables delete description: Delete a project variable -navOrder: 95 +navOrder: 98 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-exclude.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-exclude.mdx index 3d62ac6a55..4068109fb0 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-exclude.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-exclude.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project variables exclude description: Exclude a variable set from a project -navOrder: 96 +navOrder: 99 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-include.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-include.mdx index ffe46bd007..0ab0ec2227 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-include.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-include.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project variables include description: Include a variable set in a project -navOrder: 97 +navOrder: 100 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-list.mdx index 1f06e62d7b..83ba5b9e3f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project variables list description: List project variables -navOrder: 98 +navOrder: 101 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-update.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-update.mdx index 98f7a4a760..20ce859fbe 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-update.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-update.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project variables update description: Update the value of a project variable -navOrder: 99 +navOrder: 102 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-view.mdx index e2eb74bc4f..70358c7bbf 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project variables view description: View all values of a project variable -navOrder: 100 +navOrder: 103 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables.mdx index 46ade23c8e..fd728e8526 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-variables.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-variables.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project variables description: Manage project variables -navOrder: 93 +navOrder: 96 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project-view.mdx index fd4ea3914e..f6b485ebe8 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project view description: View a project -navOrder: 101 +navOrder: 104 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-project.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-project.mdx index 0fe895bd44..296ca43dc0 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-project.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-project.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus project description: Manage projects -navOrder: 80 +navOrder: 83 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx index 4d8f9875fd..336d179a55 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus release create description: Create a release -navOrder: 108 +navOrder: 111 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-delete.mdx index 914bae4778..a7ddea9977 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus release delete description: Delete a release -navOrder: 109 +navOrder: 112 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-deploy.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-deploy.mdx index fc271fc894..5a59853bbc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-deploy.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-deploy.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus release deploy description: Deploy releases -navOrder: 110 +navOrder: 113 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-list.mdx index e1516f1513..7c21e221de 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus release list description: List releases -navOrder: 111 +navOrder: 114 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-allow.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-allow.mdx index 37ac6087e6..4222df0a50 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-allow.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-allow.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus release progression allow description: Allows a release to progress to the next phase. -navOrder: 113 +navOrder: 116 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-prevent.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-prevent.mdx index 4558f2cd85..1ca6923e62 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-prevent.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression-prevent.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus release progression prevent description: Prevents a release from progression to the next phase -navOrder: 114 +navOrder: 117 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression.mdx index 0c2c583776..63046eea64 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release-progression.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release-progression.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus release progression description: Manage progression of a release -navOrder: 112 +navOrder: 115 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-release.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-release.mdx index 35534c6117..4cf986bf64 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-release.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-release.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus release description: Manage releases -navOrder: 107 +navOrder: 110 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-delete.mdx index 2a07286160..59dd1cb371 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus runbook delete description: Delete a runbook -navOrder: 116 +navOrder: 119 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; @@ -19,6 +19,7 @@ Aliases: Flags: -y, --confirm Don't ask for confirmation before deleting the runbook. + --git-ref string Git reference to delete runbook for e.g. refs/heads/main. Only relevant for config-as-code projects where runbooks are stored in Git. -p, --project string Name or ID of the project to delete a runbook from -r, --runbook string Name or ID of the runbook to delete diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-list.mdx index f8c10d9a13..0004565f82 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus runbook list description: List runbooks -navOrder: 117 +navOrder: 120 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; @@ -19,6 +19,7 @@ Aliases: Flags: -q, --filter string filter runbooks to match only ones with a name containing the given string + --git-ref string Git reference to list runbooks for e.g. refs/heads/main. Only relevant for config-as-code projects where runbooks are stored in Git. --limit int32 limit the maximum number of results that will be returned -p, --project string Name or ID of the project to list runbooks for diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx index ae58ec8ba8..6200679c1d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-run.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus runbook run description: Run runbooks in Octopus Deploy -navOrder: 118 +navOrder: 121 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; @@ -29,6 +29,16 @@ Flags: --force-package-download Force re-download of packages --run-target stringArray Run on this target (can be specified multiple times) --exclude-run-target stringArray Run on targets except for this (can be specified multiple times) + --git-ref string Git Reference e.g. refs/heads/main. Only relevant for config-as-code projects where runbooks are stored in Git. + --package-version string Default version to use for all packages. Only relevant for config-as-code projects where runbooks are stored in Git. + --package stringArray Version specification for a specific package. + Format as {package}:{version}, {step}:{version} or {package-ref-name}:{packageOrStep}:{version} + You may specify this multiple times. + Only relevant for config-as-code projects where runbooks are stored in Git. + --git-resource stringArray Git reference for a specific Git resource. + Format as {step}:{git-ref}, {step}:{git-resource-name}:{git-ref} + You may specify this multiple times. + Only relevant for config-as-code projects where runbooks are stored in Git. Global Flags: diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-list.mdx index 792d585fed..bf078149ed 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus runbook snapshot list description: List runbook snapshots -navOrder: 120 +navOrder: 123 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot.mdx index f817fb645c..be01a014c6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook-snapshot.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus runbook snapshot description: Manage runbook snapshots -navOrder: 119 +navOrder: 122 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-runbook.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-runbook.mdx index 293e6210e7..2b4d9e8228 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-runbook.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-runbook.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus runbook description: Manage runbooks -navOrder: 115 +navOrder: 118 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space-create.mdx index 7bd48d1283..327b2d42fb 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus space create description: Create a space -navOrder: 122 +navOrder: 125 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space-delete.mdx index 7dc6f34174..fbb0ad70e7 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus space delete description: Delete a space -navOrder: 123 +navOrder: 126 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space-list.mdx index d0aa2313cb..f00192120a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus space list description: List spaces -navOrder: 124 +navOrder: 127 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space-view.mdx index 59c5bfb455..e420ecb36c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus space view description: View a space -navOrder: 125 +navOrder: 128 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-space.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-space.mdx index b852e11f9d..80ba685be3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-space.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-space.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus space description: Manage spaces -navOrder: 121 +navOrder: 124 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-task-wait.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-task-wait.mdx index e1e1fb6109..72650f6db0 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-task-wait.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-task-wait.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus task wait description: Wait for task(s) to finish -navOrder: 127 +navOrder: 130 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-task.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-task.mdx index eeff824af6..190dfc0e14 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-task.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-task.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus task description: Manage tasks -navOrder: 126 +navOrder: 129 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-clone.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-clone.mdx index 09b3357ac5..7b613fbdb9 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-clone.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-clone.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant clone description: Clone a tenant -navOrder: 129 +navOrder: 132 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-connect.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-connect.mdx index 7acc4efb88..5d3cca2c1c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-connect.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-connect.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant connect description: Connect a tenant to a project -navOrder: 130 +navOrder: 133 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-create.mdx index 67c295274f..47caf8ca8a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant create description: Create a tenant -navOrder: 131 +navOrder: 134 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-delete.mdx index 7792a501d1..db0d0105a1 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant delete description: Delete a tenant -navOrder: 132 +navOrder: 135 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disable.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disable.mdx index 29ae39ada8..0680490354 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disable.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disable.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant disable description: Disable a tenant -navOrder: 133 +navOrder: 136 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disconnect.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disconnect.mdx index 3abcc02d5d..0af9355f93 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disconnect.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-disconnect.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant disconnect description: Disconnect a tenant from a project -navOrder: 134 +navOrder: 137 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-enable.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-enable.mdx index e9e5b30248..b462f26cc6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-enable.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-enable.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant enable description: Enable a tenant -navOrder: 135 +navOrder: 138 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-list.mdx index a01448e689..d024ac6d48 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant list description: List tenants -navOrder: 136 +navOrder: 139 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-tag.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-tag.mdx index b9589c5482..5e59c4a013 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-tag.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-tag.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant tag description: Override tags for a tenant -navOrder: 137 +navOrder: 140 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-list.mdx index b537e94c8a..4d0f934f8b 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant variables list description: List tenant variables -navOrder: 139 +navOrder: 142 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-update.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-update.mdx index 2a16253a29..95dc47239e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-update.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables-update.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant variables update description: Update the value of a tenant variable -navOrder: 140 +navOrder: 143 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables.mdx index b27011c452..6e09691a6a 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-variables.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant variables description: Manage tenant variables -navOrder: 138 +navOrder: 141 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-view.mdx index 9e8ae14bd8..9805d5de8d 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant view description: View a tenant -navOrder: 141 +navOrder: 144 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-tenant.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-tenant.mdx index 32e7457474..0342c7d59e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-tenant.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-tenant.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus tenant description: Manage tenants -navOrder: 128 +navOrder: 131 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-user-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-user-delete.mdx index ab9b896c6e..f317c5e169 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-user-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-user-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus user delete description: Delete a user -navOrder: 143 +navOrder: 146 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-user-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-user-list.mdx index a6b8782e6a..0dc0f5adb2 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-user-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-user-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus user list description: List users -navOrder: 144 +navOrder: 147 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-user.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-user.mdx index 8b60b43a30..eecd785230 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-user.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-user.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus user description: Manage users -navOrder: 142 +navOrder: 145 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-delete.mdx index f28abad3af..5a838880b0 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker delete description: Delete a worker -navOrder: 146 +navOrder: 149 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-list.mdx index db19faa105..cc9984f373 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker list description: List workers -navOrder: 147 +navOrder: 150 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-create.mdx index a347e761d5..d7427ed730 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker listening-tentacle create description: Create a listening tentacle worker -navOrder: 149 +navOrder: 152 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-list.mdx index ca59bb06a7..4d0e6bd744 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker listening-tentacle list description: List Listening Tentacle workers -navOrder: 150 +navOrder: 153 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-view.mdx index d826ad07e2..d2d855de79 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker listening-tentacle view description: View a Listening Tentacle worker -navOrder: 151 +navOrder: 154 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle.mdx index 33fa2d15a0..d668271df6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-listening-tentacle.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker listening-tentacle description: Manage Listening Tentacle workers -navOrder: 148 +navOrder: 151 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-list.mdx index 1e44fc4279..5df0fd02a3 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker polling-tentacle list description: List Polling Tentacle workers -navOrder: 153 +navOrder: 156 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-view.mdx index 6930ae2177..22359d0ed0 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker polling-tentacle view description: View a Polling Tentacle worker -navOrder: 154 +navOrder: 157 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle.mdx index 166421f6f6..e2b4ff6558 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-polling-tentacle.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker polling-tentacle description: Manage Polling Tentacle workers -navOrder: 152 +navOrder: 155 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-delete.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-delete.mdx index 2b58bd3e73..82bcff74ff 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-delete.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-delete.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool delete description: Delete a worker pool -navOrder: 161 +navOrder: 164 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-create.mdx index 0e3747d5f0..ef958d759c 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool dynamic create description: Create a dynamic worker pool -navOrder: 163 +navOrder: 166 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-view.mdx index f260b60e4d..2b28695897 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool dynamic view description: View a dynamic worker pool -navOrder: 164 +navOrder: 167 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic.mdx index f735ba8fd4..8d04fa5a93 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-dynamic.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool dynamic description: Manage dynamic worker pools -navOrder: 162 +navOrder: 165 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-list.mdx index 1e4c1eb8c4..0ae26aaa36 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool list description: List worker pools -navOrder: 165 +navOrder: 168 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-create.mdx index 0777ab10a1..184e0d37f8 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool static create description: Create a static worker pool -navOrder: 167 +navOrder: 170 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-view.mdx index 07c99c96fa..57a9f10833 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool static view description: View a static worker pool -navOrder: 168 +navOrder: 171 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static.mdx index 1d547e6608..7560c6f131 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-static.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool static description: Manage static worker pools -navOrder: 166 +navOrder: 169 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-view.mdx index 633bed4368..172e462c7e 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool view description: View a worker pool -navOrder: 169 +navOrder: 172 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool.mdx index 7d05c440b0..70830c3097 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-pool.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker-pool description: Manage worker pools -navOrder: 160 +navOrder: 163 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-create.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-create.mdx index bcf1c0de7c..3509570cc6 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-create.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-create.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker ssh create description: Create a SSH worker -navOrder: 156 +navOrder: 159 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-list.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-list.mdx index fb8e8beecf..60132d469f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-list.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-list.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker ssh list description: List SSH workers -navOrder: 157 +navOrder: 160 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-view.mdx index 5615024166..8ae629fd4f 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker ssh view description: View a SSH worker -navOrder: 158 +navOrder: 161 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh.mdx index 8d3bf42b08..abe633ea70 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-ssh.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker ssh description: Manage SSH workers -navOrder: 155 +navOrder: 158 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker-view.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker-view.mdx index 76de4089eb..65356963cc 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker-view.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker-view.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker view description: View a worker -navOrder: 159 +navOrder: 162 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus-worker.mdx b/src/pages/docs/octopus-rest-api/cli/octopus-worker.mdx index 6917d47044..0b2c8efbad 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus-worker.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus-worker.mdx @@ -1,10 +1,10 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus worker description: Manage workers -navOrder: 145 +navOrder: 148 --- import SamplesInstance from 'src/shared-content/samples/samples-instance.include.md'; diff --git a/src/pages/docs/octopus-rest-api/cli/octopus.mdx b/src/pages/docs/octopus-rest-api/cli/octopus.mdx index a408dfe7d8..cc73cde365 100644 --- a/src/pages/docs/octopus-rest-api/cli/octopus.mdx +++ b/src/pages/docs/octopus-rest-api/cli/octopus.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-11-20 +modDate: 2024-12-05 title: octopus description: Octopus Deploy CLI navOrder: 0 diff --git a/src/pages/docs/octopus-rest-api/examples/deployment-targets/enable-disable-machine.mdx b/src/pages/docs/octopus-rest-api/examples/deployment-targets/enable-disable-machine.mdx index ed1b4c5fbd..a819f16360 100644 --- a/src/pages/docs/octopus-rest-api/examples/deployment-targets/enable-disable-machine.mdx +++ b/src/pages/docs/octopus-rest-api/examples/deployment-targets/enable-disable-machine.mdx @@ -2,7 +2,7 @@ layout: src/layouts/Default.astro pubDate: 2023-01-01 modDate: 2023-01-01 -title: Enable/disable machine +title: Deactivate machines description: An example script that enables or disables a machine in Octopus. --- import EnableDisableMachineScripts from 'src/shared-content/scripts/enable-disable-machine-scripts.include.md'; diff --git a/src/pages/docs/octopus-rest-api/examples/feeds/synchronize-packages.mdx b/src/pages/docs/octopus-rest-api/examples/feeds/synchronize-packages.mdx index 8226a13789..7a74b20513 100644 --- a/src/pages/docs/octopus-rest-api/examples/feeds/synchronize-packages.mdx +++ b/src/pages/docs/octopus-rest-api/examples/feeds/synchronize-packages.mdx @@ -50,7 +50,7 @@ Provide values for: This example takes packages specified in the `packages.json` file, finding all versions found in the source Octopus instance which have a published date greater than `2021-02-11` and synchronizing them with the destination Octopus instance: ```powershell -/SyncPackages.ps1 ` +./SyncPackages.ps1 ` -VersionSelection AllVersions ` -PackageListFilePath "packages.json" ` -SourceUrl https://source.octopus.app ` diff --git a/src/pages/docs/octopus-rest-api/examples/projects/enable-disable-project.mdx b/src/pages/docs/octopus-rest-api/examples/projects/enable-disable-project.mdx index 82e8ec2f24..766adaa01d 100644 --- a/src/pages/docs/octopus-rest-api/examples/projects/enable-disable-project.mdx +++ b/src/pages/docs/octopus-rest-api/examples/projects/enable-disable-project.mdx @@ -2,7 +2,7 @@ layout: src/layouts/Default.astro pubDate: 2023-01-01 modDate: 2023-01-01 -title: Enable/disable project +title: Deactivate projects description: An example script that enables or disables a project in Octopus. --- import EnableDisableProjectScripts from 'src/shared-content/scripts/enable-disable-project-scripts.include.md'; diff --git a/src/pages/docs/octopus-rest-api/examples/tenants/deactivate-tenant.mdx b/src/pages/docs/octopus-rest-api/examples/tenants/deactivate-tenant.mdx new file mode 100644 index 0000000000..89cb2bda31 --- /dev/null +++ b/src/pages/docs/octopus-rest-api/examples/tenants/deactivate-tenant.mdx @@ -0,0 +1,27 @@ +--- +layout: src/layouts/Default.astro +pubDate: 2024-11-18 +modDate: 2024-11-18 +title: Deactivate tenants +description: An example script that activates or deactivates a tenant in Octopus. +--- +import DeactivateTenantScripts from 'src/shared-content/scripts/deactivate-tenant-scripts.include.md'; + +In 2025.1 Octopus has added support for deactivating tenants. Inactive tenants do not allow deployments or runbook runs but are able to be edited. They are also removed from license calculations allowing you to effectively archive unused tenants and re-enable them in the future. +Inactive tenants are highlighted with grayed out text and are not available for selection on the deployment or runbook run pages. If deployments are created for inactive tenants via the API or CLI an exception will be thrown. + +This script demonstrates how to programmatically deactivate a tenant. + +## Usage + +Provide values for the following: + +- Octopus URL +- Octopus API Key +- Name of the space to use +- Name of the tenant +- Boolean value for enabled + +## Script + + \ No newline at end of file diff --git a/src/pages/docs/octopus-rest-api/examples/tenants/index.md b/src/pages/docs/octopus-rest-api/examples/tenants/index.md index 0ded7f5a61..b669f7a920 100644 --- a/src/pages/docs/octopus-rest-api/examples/tenants/index.md +++ b/src/pages/docs/octopus-rest-api/examples/tenants/index.md @@ -10,4 +10,5 @@ hideInThisSectionHeader: true You can use the REST API to create and manage Server tasks in Octopus. Typical tasks might include: - [Create a tenant](/docs/octopus-rest-api/examples/tenants/create-tenant) -- [Update tenant variables](/docs/octopus-rest-api/examples/tenants/update-tenant-variable) \ No newline at end of file +- [Update tenant variables](/docs/octopus-rest-api/examples/tenants/update-tenant-variable) +- [Deactivate tenants](/docs/octopus-rest-api/examples/tenants/deactivate-tenant) \ No newline at end of file diff --git a/src/pages/docs/octopus-rest-api/octopus-cli/create-release.md b/src/pages/docs/octopus-rest-api/octopus-cli/create-release.md index dd25f059ce..18d37a68f4 100644 --- a/src/pages/docs/octopus-rest-api/octopus-cli/create-release.md +++ b/src/pages/docs/octopus-rest-api/octopus-cli/create-release.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-09-12 +modDate: 2024-12-16 title: Create release description: Using the Octopus CLI to create releases. navOrder: 100 @@ -44,13 +44,6 @@ Release creation: an asterisk. An asterisk will be assumed for StepName, PackageID, or PackageName if they are omitted. - Can be specified multiple times. - --git-resource=VALUE [Optional] Git reference to use for a Git resource - in the release. Format: StepName:GitRef or - StepName:GitResourceName:GitRef. GitRef can be - replaced with an asterisk. An asterisk means - use the step-defined default branch. - Can be specified multiple times. --packagesFolder=VALUE [Optional] A folder containing NuGet packages from which we should get versions. --releaseNotes=VALUE [Optional] Release Notes for the new release. diff --git a/src/pages/docs/octopus-rest-api/octopus-cli/deploy-release.md b/src/pages/docs/octopus-rest-api/octopus-cli/deploy-release.md index 768f098f94..228ff18fa7 100644 --- a/src/pages/docs/octopus-rest-api/octopus-cli/deploy-release.md +++ b/src/pages/docs/octopus-rest-api/octopus-cli/deploy-release.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-06-25 +modDate: 2024-12-16 title: Deploy release description: Using the Octopus CLI to deploy releases. navOrder: 100 @@ -24,7 +24,7 @@ Deployment: --waitForDeployment [Optional] Whether to wait synchronously for deployment to finish. --deploymentTimeout=VALUE - [Optional] Specifies maximum time (time span + [Optional] Specifies maximum time (timespan format) that the console session will wait for the deployment to finish(default 00:10:00). This will not stop the deployment. Requires -- @@ -33,7 +33,7 @@ Deployment: the deployment timeout is reached (flag, default false). --deploymentCheckSleepCycle=VALUE - [Optional] Specifies how much time (time span + [Optional] Specifies how much time (timespan format) should elapse between deployment status checks (default 00:00:10). --guidedFailure=VALUE [Optional] Whether to use guided failure mode. diff --git a/src/pages/docs/packaging-applications/build-servers/github-actions.md b/src/pages/docs/packaging-applications/build-servers/github-actions.md index 1f209854b6..71eeb78a27 100644 --- a/src/pages/docs/packaging-applications/build-servers/github-actions.md +++ b/src/pages/docs/packaging-applications/build-servers/github-actions.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-09-27 +modDate: 2024-11-21 title: GitHub Actions description: Integrating Octopus Deploy into your GitHub Action workflows icon: fa-brands fa-github @@ -29,7 +29,7 @@ Octopus Deploy provides GitHub Actions which enable you to: ## Getting started -Octopus Deploy GitHub Actions can be easily incorporated into your own GitHub Action workflows by including them as steps in your workflow YAML. Here is a simple GitHub Action workflow YAML to get you started. +Octopus Deploy GitHub Actions can be easily incorporated into your own GitHub Action workflows by including them as steps in your workflow YAML. Here is a simple workflow YAML to get you started. ### Example workflow - Create and deploy a release ```yaml @@ -88,8 +88,6 @@ jobs: variables: | Flip: Bling Fizz: Buzz - git_ref: ${{ github.ref }} - git_commit: ${{ github.sha }} ``` ### ✍️ Environment variables @@ -109,10 +107,10 @@ jobs: | `release_number` | The number for the new Release. If omitted, Octopus Deploy will generate a Release number. | | `environments` | A list of Environments in Octopus Deploy in which to run (i.e. Dev, Test, Prod). Add each environment on a new line. | | `variables` | A list of Variables to use in the Deployment in `key: value` format. Add each variable on a new line. | -| `git_ref` | The Git branch from which to source the project code. Required for Projects using version control in Octopus. | -| `git_commit` | The Git commit from which to source the project code. Required for Projects using version control in Octopus. | +| `git_ref` | The Git branch from which to source the project code. Required for Projects using version control in Octopus. The example above sources this value from the workflow's [contextual information.](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context) | +| `git_commit` | The Git commit from which to source the project code. Required for Projects using version control in Octopus. The example above sources this value from the workflow's [contextual information.](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context) | | `server` | The base URL hosting Octopus Deploy (i.e. `https://octopus.example.app`). It is strongly recommended that this value retrieved from a [GitHub secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions). | -| `service_account_id` | The id of the service account you wish to login as. | +| `service_account_id` | The id of the OIDC service account you wish to login as. Service accounts can be viewed and created on the Octopus app under 'Users' on the configuration menu. | ## Handling packages @@ -207,7 +205,7 @@ If your Octopus Server is not accessible over the internet, you can connect to i ## Sequencing tasks -It can be useful to run multiple Octopus Deploy GitHub Actions in sequence as part of a larger workflow. To do this, simply include each Octopus Action as a step within a single job. +It can be useful to run multiple Octopus Deploy GitHub Actions in sequence as part of a workflow. To do this, simply include each Octopus Action as a step within a single job. If you need to run sequential actions in separate jobs, you can also configure your jobs to run sequentially by [defining prerequisite jobs](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-jobs-in-a-workflow#defining-prerequisite-jobs). diff --git a/src/pages/docs/packaging-applications/package-repositories/docker-registries/index.md b/src/pages/docs/packaging-applications/package-repositories/docker-registries/index.md index 6be40f029c..54674077f2 100644 --- a/src/pages/docs/packaging-applications/package-repositories/docker-registries/index.md +++ b/src/pages/docs/packaging-applications/package-repositories/docker-registries/index.md @@ -54,7 +54,7 @@ When you create a release in Octopus, you need to choose the "version" of the Im :::div{.hint} **Container images are downloaded directly by the Deployment Target or Worker** -Octopus Deploy does not currently support functionality to push Images from the Octopus Server to the deployment targets in the same way that it does with other [supported packages](/docs/packaging-applications/#supported-formats). That being said, the [layered architecture of Images](https://docs.docker.com/engine/userguide/storagedriver/imagesandcontainers) allows your deployment targets to retrieve only those pieces that have changed from previous versions that are locally available, which is behavior built in to the Docker Engine. +Octopus Deploy does not currently support functionality to push Images from the Octopus Server to the deployment targets in the same way that it does with other [supported packages](/docs/packaging-applications/#supported-formats). That being said, the layered architecture of images allows your deployment targets to retrieve only those pieces that have changed from previous versions that are locally available, which is behavior built in to the Docker Engine. ::: ## Private registry {#private-registry} diff --git a/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md b/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md index ba023f4d4b..4cca548254 100644 --- a/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md +++ b/src/pages/docs/packaging-applications/package-repositories/guides/container-registries/docker-hub.md @@ -16,7 +16,7 @@ From September 5th 2022, the Docker Hub Registry is [deprecating v1 endpoints](h **DockerHub Private Repository Limitations** By design, Docker Hub **does not support** [searching for private repositories](https://docs.docker.com/docker-hub/#/explore-repositories), even with valid credentials. Additionally, while you will be able to search for a non-official repository, Docker Hub *will not return any tags for unofficial images*. If you are using an unofficial image, you will be able to select this when configuring your run step, but you will need to manually enter the version that you wish to deploy. So long as it exists in the registry, your Docker Engine will be able to pull it down. -The Docker Hub API endpoint [https://index.docker.io/v1](https://index.docker.io/v1) provides access to repositories with different levels of access +The Docker Hub API endpoint `https://index.docker.io/v1` provides access to repositories with different levels of access | Repository | Shows In Search | Lists Tags | | --- | --- | --- | @@ -33,7 +33,7 @@ To use the Docker Hub registry in Octopus Deploy, create an external feed with t - **Feed Type:** Docker Container Registry - **Name:** DockerHub (or anything else that makes sense to you) -- **URL:** [https://index.docker.io](https://index.docker.io) +- **URL:** `https://index.docker.io` - **Registry Path:** *leave blank* - **Credentials:** Username and Password (Login for your DockerHub account, this is required for accessing public repositories) diff --git a/src/pages/docs/projects/built-in-step-templates/manual-intervention-and-approvals.md b/src/pages/docs/projects/built-in-step-templates/manual-intervention-and-approvals.md index 9b46cac378..e3fd6adea0 100644 --- a/src/pages/docs/projects/built-in-step-templates/manual-intervention-and-approvals.md +++ b/src/pages/docs/projects/built-in-step-templates/manual-intervention-and-approvals.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-08-27 +modDate: 2024-12-02 title: Manual intervention and approval step icon: fa-solid fa-check description: Manual intervention and approvals allow a human to review, approve, or sign off on deployments. @@ -17,6 +17,12 @@ While fully automated deployment is a great goal, there are times when a human n The **Manual intervention step** is a step that can be added to deployment processes to pause the deployment to wait for a member of a specified team to either allow the deployment to proceed or to be aborted. +:::div{.hint} +Manual interventions result in either a success or failure outcome based on the user’s input. Subsequent steps evaluate this outcome according to their run conditions. By default, the run condition is set to "Success: only run when previous steps succeed." This means manual interventions can prevent these steps from executing, causing the deployment to fail. + +However, if "Always Run" is selected for subsequent steps, they will proceed regardless of the manual intervention outcome. For steps with the condition "Variable: only run when the variable expression is true," the manual intervention's outcome must be included in the variable expression to determine whether the step should run. +::: + [Getting Started - Manual Intervention](https://www.youtube.com/watch?v=ePQjCClGfZQ) ## Add a manual intervention step @@ -73,6 +79,17 @@ When a manual step is completed, details of the interruption are saved as variab | `Octopus.Action[Step Name].Output.Manual.ResponsibleUser.DisplayName` | The display name of the user who submitted the interruption form | *Jamie Jones* | | `Octopus.Action[Step Name].Output.Manual.ResponsibleUser.EmailAddress` | The email address of the user who submitted the interruption form | *jamie.jones@example.com* | +## Evaluating manual intervention output in following steps +If you want to control subsequent steps based on the outcome of the manual intervention step, you can use "Variable: only run when the variable expression is true", and use the `Octopus.Deployment.Error` variable as the conditional. For example: + +``` +#{unless Octopus.Deployment.Error}RESULT IF MANUAL INTERVENTION PROCEEDED{/unless} +``` +or +``` +#{if Octopus.Deployment.Error}RESULT IF MANUAL INTERVENTION WAS ABORTED{/if} +``` + ## Learn more - [Advanced manual approvals](/docs/deployments/databases/common-patterns/manual-approvals) diff --git a/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md b/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md index 9b1e1fe9e7..4f4cdc8103 100644 --- a/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md +++ b/src/pages/docs/projects/steps/configuration-features/substitute-variables-in-templates.md @@ -26,8 +26,8 @@ The following example shows you how to use the Substitute Variables in Templates | Variable Name | Value | Scope | | ----------------------- | --------------- | -------- | -| LoginURL | https://test.example.com/login | Test | -| LoginURL | https://example.com/login | Production | +| LoginURL | `https://test.example.com/login` | Test | +| LoginURL | `https://example.com/login` | Production | 2. Include the loginURL variable in the app you're deploying, by adding the variable `#{LoginURL}`. For instance: @@ -77,7 +77,7 @@ If you include a configuration file that you are also doing a [transformation](/ By default **warnings** will be treated as **errors** when replacing variables in files using this feature. To override this behavior, set the variable **Octopus.Action.Package.IgnoreVariableReplacementErrors** to **True** in your project. By doing this, warnings will be treated as such and the deployment will not be marked as failed. ::: -## Examples {#SubstituteVariablesinFiles-SomeExamples} +## Examples {#SubstituteVariablesInFiles-SomeExamples} ### Swapping design elements diff --git a/src/pages/docs/releases/issue-tracking/jira.md b/src/pages/docs/releases/issue-tracking/jira.md index efb6d5ece6..74ebd97813 100644 --- a/src/pages/docs/releases/issue-tracking/jira.md +++ b/src/pages/docs/releases/issue-tracking/jira.md @@ -91,7 +91,7 @@ This process is for Jira Cloud, if you are using Jira Server, see [Connecting Ji In the Octopus Web Portal, navigate to **Configuration ➜ Settings ➜ Jira Integration** and copy the following values from the Jira App configuration page: - - **Jira Base URL**. This tells Octopus where your Jira instance is located and enables Octopus to render the links back to Jira issues. i.e., https://your-jira-instance.atlassian.net. + - **Jira Base URL**. This tells Octopus where your Jira instance is located and enables Octopus to render the links back to Jira issues. i.e., `https://your-jira-instance.atlassian.net`. - **Jira Connect App Password**. Ensure the **Is Enabled** property is set. @@ -111,7 +111,7 @@ This process is for Jira Cloud, if you are using Jira Server, see [Connecting Ji 4. Ensure the Octopus Server URL is set. - If you are using Octopus Cloud, this value is automatically set for you. If you are not using Octopus Cloud, navigate to the **Configuration ➜ Nodes** page and ensure you have set the Server URI field to your Octopus Server's base URL. i.e., https://my-company.octopus.app or https://my-company-internal-name + If you are using Octopus Cloud, this value is automatically set for you. If you are not using Octopus Cloud, navigate to the **Configuration ➜ Nodes** page and ensure you have set the Server URI field to your Octopus Server's base URL. i.e., `https://my-company.octopus.app` or `https://my-company-internal-name` Note: Octopus passes this value to Jira so it can build hyperlinks back to the deployments from the Jira UI. It never actually tries to connect to this URL itself. 5. Configure the Octopus plugin in Jira. diff --git a/src/pages/docs/security/authentication/googleapps-authentication.mdx b/src/pages/docs/security/authentication/googleapps-authentication.mdx index 8a0a634ef9..a6c3587e4f 100644 --- a/src/pages/docs/security/authentication/googleapps-authentication.mdx +++ b/src/pages/docs/security/authentication/googleapps-authentication.mdx @@ -1,14 +1,14 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-01-01 +modDate: 2024-12-10 title: Google Workspace authentication -description: Octopus Deploy can use GOogle Workspace authentication to identify users. +description: Octopus Deploy can use Google Workspace authentication to identify users. navOrder: 15 --- import AdminUser from 'src/shared-content/installation/admin-user.include.md'; -To use Google Workspace authentication with Octopus Server, Google Workspace must be configured to trust Octopus - by setting it up as an app. This section covers the details on how to configure the app. +To use Google Workspace authentication with Octopus Server, Google Workspace must be configured to trust Octopus by setting it up as an app. This section covers the details of configuring the app. ## Configure Google Workspace @@ -23,22 +23,22 @@ Once you have an account, log in to [https://console.developers.google.com](http 3. Click the **Configure consent screen** button. 4. Select the User Type **Internal** and click **Create**. 5. Fill out the **App information**, including a descriptive **App name** such as Octopus Server or Octopus Cloud, and select an appropriate **User support email**. -6. Fill out the the **App logo** details, upload a logo to make it easy to identify the application. You can download the Octopus logo [here](https://octopus.com/images/company/Logo-Blue_140px_rgb.png "width=500"). +6. Fill out the **App logo** details and upload a logo to make it easy to identify the application. You can download the Octopus logo [here](https://octopus.com/images/company/Logo-Blue_140px_rgb.png). 7. Fill out the **App domain** information, providing `https://octopus.com` as the **Application home page**, `https://octopus.com/privacy` as the **Application privacy policy link** and `https://octopus.com/legal/customer-agreement` as the **Application Terms of Service link**. Add the Top Level Domain of your Octopus instance to the **Authorized domains** list. If you are setting Google Workspaces up for **Octopus Cloud** this will be `octopus.app` and `octopus.com`. 8. Fill out the **Developer contact information**. 9. Click **Save and continue**. 10. On the **Scopes** screen, click **Save and continue**. 11. Click **Back to dashboard** 12. Select **Credentials** tab and click **Create credentials**, selecting **Create Oauth client ID**. -13. Under **Application type**, select `Web application`, In the **Name** field enter `Octopus`, click **Add URI** and enter `https://octopus.example.com/api/users/authenticatedToken/GoogleApps` (replacing `https://octopus.example.com` with the url of your Octopus Server) to the **Authorized redirect URIs** and click **Create**. +13. Under **Application type**, select `Web application`, In the **Name** field enter `Octopus`, click **Add URI**, and enter `https://octopus.example.com/api/users/authenticatedToken/GoogleApps` (replacing `https://octopus.example.com` with the URL of your Octopus Server) to the **Authorized redirect URIs** and click **Create**. 14. Enter a **Name** for identification, e.g. Octopus. This is the name that will appear when the user is asked to allow access to their details. 15. Take note of the **Client ID** and **Client secret** from the `OAuth client created` modal. :::div{.hint} **Tips:** -- **Reply URLs are case-sensitive** - Be aware that the path in this URL after the domain name was **case sensitive** during our testing. -- **Not using SSL?** - We highly recommend using SSL, but we know its not always possible. You can use `http` if you do not have SSL enabled on your Octopus Server. Please beware of the security implications in accepting a security token over an insecure channel. -Octopus integrates with [Let's Encrypt](/docs/security/exposing-octopus/lets-encrypt-integration) making it easier to setup SSL on your Octopus Server. +- **Reply URLs are case-sensitive** - Be aware that the path in this URL after the domain name was **case-sensitive** during our testing. +- **Not using SSL?** We highly recommend using SSL, but we know it's not always possible. If you do not have SSL enabled on your Octopus Server, you can use `http`. Please beware of the security implications of accepting a security token over an insecure channel. +Octopus integrates with [Let's Encrypt](/docs/security/exposing-octopus/lets-encrypt-integration), making it easier to set up SSL on your Octopus Server. ::: ## Configure Octopus Server @@ -81,9 +81,9 @@ If you already have Octopus user accounts and you want to enable external authen We do our best to log warnings to your Octopus Server log whenever possible. If you are having difficulty configuring Octopus to authenticate with Google Workspace, be sure to check your [server logs](/docs/support/log-files) for warnings. -### Double and triple check your configuration +### Double and triple-check your configuration -Unfortunately security-related configuration is sensitive to everything. Make sure: +Unfortunately, security-related configuration is sensitive to everything. Make sure: - You don't have any typos or copy-paste errors. - Remember things are case-sensitive. @@ -95,9 +95,9 @@ You can see the OpenID Connect metadata by going to [https://accounts.google.com ### Inspect the contents of the security token -Perhaps the contents of the security token sent back by Google Workspace aren't exactly the way Octopus expected, especially certain claims which may be missing or named differently. This will usually result in the Google Workspace user incorrectly mapping to a different Octopus User than expected. The best way to diagnose this is to inspect the JSON Web Token (JWT) which is sent from Google Workspace to Octopus via your browser. To inspect the contents of your security token: +Perhaps the contents of the security token sent back by Google Workspace aren't exactly the way Octopus expected, especially certain claims that may be missing or named differently. This will usually result in the Google Workspace user incorrectly mapping to a different Octopus User than expected. The best way to diagnose this is to inspect the JSON Web Token (JWT) which is sent from Google Workspace to Octopus via your browser. To inspect the contents of your security token: -1. Open the Developer Tools of your browser and enable Network logging making sure the network logging is preserved across requests. +1. Open your browser's Developer Tools and enable Network logging, making sure the network logging is preserved across requests. 2. In Chrome Dev Tools this is called "Preserve Log": :::figure @@ -117,5 +117,5 @@ Perhaps the contents of the security token sent back by Google Workspace aren't ::: 5. Don't worry if jwt.io complains about the token signature, it doesn't support RS256 which is used by Google Workspace. -6. Octopus uses most of the data to validate the token, but primarily uses the `sub`, `email` and `name` claims. If these claims are not present you will likely see unexpected behavior. +6. Octopus uses most of the data to validate the token, but it primarily uses the `sub`, `email`, and `name` claims. If these claims are not present, you will likely see unexpected behavior. 7. If you are not able to figure out what is going wrong, please send a copy of the decoded payload to our [support team](https://octopus.com/support) and let them know what behavior you are experiencing. diff --git a/src/pages/docs/security/outbound-requests/index.md b/src/pages/docs/security/outbound-requests/index.md index 60af582ced..6f2e4905f6 100644 --- a/src/pages/docs/security/outbound-requests/index.md +++ b/src/pages/docs/security/outbound-requests/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-01-01 +modDate: 2024-12-13 title: Outbound requests description: Traffic details of network requests made by Octopus and Tentacle, and what information is included when Octopus checks for updates. navOrder: 25 @@ -9,7 +9,7 @@ navOrder: 25 This page describes any outbound network requests made by Octopus and Tentacle, and what information is included when Octopus checks for updates. -## Outbound requests by Tentacle {#Outboundrequests-OutboundrequestsbyTentacle} +## Outbound requests by Tentacle For security reasons, we minimize the number of outbound requests made by the Tentacle deployment agent. The only outbound requests you should see are for: @@ -20,7 +20,7 @@ For security reasons, we minimize the number of outbound requests made by the Te It's possible that scripts in your packages may make outbound requests; in this case you should take care when deploying packages created by a third party. -## Outbound requests by Octopus {#Outboundrequests-OutboundrequestsbyOctopus} +## Outbound requests by Octopus The Octopus Server makes the following outbound requests: @@ -30,7 +30,8 @@ The Octopus Server makes the following outbound requests: 4. Checking for updates (if enabled). 5. Checking for updated [built-in step templates](/docs/projects/built-in-step-templates) (if enabled). 6. Checking for updated [community contributed step templates](/docs/projects/community-step-templates) (if enabled). -7. Behavioral telemetry is sent to https://telemetry.octopus.com (if enabled). +7. Behavioral telemetry is sent to `https://telemetry.octopus.com` (if enabled). +8. Email address is sent to `https://experiences.octopus.com` via In-App messaging (if enabled). ### Built-in step templates @@ -43,7 +44,7 @@ From **Octopus 2022.1** some built-in step templates can be automatically update Our community contributed step template integration queries `library.octopus.com` for updates. -## What information is included when Octopus checks for updates? {#Outboundrequests-WhatinformationisincludedwhenOctopuschecksforupdates?} +## What information is included when Octopus checks for updates? By default, Octopus will periodically check for new releases. You can opt-out of checking for updates by navigating to **Configuration ➜ Settings ➜ Updates** in Octopus. @@ -60,15 +61,18 @@ The Octopus.com site is hosted on Microsoft Azure, so you will see traffic going ## Disabling outbound requests In isolated/air-gapped scenarios without access to the internet, it may prove beneficial to disable attempts to contact these external services to prevent failed tasks and/or errors in the logs. Details on how to disable each feature are as follows: -* Octopus Server updates - * Via the Web Portal: **Configuration ➜ Settings ➜ Updates** - * Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --upgradeCheck=false` -* Built-in step template updates - * Via the Web Portal: **Configuration ➜ Features ➜ Step Template Updates** -* Community step updates - * Via the Web Portal: **Configuration ➜ Features ➜ Community Step Templates** -* Telemetry - * Via the Web Portal: **Configuration ➜ Telemetry** - * Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --sendTelemetry=false` -* Dynamic Extensions - * Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --dynamicExtensionsEnabled=false` + +- Octopus Server updates + - Via the Web Portal: **Configuration ➜ Settings ➜ Updates** + - Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --upgradeCheck=false` +- Built-in step template updates + - Via the Web Portal: **Configuration ➜ Features ➜ Step Template Updates** +- Community step updates + - Via the Web Portal: **Configuration ➜ Features ➜ Community Step Templates** +- Telemetry + - Via the Web Portal: **Configuration ➜ Telemetry** + - Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --sendTelemetry=false` +- Dynamic Extensions + - Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --dynamicExtensionsEnabled=false` +- In-App Messaging via Chameleon + - Please contact [support@octopus.com](mailto:support@octopus.com) for assistance disabling In-App Messaging diff --git a/src/pages/docs/security/users-and-teams/default-permissions.md b/src/pages/docs/security/users-and-teams/default-permissions.md index d61355546d..3984425f91 100644 --- a/src/pages/docs/security/users-and-teams/default-permissions.md +++ b/src/pages/docs/security/users-and-teams/default-permissions.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-01-01 +modDate: 2024-11-26 title: Default permissions for built-in user roles description: A listing of the default permissions for each of the built-in user roles. --- @@ -10,6 +10,8 @@ description: A listing of the default permissions for each of the built-in user | Space Permission | Description | | --------------------------- | ---------------------------------------- | +| BuildInformationAdminister | Replace or delete build information | +| BuildInformationPush | Create/update build information | | BuiltInFeedAdminister | Replace or delete packages in the built-in package repository | | BuiltInFeedDownload | Retrieve the contents of packages in the built-in package repository | | BuiltInFeedPush | Push new packages to the built-in package repository | @@ -19,28 +21,26 @@ description: A listing of the default permissions for each of the built-in user | FeedView | View package feeds and the packages in them | | LibraryVariableSetView | View library variable sets | | LifecycleView | View lifecycles | -| BuildInformationPush | Create/update build information | -| BuildInformationAdminister | Replace or delete build information | | ProcessView | View the deployment process and channels associated with a project | | ProjectView | View the details of projects | | ReleaseCreate | Create a release for a project | | ReleaseView | View a release of a project | -| TaskView | View summary-level information associated with a task | -| TenantView | View tenants | -| RunbookView | View runbooks | | RunbookEdit | Edit runbooks | -| RunbookRunView | View runbook runs | | RunbookRunCreate | Create runbook runs | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | +| TaskView | View summary-level information associated with a task | +| TenantView | View tenants | ## Certificate Manager {#DefaultPermissions-CertificateManager} | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| CertificateView | View certificates | | CertificateCreate | Create certificates | -| CertificateEdit | Edit certificates | | CertificateDelete | Delete certificates | +| CertificateEdit | Edit certificates | | CertificateExportPrivateKey | Export certificate private-keys | +| CertificateView | View certificates | | EnvironmentView | View environments | | TenantView | View tenants | @@ -51,16 +51,16 @@ description: A listing of the default permissions for each of the built-in user | DeploymentCreate | Deploy releases to target environments | | DeploymentView | View deployments | | EnvironmentView | View environments | +| LibraryVariableSetView | View library variable sets | | LifecycleView | View lifecycles | | ProcessView | View the deployment process and channels associated with a project | | ProjectView | View the details of projects | | ReleaseView | View a release of a project | +| RunbookRunCreate | Create runbook runs | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | | TaskView | View summary-level information associated with a task | | TenantView | View tenants | -| LibraryVariableSetView | View library variable sets | -| RunbookView | View runbooks | -| RunbookRunView | View runbook runs | -| RunbookRunCreate | Create runbook runs | ## Environment Manager {#DefaultPermissions-EnvironmentManager} @@ -70,32 +70,32 @@ description: A listing of the default permissions for each of the built-in user | Space Permission | Description | | --------------------------- | ---------------------------------------- | +| AccountCreate | Create accounts | +| AccountDelete | Delete accounts | +| AccountEdit | Edit accounts | +| AccountView | View accounts | +| CertificateView | View certificates | | EnvironmentCreate | Create environments | -| EnvironmentEdit | Edit environments | | EnvironmentDelete | Delete environments | +| EnvironmentEdit | Edit environments | +| EnvironmentView | View environments | | MachineCreate | Create machines | -| MachineEdit | Edit machines | | MachineDelete | Delete machines | -| TaskCreate | Explicitly create (run) server tasks | -| TaskCancel | Cancel server tasks | -| AccountCreate | Create accounts | -| AccountEdit | Edit accounts | -| AccountDelete | Delete accounts | -| ProxyCreate | Create proxies | -| ProxyEdit | Edit proxies | -| ProxyDelete | Delete proxies | +| MachineEdit | Edit machines | | MachinePolicyCreate | Create health check policies | -| MachinePolicyEdit | Edit health check policies | | MachinePolicyDelete | Delete health check policies | -| WorkerEdit | Edit workers and worker pools | -| EnvironmentView | View environments | +| MachinePolicyEdit | Edit health check policies | +| MachinePolicyView | View health check policies | | MachineView | View machines | +| ProxyCreate | Create proxies | +| ProxyDelete | Delete proxies | +| ProxyEdit | Edit proxies | +| ProxyView | View proxies | +| TaskCancel | Cancel server tasks | +| TaskCreate | Explicitly create (run) server tasks | | TaskView | View summary-level information associated with a task | | TeamView | View teams | -| AccountView | View accounts | -| MachinePolicyView | View health check policies | -| CertificateView | View certificates | -| ProxyView | View proxies | +| WorkerEdit | Edit workers and worker pools | | WorkerView | View the workers in worker pools | ## Environment Viewer {#DefaultPermissions-EnvironmentViewer} @@ -106,25 +106,25 @@ description: A listing of the default permissions for each of the built-in user | Space Permission | Description | | --------------------------- | ---------------------------------------- | +| AccountView | View accounts | +| CertificateView | View certificates | | EnvironmentView | View environments | +| MachinePolicyView | View health check policies | | MachineView | View machines | +| ProxyView | View proxies | | TaskView | View summary-level information associated with a task | | TeamView | View teams | -| AccountView | View accounts | -| MachinePolicyView | View health check policies | -| CertificateView | View certificates | -| ProxyView | View proxies | | WorkerView | View the workers in worker pools | ## Insights Report Manager {#DefaultPermissions-InsightsReportManager} | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| InsightsReportView | View Insights reports | +| EnvironmentView | View environments | | InsightsReportCreate | Create Insights reports | -| InsightsReportEdit | Edit Insights reports | | InsightsReportDelete | Delete Insights reports | -| EnvironmentView | View environments | +| InsightsReportEdit | Edit Insights reports | +| InsightsReportView | View Insights reports | | ProcessView | View the deployment process and channels associated with a project | | ProjectGroupView | View project groups | | ProjectView | View the details of projects | @@ -134,242 +134,242 @@ description: A listing of the default permissions for each of the built-in user | Space Permission | Description | | --------------------------- | ---------------------------------------- | +| BuildInformationAdminister | Replace or delete build information | +| BuildInformationPush | Create/update build information | | BuiltInFeedAdminister | Replace or delete packages in the built-in package repository | | BuiltInFeedDownload | Retrieve the contents of packages in the built-in package repository | | BuiltInFeedPush | Push new packages to the built-in package repository | | FeedView | View package feeds and the packages in them | -| BuildInformationPush | Create/update build information | -| BuildInformationAdminister | Replace or delete build information | ## Project Contributor {#DefaultPermissions-ProjectContributor} | System Permission | Description | | --------------------------- | ---------------------------------------- | | TeamView | View teams | -| UserView | View users | | UserRoleView | View other user's roles | +| UserView | View users | | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| ArtifactCreate | Manually create artifacts | -| ActionTemplateView | View step templates | | ActionTemplateCreate | Create step templates | -| ActionTemplateEdit | Edit step templates | | ActionTemplateDelete | Delete step templates | -| ProcessEdit | Edit the deployment process and channels associated with a project | -| ProjectEdit | Edit project details | -| FeedView | View package feeds and the packages in them | -| LibraryVariableSetCreate | Create library variable sets | -| LibraryVariableSetEdit | Edit library variable sets | -| LibraryVariableSetDelete | Delete library variable sets | -| TaskCreate | Explicitly create (run) server tasks | -| InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | -| MachineView | View machines | +| ActionTemplateEdit | Edit step templates | +| ActionTemplateView | View step templates | +| ArtifactCreate | Manually create artifacts | +| ArtifactView | View the artifacts created manually and during deployment | +| CertificateView | View certificates | | DefectReport | Block a release from progressing to the next lifecycle phase | | DefectResolve | Unblock a release so it can progress to the next phase | -| VariableView | View variables belonging to a project or library variable set | -| VariableEdit | Edit variables belonging to a project | -| TriggerCreate | Create triggers | -| TriggerDelete | Delete triggers | -| TriggerEdit | Edit triggers | -| RunbookView | View runbooks | -| RunbookEdit | Edit runbooks | -| ReleaseView | View a release of a project | -| ProjectView | View the details of projects | | DeploymentView | View deployments | -| ProcessView | View the deployment process and channels associated with a project | | EnvironmentView | View environments | -| ArtifactView | View the artifacts created manually and during deployment | | EventView | View Events, including access to the Audit screen | -| ProjectGroupView | View project groups | -| LibraryVariableSetView | View library variable sets | -| TeamView | View teams | -| TaskView | View summary-level information associated with a task | +| FeedView | View package feeds and the packages in them | | InterruptionView | View interruptions generated during deployments | +| InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | +| LibraryVariableSetCreate | Create library variable sets | +| LibraryVariableSetDelete | Delete library variable sets | +| LibraryVariableSetEdit | Edit library variable sets | +| LibraryVariableSetView | View library variable sets | | LifecycleView | View lifecycles | | MachinePolicyView | View health check policies | +| MachineView | View machines | +| ProcessEdit | Edit the deployment process and channels associated with a project | +| ProcessView | View the deployment process and channels associated with a project | +| ProjectEdit | Edit project details | +| ProjectGroupView | View project groups | +| ProjectView | View the details of projects | +| ReleaseView | View a release of a project | +| RunbookEdit | Edit runbooks | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | +| TaskCreate | Explicitly create (run) server tasks | +| TaskView | View summary-level information associated with a task | +| TeamView | View teams | | TenantView | View tenants | +| TriggerCreate | Create triggers | +| TriggerDelete | Delete triggers | +| TriggerEdit | Edit triggers | | TriggerView | View triggers | -| CertificateView | View certificates | -| RunbookRunView | View runbook runs | +| VariableEdit | Edit variables belonging to a project | +| VariableView | View variables belonging to a project or library variable set | ## Project Deployer {#DefaultPermissions-ProjectDeployer} | System Permission | Description | | --------------------------- | ---------------------------------------- | | TeamView | View teams | -| UserView | View users | | UserRoleView | View other user's roles | +| UserView | View users | | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| DeploymentCreate | Deploy releases to target environments | -| InterruptionSubmit | Take responsibility for and submit interruptions generated during deployments | -| TaskCancel | Cancel server tasks | -| RunbookRunCreate | Create runbook runs | -| ArtifactCreate | Manually create artifacts | -| ActionTemplateView | View step templates | | ActionTemplateCreate | Create step templates | -| ActionTemplateEdit | Edit step templates | | ActionTemplateDelete | Delete step templates | -| ProcessEdit | Edit the deployment process and channels associated with a project | -| ProjectEdit | Edit project details | -| FeedView | View package feeds and the packages in them | -| LibraryVariableSetCreate | Create library variable sets | -| LibraryVariableSetEdit | Edit library variable sets | -| LibraryVariableSetDelete | Delete library variable sets | -| TaskCreate | Explicitly create (run) server tasks | -| InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | -| MachineView | View machines | +| ActionTemplateEdit | Edit step templates | +| ActionTemplateView | View step templates | +| ArtifactCreate | Manually create artifacts | +| ArtifactView | View the artifacts created manually and during deployment | +| CertificateView | View certificates | | DefectReport | Block a release from progressing to the next lifecycle phase | | DefectResolve | Unblock a release so it can progress to the next phase | -| VariableView | View variables belonging to a project or library variable set | -| VariableEdit | Edit variables belonging to a project | -| TriggerCreate | Create triggers | -| TriggerDelete | Delete triggers | -| TriggerEdit | Edit triggers | -| RunbookView | View runbooks | -| RunbookEdit | Edit runbooks | -| ReleaseView | View a release of a project | -| ProjectView | View the details of projects | +| DeploymentCreate | Deploy releases to target environments | | DeploymentView | View deployments | -| ProcessView | View the deployment process and channels associated with a project | | EnvironmentView | View environments | -| ArtifactView | View the artifacts created manually and during deployment | | EventView | View Events, including access to the Audit screen | -| ProjectGroupView | View project groups | -| LibraryVariableSetView | View library variable sets | -| TeamView | View teams | -| TaskView | View summary-level information associated with a task | +| FeedView | View package feeds and the packages in them | +| InterruptionSubmit | Take responsibility for and submit interruptions generated during deployments | | InterruptionView | View interruptions generated during deployments | +| InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | +| LibraryVariableSetCreate | Create library variable sets | +| LibraryVariableSetDelete | Delete library variable sets | +| LibraryVariableSetEdit | Edit library variable sets | +| LibraryVariableSetView | View library variable sets | | LifecycleView | View lifecycles | | MachinePolicyView | View health check policies | +| MachineView | View machines | +| ProcessEdit | Edit the deployment process and channels associated with a project | +| ProcessView | View the deployment process and channels associated with a project | +| ProjectEdit | Edit project details | +| ProjectGroupView | View project groups | +| ProjectView | View the details of projects | +| ReleaseView | View a release of a project | +| RunbookEdit | Edit runbooks | +| RunbookRunCreate | Create runbook runs | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | +| TaskCancel | Cancel server tasks | +| TaskCreate | Explicitly create (run) server tasks | +| TaskView | View summary-level information associated with a task | +| TeamView | View teams | | TenantView | View tenants | +| TriggerCreate | Create triggers | +| TriggerDelete | Delete triggers | +| TriggerEdit | Edit triggers | | TriggerView | View triggers | -| CertificateView | View certificates | -| RunbookRunView | View runbook runs | +| VariableEdit | Edit variables belonging to a project | +| VariableView | View variables belonging to a project or library variable set | ## Project Initiator {#DefaultPermissions-ProjectInitiator} | System Permission | Description | | --------------------------- | ---------------------------------------- | | TeamView | View teams | -| UserView | View users | | UserRoleView | View other user's roles | +| UserView | View users | | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| ProjectCreate | Create projects | -| ProjectEdit | Edit project details | -| ProjectDelete | Delete projects | +| ArtifactView | View the artifacts created manually and during deployment | +| CertificateView | View certificates | | DefectReport | Block a release from progressing to the next lifecycle phase | | DefectResolve | Unblock a release so it can progress to the next phase | -| ReleaseView | View a release of a project | -| ProjectView | View the details of projects | | DeploymentView | View deployments | -| ProcessView | View the deployment process and channels associated with a project | | EnvironmentView | View environments | -| ArtifactView | View the artifacts created manually and during deployment | | EventView | View Events, including access to the Audit screen | -| ProjectGroupView | View project groups | -| LibraryVariableSetView | View library variable sets | -| TeamView | View teams | -| TaskView | View summary-level information associated with a task | | InterruptionView | View interruptions generated during deployments | +| LibraryVariableSetView | View library variable sets | | LifecycleView | View lifecycles | | MachinePolicyView | View health check policies | +| ProcessView | View the deployment process and channels associated with a project | +| ProjectCreate | Create projects | +| ProjectDelete | Delete projects | +| ProjectEdit | Edit project details | +| ProjectGroupView | View project groups | +| ProjectView | View the details of projects | +| ReleaseView | View a release of a project | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | +| TaskView | View summary-level information associated with a task | +| TeamView | View teams | | TenantView | View tenants | | TriggerView | View triggers | -| CertificateView | View certificates | -| RunbookView | View runbooks | -| RunbookRunView | View runbook runs | ## Project Lead {#DefaultPermissions-ProjectLead} | System Permission | Description | | --------------------------- | ---------------------------------------- | | TeamView | View teams | -| UserView | View users | | UserRoleView | View other user's roles | +| UserView | View users | | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| ReleaseCreate | Create a release for a project | -| ReleaseEdit | Edit a release of a project | -| ReleaseDelete | Delete a release of a project | -| ArtifactEdit | Edit the details describing artifacts | -| ArtifactDelete | Delete artifacts | -| ArtifactCreate | Manually create artifacts | -| ActionTemplateView | View step templates | | ActionTemplateCreate | Create step templates | -| ActionTemplateEdit | Edit step templates | | ActionTemplateDelete | Delete step templates | -| ProcessEdit | Edit the deployment process and channels associated with a project | -| ProjectEdit | Edit project details | -| FeedView | View package feeds and the packages in them | -| LibraryVariableSetCreate | Create library variable sets | -| LibraryVariableSetEdit | Edit library variable sets | -| LibraryVariableSetDelete | Delete library variable sets | -| TaskCreate | Explicitly create (run) server tasks | -| InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | -| MachineView | View machines | -| DefectReport | Block a release from progressing to the next lifecycle phase | -| DefectResolve | Unblock a release so it can progress to the next phase | -| VariableView | View variables belonging to a project or library variable set | -| VariableEdit | Edit variables belonging to a project | -| TriggerCreate | Create triggers | -| TriggerDelete | Delete triggers | -| TriggerEdit | Edit triggers | -| RunbookView | View runbooks | -| RunbookEdit | Edit runbooks | -| ReleaseView | View a release of a project | -| ProjectView | View the details of projects | +| ActionTemplateEdit | Edit step templates | +| ActionTemplateView | View step templates | +| ArtifactCreate | Manually create artifacts | +| ArtifactDelete | Delete artifacts | +| ArtifactEdit | Edit the details describing artifacts | +| ArtifactView | View the artifacts created manually and during deployment | +| CertificateView | View certificates | +| DefectReport | Block a release from progressing to the next lifecycle phase | +| DefectResolve | Unblock a release so it can progress to the next phase | | DeploymentView | View deployments | -| ProcessView | View the deployment process and channels associated with a project | | EnvironmentView | View environments | -| ArtifactView | View the artifacts created manually and during deployment | | EventView | View Events, including access to the Audit screen | -| ProjectGroupView | View project groups | -| LibraryVariableSetView | View library variable sets | -| TeamView | View teams | -| TaskView | View summary-level information associated with a task | +| FeedView | View package feeds and the packages in them | | InterruptionView | View interruptions generated during deployments | +| InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | +| LibraryVariableSetCreate | Create library variable sets | +| LibraryVariableSetDelete | Delete library variable sets | +| LibraryVariableSetEdit | Edit library variable sets | +| LibraryVariableSetView | View library variable sets | | LifecycleView | View lifecycles | | MachinePolicyView | View health check policies | +| MachineView | View machines | +| ProcessEdit | Edit the deployment process and channels associated with a project | +| ProcessView | View the deployment process and channels associated with a project | +| ProjectEdit | Edit project details | +| ProjectGroupView | View project groups | +| ProjectView | View the details of projects | +| ReleaseCreate | Create a release for a project | +| ReleaseDelete | Delete a release of a project | +| ReleaseEdit | Edit a release of a project | +| ReleaseView | View a release of a project | +| RunbookEdit | Edit runbooks | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | +| TaskCreate | Explicitly create (run) server tasks | +| TaskView | View summary-level information associated with a task | +| TeamView | View teams | | TenantView | View tenants | +| TriggerCreate | Create triggers | +| TriggerDelete | Delete triggers | +| TriggerEdit | Edit triggers | | TriggerView | View triggers | -| CertificateView | View certificates | -| RunbookRunView | View runbook runs | +| VariableEdit | Edit variables belonging to a project | +| VariableView | View variables belonging to a project or library variable set | ## Project Viewer {#DefaultPermissions-ProjectViewer} | System Permission | Description | | --------------------------- | ---------------------------------------- | | TeamView | View teams | -| UserView | View users | | UserRoleView | View other user's roles | +| UserView | View users | | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| ReleaseView | View a release of a project | -| ProjectView | View the details of projects | +| ArtifactView | View the artifacts created manually and during deployment | +| CertificateView | View certificates | | DeploymentView | View deployments | -| ProcessView | View the deployment process and channels associated with a project | | EnvironmentView | View environments | -| ArtifactView | View the artifacts created manually and during deployment | | EventView | View Events, including access to the Audit screen | -| ProjectGroupView | View project groups | -| LibraryVariableSetView | View library variable sets | -| TeamView | View teams | -| TaskView | View summary-level information associated with a task | | InterruptionView | View interruptions generated during deployments | +| LibraryVariableSetView | View library variable sets | | LifecycleView | View lifecycles | | MachinePolicyView | View health check policies | +| ProcessView | View the deployment process and channels associated with a project | +| ProjectGroupView | View project groups | +| ProjectView | View the details of projects | +| ReleaseView | View a release of a project | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | +| TaskView | View summary-level information associated with a task | +| TeamView | View teams | | TenantView | View tenants | | TriggerView | View triggers | -| CertificateView | View certificates | -| RunbookView | View runbooks | -| RunbookRunView | View runbook runs | ## Release Creator {#DefaultPermissions-ReleaseCreator} @@ -381,197 +381,197 @@ description: A listing of the default permissions for each of the built-in user | ProjectView | View the details of projects | | ReleaseCreate | Create a release for a project | | ReleaseView | View a release of a project | -| RunbookView | View runbooks | | RunbookEdit | Edit runbooks | +| RunbookView | View runbooks | ## Runbook Consumer {#DefaultPermissions-RunbookConsumer} | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| ProjectView | View the details of projects | -| EnvironmentView | View environments | | ArtifactView | View the artifacts created manually and during deployment | +| CertificateView | View certificates | +| EnvironmentView | View environments | | EventView | View Events, including access to the Audit screen | -| ProjectGroupView | View project groups | -| LibraryVariableSetView | View library variable sets | -| TeamView | View teams | | FeedView | View package feeds and the packages in them | -| TaskView | View summary-level information associated with a task | | InterruptionView | View interruptions generated during deployments | +| LibraryVariableSetView | View library variable sets | | MachinePolicyView | View health check policies | -| TenantView | View tenants | -| TriggerView | View triggers | -| CertificateView | View certificates | | MachineView | View machines | -| RunbookView | View runbooks | -| RunbookRunView | View runbook runs | +| ProjectGroupView | View project groups | +| ProjectView | View the details of projects | | RunbookRunCreate | Create runbook runs | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | +| TaskView | View summary-level information associated with a task | +| TeamView | View teams | +| TenantView | View tenants | +| TriggerView | View triggers | ## Runbook Producer {#DefaultPermissions-RunbookProducer} | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| ProjectCreate | Create projects | -| ProjectEdit | Edit project details | -| ProjectDelete | Delete projects | -| LifecycleView | View lifecycles | -| ActionTemplateView | View step templates | | ActionTemplateCreate | Create step templates | -| ActionTemplateEdit | Edit step templates | | ActionTemplateDelete | Delete step templates | -| LibraryVariableSetCreate | Create library variable sets | -| LibraryVariableSetEdit | Edit library variable sets | -| LibraryVariableSetDelete | Delete library variable sets | -| TaskCreate | Explicitly create (run) server tasks | -| TaskCancel | Cancel server tasks | -| InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | -| VariableView | View variables belonging to a project or library variable set | -| VariableEdit | Edit variables belonging to a project | -| TriggerCreate | Create triggers | -| TriggerDelete | Delete triggers | -| TriggerEdit | Edit triggers | -| RunbookEdit | Edit runbooks | -| RunbookRunDelete | Delete runbook runs | +| ActionTemplateEdit | Edit step templates | +| ActionTemplateView | View step templates | | ArtifactCreate | Manually create artifacts | -| ArtifactEdit | Edit the details describing artifacts | | ArtifactDelete | Delete artifacts | -| InterruptionSubmit | Take responsibility for and submit interruptions generated during deployments | -| ProjectView | View the details of projects | -| EnvironmentView | View environments | +| ArtifactEdit | Edit the details describing artifacts | | ArtifactView | View the artifacts created manually and during deployment | +| CertificateView | View certificates | +| EnvironmentView | View environments | | EventView | View Events, including access to the Audit screen | -| ProjectGroupView | View project groups | -| LibraryVariableSetView | View library variable sets | -| TeamView | View teams | | FeedView | View package feeds and the packages in them | -| TaskView | View summary-level information associated with a task | +| InterruptionSubmit | Take responsibility for and submit interruptions generated during deployments | | InterruptionView | View interruptions generated during deployments | +| InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | +| LibraryVariableSetCreate | Create library variable sets | +| LibraryVariableSetDelete | Delete library variable sets | +| LibraryVariableSetEdit | Edit library variable sets | +| LibraryVariableSetView | View library variable sets | +| LifecycleView | View lifecycles | | MachinePolicyView | View health check policies | -| TenantView | View tenants | -| TriggerView | View triggers | -| CertificateView | View certificates | | MachineView | View machines | -| RunbookView | View runbooks | -| RunbookRunView | View runbook runs | +| ProjectCreate | Create projects | +| ProjectDelete | Delete projects | +| ProjectEdit | Edit project details | +| ProjectGroupView | View project groups | +| ProjectView | View the details of projects | +| RunbookEdit | Edit runbooks | | RunbookRunCreate | Create runbook runs | +| RunbookRunDelete | Delete runbook runs | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | +| TaskCancel | Cancel server tasks | +| TaskCreate | Explicitly create (run) server tasks | +| TaskView | View summary-level information associated with a task | +| TeamView | View teams | +| TenantView | View tenants | +| TriggerCreate | Create triggers | +| TriggerDelete | Delete triggers | +| TriggerEdit | Edit triggers | +| TriggerView | View triggers | +| VariableEdit | Edit variables belonging to a project | +| VariableView | View variables belonging to a project or library variable set | ## Space Manager {#DefaultPermissions-SpaceManager} | System Permission | Description | | --------------------------- | ---------------------------------------- | | TeamView | View teams | -| UserView | View users | | UserRoleView | View other user's roles | +| UserView | View users | | Space Permission | Description | | --------------------------- | ---------------------------------------- | -| ProjectEdit | Edit project details | -| ProjectView | View the details of projects | -| ProjectCreate | Create projects | -| ProjectDelete | Delete projects | -| ProcessView | View the deployment process and channels associated with a project | -| ProcessEdit | Edit the deployment process and channels associated with a project | -| VariableEdit | Edit variables belonging to a project | -| VariableEditUnscoped | Edit non-environment scoped variables belonging to a project or library variable set | -| VariableView | View variables belonging to a project or library variable set | -| VariableViewUnscoped | View non-environment scoped variables belonging to a project or library variable set | -| ReleaseCreate | Create a release for a project | -| ReleaseView | View a release of a project | -| ReleaseEdit | Edit a release of a project | -| ReleaseDelete | Delete a release of a project | +| AccountCreate | Create accounts | +| AccountDelete | Delete accounts | +| AccountEdit | Edit accounts | +| AccountView | View accounts | +| ActionTemplateCreate | Create step templates | +| ActionTemplateDelete | Delete step templates | +| ActionTemplateEdit | Edit step templates | +| ActionTemplateView | View step templates | +| ArtifactCreate | Manually create artifacts | +| ArtifactDelete | Delete artifacts | +| ArtifactEdit | Edit the details describing artifacts | +| ArtifactView | View the artifacts created manually and during deployment | +| BuildInformationAdminister | Replace or delete build information | +| BuildInformationPush | Create/update build information | +| BuiltInFeedAdminister | Replace or delete packages in the built-in package repository | +| BuiltInFeedDownload | Retrieve the contents of packages in the built-in package repository | +| BuiltInFeedPush | Push new packages to the built-in package repository | +| CertificateCreate | Create certificates | +| CertificateDelete | Delete certificates | +| CertificateEdit | Edit certificates | +| CertificateExportPrivateKey | Export certificate private-keys | +| CertificateView | View certificates | | DefectReport | Block a release from progressing to the next lifecycle phase | | DefectResolve | Unblock a release so it can progress to the next phase | | DeploymentCreate | Deploy releases to target environments | | DeploymentDelete | Delete deployments | | DeploymentView | View deployments | -| EnvironmentView | View environments | | EnvironmentCreate | Create environments | -| EnvironmentEdit | Edit environments | | EnvironmentDelete | Delete environments | -| MachineCreate | Create machines | -| MachineEdit | Edit machines | -| MachineView | View machines | -| MachineDelete | Delete machines | -| ArtifactView | View the artifacts created manually and during deployment | -| ArtifactCreate | Manually create artifacts | -| ArtifactEdit | Edit the details describing artifacts | -| ArtifactDelete | Delete artifacts | -| FeedView | View package feeds and the packages in them | +| EnvironmentEdit | Edit environments | +| EnvironmentView | View environments | +| EventView | View Events, including access to the Audit screen | | FeedEdit | Edit feeds | -| GitCredentialView | View Git credentials | +| FeedView | View package feeds and the packages in them | | GitCredentialEdit | Edit Git credentials | -| EventView | View Events, including access to the Audit screen | -| LibraryVariableSetView | View library variable sets | -| LibraryVariableSetCreate | Create library variable sets | -| LibraryVariableSetEdit | Edit library variable sets | -| LibraryVariableSetDelete | Delete library variable sets | -| ProjectGroupView | View project groups | -| ProjectGroupCreate | Create project groups | -| ProjectGroupEdit | Edit project groups | -| ProjectGroupDelete | Delete project groups | -| TeamCreate | Create teams | -| TeamView | View teams | -| TeamEdit | Edit teams | -| TeamDelete | Delete teams | -| TaskView | View summary-level information associated with a task | -| TaskCreate | Explicitly create (run) server tasks | -| TaskCancel | Cancel server tasks | -| TaskEdit | Edit server tasks | -| InterruptionView | View interruptions generated during deployments | +| GitCredentialView | View Git credentials | | InterruptionSubmit | Take responsibility for and submit interruptions generated during deployments | +| InterruptionView | View interruptions generated during deployments | | InterruptionViewSubmitResponsible | Take responsibility for and submit interruptions generated during deployments when the user is in a designated responsible team | -| BuiltInFeedPush | Push new packages to the built-in package repository | -| BuiltInFeedAdminister | Replace or delete packages in the built-in package repository | -| BuiltInFeedDownload | Retrieve the contents of packages in the built-in package repository | -| ActionTemplateView | View step templates | -| ActionTemplateCreate | Create step templates | -| ActionTemplateEdit | Edit step templates | -| ActionTemplateDelete | Delete step templates | +| LibraryVariableSetCreate | Create library variable sets | +| LibraryVariableSetDelete | Delete library variable sets | +| LibraryVariableSetEdit | Edit library variable sets | +| LibraryVariableSetView | View library variable sets | | LifecycleCreate | Create lifecycles | -| LifecycleView | View lifecycles | -| LifecycleEdit | Edit lifecycles | | LifecycleDelete | Delete lifecycles | -| AccountView | View accounts | -| AccountEdit | Edit accounts | -| AccountCreate | Create accounts | -| AccountDelete | Delete accounts | -| TenantCreate | Create tenants | -| TenantEdit | Edit tenants | -| TenantView | View tenants | -| TenantDelete | Delete tenants | -| TagSetCreate | Create tag sets | -| TagSetEdit | Edit tag sets | -| TagSetDelete | Delete tag sets | +| LifecycleEdit | Edit lifecycles | +| LifecycleView | View lifecycles | +| MachineCreate | Create machines | +| MachineDelete | Delete machines | +| MachineEdit | Edit machines | | MachinePolicyCreate | Create health check policies | -| MachinePolicyView | View health check policies | -| MachinePolicyEdit | Edit health check policies | | MachinePolicyDelete | Delete health check policies | +| MachinePolicyEdit | Edit health check policies | +| MachinePolicyView | View health check policies | +| MachineView | View machines | +| ProcessEdit | Edit the deployment process and channels associated with a project | +| ProcessView | View the deployment process and channels associated with a project | +| ProjectCreate | Create projects | +| ProjectDelete | Delete projects | +| ProjectEdit | Edit project details | +| ProjectGroupCreate | Create project groups | +| ProjectGroupDelete | Delete project groups | +| ProjectGroupEdit | Edit project groups | +| ProjectGroupView | View project groups | +| ProjectView | View the details of projects | | ProxyCreate | Create proxies | -| ProxyView | View proxies | -| ProxyEdit | Edit proxies | | ProxyDelete | Delete proxies | +| ProxyEdit | Edit proxies | +| ProxyView | View proxies | +| ReleaseCreate | Create a release for a project | +| ReleaseDelete | Delete a release of a project | +| ReleaseEdit | Edit a release of a project | +| ReleaseView | View a release of a project | +| RunbookEdit | Edit runbooks | +| RunbookRunCreate | Create runbook runs | +| RunbookRunDelete | Delete runbook runs | +| RunbookRunView | View runbook runs | +| RunbookView | View runbooks | | SubscriptionCreate | Create subscriptions | -| SubscriptionView | View subscriptions | -| SubscriptionEdit | Edit subscriptions | | SubscriptionDelete | Delete subscriptions | +| SubscriptionEdit | Edit subscriptions | +| SubscriptionView | View subscriptions | +| TagSetCreate | Create tag sets | +| TagSetDelete | Delete tag sets | +| TagSetEdit | Edit tag sets | +| TaskCancel | Cancel server tasks | +| TaskCreate | Explicitly create (run) server tasks | +| TaskEdit | Edit server tasks | +| TaskView | View summary-level information associated with a task | +| TeamCreate | Create teams | +| TeamDelete | Delete teams | +| TeamEdit | Edit teams | +| TeamView | View teams | +| TenantCreate | Create tenants | +| TenantDelete | Delete tenants | +| TenantEdit | Edit tenants | +| TenantView | View tenants | | TriggerCreate | Create triggers | -| TriggerView | View triggers | -| TriggerEdit | Edit triggers | | TriggerDelete | Delete triggers | -| CertificateView | View certificates | -| CertificateCreate | Create certificates | -| CertificateEdit | Edit certificates | -| CertificateDelete | Delete certificates | -| CertificateExportPrivateKey | Export certificate private-keys | -| WorkerView | View the workers in worker pools | +| TriggerEdit | Edit triggers | +| TriggerView | View triggers | +| VariableEdit | Edit variables belonging to a project | +| VariableEditUnscoped | Edit non-environment scoped variables belonging to a project or library variable set | +| VariableView | View variables belonging to a project or library variable set | +| VariableViewUnscoped | View non-environment scoped variables belonging to a project or library variable set | | WorkerEdit | Edit workers and worker pools | -| BuildInformationPush | Create/update build information | -| BuildInformationAdminister | Replace or delete build information | -| RunbookView | View runbooks | -| RunbookEdit | Edit runbooks | -| RunbookRunView | View runbook runs | -| RunbookRunDelete | Delete runbook runs | -| RunbookRunCreate | Create runbook runs | +| WorkerView | View the workers in worker pools | ## System Administrator {#DefaultPermissions-SystemAdministrator} @@ -582,23 +582,23 @@ description: A listing of the default permissions for each of the built-in user | EventRetentionDelete | Delete archived event files | | EventRetentionView | View/list archived event files | | EventView | View Events, including access to the Audit screen | -| TeamCreate | Create teams | -| TeamView | View teams | -| TeamEdit | Edit teams | -| TeamDelete | Delete teams | -| TaskView | View summary-level information associated with a task | -| TaskCreate | Explicitly create (run) server tasks | -| TaskCancel | Cancel server tasks | -| TaskEdit | Edit server tasks | -| SpaceView | View spaces | -| SpaceEdit | Edit spaces | | SpaceCreate | Create spaces | | SpaceDelete | Delete spaces | -| UserView | View users | +| SpaceEdit | Edit spaces | +| SpaceView | View spaces | +| TaskCancel | Cancel server tasks | +| TaskCreate | Explicitly create (run) server tasks | +| TaskEdit | Edit server tasks | +| TaskView | View summary-level information associated with a task | +| TeamCreate | Create teams | +| TeamDelete | Delete teams | +| TeamEdit | Edit teams | +| TeamView | View teams | +| UserEdit | Edit users | | UserInvite | Invite users to register accounts | -| UserRoleView | View other user's roles | | UserRoleEdit | Edit user role definitions | -| UserEdit | Edit users | +| UserRoleView | View other user's roles | +| UserView | View users | ## System Manager {#DefaultPermissions-SystemManager} @@ -608,29 +608,29 @@ description: A listing of the default permissions for each of the built-in user | EventRetentionDelete | Delete archived event files | | EventRetentionView | View/list archived event files | | EventView | View Events, including access to the Audit screen | -| TeamCreate | Create teams | -| TeamView | View teams | -| TeamEdit | Edit teams | -| TeamDelete | Delete teams | -| TaskView | View summary-level information associated with a task | -| TaskCreate | Explicitly create (run) server tasks | -| TaskCancel | Cancel server tasks | -| TaskEdit | Edit server tasks | -| SpaceView | View spaces | -| SpaceEdit | Edit spaces | | SpaceCreate | Create spaces | | SpaceDelete | Delete spaces | -| UserView | View users | +| SpaceEdit | Edit spaces | +| SpaceView | View spaces | +| TaskCancel | Cancel server tasks | +| TaskCreate | Explicitly create (run) server tasks | +| TaskEdit | Edit server tasks | +| TaskView | View summary-level information associated with a task | +| TeamCreate | Create teams | +| TeamDelete | Delete teams | +| TeamEdit | Edit teams | +| TeamView | View teams | +| UserEdit | Edit users | | UserInvite | Invite users to register accounts | -| UserRoleView | View other user's roles | | UserRoleEdit | Edit user role definitions | -| UserEdit | Edit users | +| UserRoleView | View other user's roles | +| UserView | View users | ## Tenant Manager {#DefaultPermissions-TenantManager} | Space Permission | Description | | --------------------------- | ---------------------------------------- | | TenantCreate | Create tenants | -| TenantEdit | Edit tenants | | TenantDelete | Delete tenants | +| TenantEdit | Edit tenants | | TenantView | View tenants | \ No newline at end of file diff --git a/src/pages/docs/security/users-and-teams/user-roles.md b/src/pages/docs/security/users-and-teams/user-roles.md index 9bbbc4a62c..4b1e531724 100644 --- a/src/pages/docs/security/users-and-teams/user-roles.md +++ b/src/pages/docs/security/users-and-teams/user-roles.md @@ -82,7 +82,7 @@ The results will show: - The teams of which the user is a member of. There are two separate Permission context that you can check. - **Show System permissions** will show [System level permissions](/docs/security/users-and-teams/system-and-space-permissions) - **Show permissions within a specific space** will show [Space specific Permissions](/docs/security/users-and-teams/system-and-space-permissions). -- A chart detailing each role and on which Environment/Project this permission can be executed. The chart can be exported to a CSV file by clicking the Export button. Once the file is downloaded it can viewed in browser using [Online CSV Editor and Viewer](http://www.convertcsv.com/csv-viewer-editor.htm). +- A chart detailing each role and on which Environment/Project this permission can be executed. The chart can be exported to a CSV file by clicking the Export button. Once the file is downloaded it can viewed in browser using [Online CSV Editor and Viewer](https://www.convertcsv.com/csv-viewer-editor.htm). :::figure ![](/docs/security/users-and-teams/images/systempermissions.png) diff --git a/src/shared-content/scripts/deactivate-tenant-scripts.include.md b/src/shared-content/scripts/deactivate-tenant-scripts.include.md new file mode 100644 index 0000000000..2128747f45 --- /dev/null +++ b/src/shared-content/scripts/deactivate-tenant-scripts.include.md @@ -0,0 +1,247 @@ +
+PowerShell (REST API) + +```powershell +$ErrorActionPreference = "Stop"; + +# Define working variables +$octopusURL = "https://your-octopus-url" +$octopusAPIKey = "API-YOUR-KEY" +$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey } +$tenantName = "MyTenant" +$tenantEnabled = $true + +# Get space +$space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName} + +# Get tenant +$tenant = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/tenants/all" -Headers $header) | Where-Object {$_.Name -eq $tenantName} + +# Enable/disable tenant +$tenant.IsDisabled = !$tenantEnabled + +# Update tenant +Invoke-RestMethod -Method Put -Uri "$octopusURL/api/$($space.Id)/tenants/$($tenant.Id)" -Headers $header -Body ($tenant | ConvertTo-Json -Depth 10) +``` + +
+
+PowerShell (Octopus.Client) + +```powershell +# Load octopus.client assembly +Add-Type -Path "c:\octopus.client\Octopus.Client.dll" + +# Octopus variables +$octopusURL = "https://your-octopus-url" +$octopusAPIKey = "API-YOUR-KEY" +$spaceName = "default" +$tenantName = "MyTenant" +$tenantEnabled = $true + +$endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURL, $octopusAPIKey +$repository = New-Object Octopus.Client.OctopusRepository $endpoint +$client = New-Object Octopus.Client.OctopusClient $endpoint + +try +{ + # Get space + $space = $repository.Spaces.FindByName($spaceName) + $repositoryForSpace = $client.ForSpace($space) + + # Get tenant + $tenant = $repositoryForSpace.Tenants.FindByName($tenantName) + + # Enable/disable tenant + $tenant.IsDisabled = !$tenantEnabled + + # Update tenant + $repositoryForSpace.Tenants.Modify($tenant) +} +catch +{ + Write-Host $_.Exception.Message +} +``` + +
+
+C# + +```csharp +// If using .net Core, be sure to add the NuGet package of System.Security.Permissions +#r "path\to\Octopus.Client.dll" + +using Octopus.Client; +using Octopus.Client.Model; + +// Declare working variables +var octopusURL = "https://your-octopus-url"; +var octopusAPIKey = "API-YOUR-KEY"; +var spaceName = "default"; +var tenantName = "MyTenant"; +bool enabled = false; + +// Create repository object +var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey); +var repository = new OctopusRepository(endpoint); +var client = new OctopusClient(endpoint); + +try +{ + // Get space + var space = repository.Spaces.FindByName(spaceName); + var repositoryForSpace = client.ForSpace(space); + + // Get tenant + var tenant = repositoryForSpace.Tenants.FindByName(tenantName); + + // Enable/disable tenant + tenant.IsDisabled = !enabled; + + //update tenant + repositoryForSpace.Tenants.Modify(tenant); +} +catch (Exception ex) +{ + Console.WriteLine(ex.Message); + return; +} +``` + +
+
+Python3 + +```python +import json +import requests + +octopus_server_uri = 'https://your-octopus-url/api' +octopus_api_key = 'API-YOUR-KEY' +headers = {'X-Octopus-ApiKey': octopus_api_key} + + +def get_octopus_resource(uri): + response = requests.get(uri, headers=headers) + response.raise_for_status() + + return json.loads(response.content.decode('utf-8')) + + +def get_by_name(uri, name): + resources = get_octopus_resource(uri) + return next((x for x in resources if x['Name'] == name), None) + + +space_name = 'Default' +tenant_name = 'Your Tenant Name' +disable_tenant = False + +space = get_by_name('{0}/spaces/all'.format(octopus_server_uri), space_name) +tenant = get_by_name('{0}/{1}/tenants/all'.format(octopus_server_uri, space['Id']), tenant_name) + +tenant['IsDisabled'] = disable_tenant + +uri = '{0}/{1}/tenants/{2}'.format(octopus_server_uri, space['Id'], tenant['Id']) +response = requests.put(uri, headers=headers, json=tenant) +response.raise_for_status() +``` + +
+
+Go + +```go +package main + +import ( + "log" + "net/url" + + "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/client" + "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/spaces" + "github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/tenants" +) + +func main() { + apiURL, err := url.Parse("https://your-octopus-url") + if err != nil { + log.Println(err) + } + APIKey := "API-YOUR-KEY" + spaceName := "Default" + tenantName := "MyTenant" + enabled := true + + space := GetSpace(apiURL, APIKey, spaceName) + if space == nil { + log.Println(err) + } + + client := octopusAuth(apiURL, APIKey, space.ID) + + tenant := GetTenantByName(client, tenantName) + if tenant == nil { + log.Println(err) + } + + tenant.IsDisabled = !enabled + updatedTenant, err := client.Tenants.Update(tenant) + if err != nil { + log.Println(err) + } + + log.Printf("Tenant '%s' updated successfully. IsDisabled: %v", updatedTenant.Name, updatedTenant.IsDisabled) +} + +func octopusAuth(octopusURL *url.URL, APIKey string, spaceID string) *client.Client { + client, err := client.NewClient(nil, octopusURL, APIKey, spaceID) + if err != nil { + log.Println(err) + } + return client +} + +func GetSpace(octopusURL *url.URL, APIKey string, spaceName string) *spaces.Space { + client := octopusAuth(octopusURL, APIKey, "") + + spaceQuery := spaces.SpacesQuery{ + PartialName: spaceName, + } + + spaces, err := client.Spaces.Get(spaceQuery) + if err != nil { + log.Println(err) + } + + for _, space := range spaces.Items { + if space.Name == spaceName { + return space + } + } + + return nil +} + +func GetTenantByName(client *client.Client, tenantName string) *tenants.Tenant { + tenantQuery := tenants.TenantsQuery{ + Name: tenantName, + } + + tenants, err := client.Tenants.Get(tenantQuery) + if err != nil { + log.Println(err) + } + + if len(tenants.Items) == 1 { + return tenants.Items[0] + } + + return nil +} + + +``` + +
diff --git a/src/shared-content/scripts/find-variable-usage-scripts.include.md b/src/shared-content/scripts/find-variable-usage-scripts.include.md index d5f6946db6..e73eb627fa 100644 --- a/src/shared-content/scripts/find-variable-usage-scripts.include.md +++ b/src/shared-content/scripts/find-variable-usage-scripts.include.md @@ -36,6 +36,81 @@ $space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Heade Write-Host "Looking for usages of variable named $variableToFind in space: '$spaceName'" +# Function to process deployment steps +function Process-DeploymentSteps { + param( + $steps, + $project, + $gitRef = $null + ) + + $results = @() + # Loop through steps + foreach ($step in $steps) { + $props = $step | Get-Member | Where-Object { $_.MemberType -eq "NoteProperty" } + foreach ($prop in $props) { + $propName = $prop.Name + $json = $step.$propName | ConvertTo-Json -Compress -Depth 10 + if ($null -ne $json -and ($json -like "*$variableToFind*")) { + $result = [pscustomobject]@{ + Project = $project.Name + VariableSet = $null + MatchType = "Step" + Context = $step.Name + Property = $propName + AdditionalContext = $null + Link = "$octopusURL$($project.Links.Web)/deployments/process/steps?actionId=$($step.Actions[0].Id)" + } + + if ($gitRef) { + $result | Add-Member -MemberType NoteProperty -Name "GitRef" -Value $gitRef + } + + $results += $result + } + } + } + return $results +} + +# Function to process runbook steps +function Process-RunbookSteps { + param( + $steps, + $project, + $runbook, + $gitRef = $null + ) + + $results = @() + # Loop through steps + foreach ($step in $steps) { + $props = $step | Get-Member | Where-Object { $_.MemberType -eq "NoteProperty" } + foreach ($prop in $props) { + $propName = $prop.Name + $json = $step.$propName | ConvertTo-Json -Compress -Depth 10 + if ($null -ne $json -and ($json -like "*$variableToFind*")) { + $result = [pscustomobject]@{ + Project = $project.Name + VariableSet = $null + MatchType = "Runbook Step" + Context = $runbook.Name + Property = $propName + AdditionalContext = $step.Name + Link = "$octopusURL$($project.Links.Web)/operations/runbooks/$($runbook.Id)/process/$($runbook.RunbookProcessId)/steps?actionId=$($step.Actions[0].Id)" + } + + if ($gitRef) { + $result | Add-Member -MemberType NoteProperty -Name "GitRef" -Value $gitRef + } + + $results += $result + } + } + } + return $results +} + # Get all projects $projects = Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/projects/all" -Headers $header @@ -45,6 +120,20 @@ foreach ($project in $projects) { # Get project variables $projectVariableSet = Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/variables/$($project.VariableSetId)" -Headers $header + # Get all GitRefs for CaC project + if ($project.IsVersionControlled) { + $gitBranches = Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/projects/$($project.Id)/git/branches" -Headers $header + $gitTags = Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/projects/$($project.Id)/git/tags" -Headers $header + + $gitRefs = @() + foreach($branch in $gitBranches.Items) { + $gitRefs += $branch.CanonicalName + } + foreach($tag in $gitTags.Items) { + $gitRefs += $tag.CanonicalName + } + } + # Check to see if variable is named in project variables. $matchingNamedVariables = $projectVariableSet.Variables | Where-Object { $_.Name -ieq "$variableToFind" } if ($null -ne $matchingNamedVariables) { @@ -84,30 +173,23 @@ foreach ($project in $projects) { # Search Deployment process if enabled if ($searchDeploymentProcesses -eq $True) { - # Get project deployment process - $deploymentProcess = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/deploymentprocesses/$($project.DeploymentProcessId)" -Headers $header) - - # Loop through steps - foreach ($step in $deploymentProcess.Steps) { - $props = $step | Get-Member | Where-Object { $_.MemberType -eq "NoteProperty" } - foreach ($prop in $props) { - $propName = $prop.Name - $json = $step.$propName | ConvertTo-Json -Compress -Depth 10 - if ($null -ne $json -and ($json -like "*$variableToFind*")) { - $result = [pscustomobject]@{ - Project = $project.Name - VariableSet = $null - MatchType = "Step" - Context = $step.Name - Property = $propName - AdditionalContext = $null - Link = "$octopusURL$($project.Links.Web)/deployments/process/steps?actionId=$($step.Actions[0].Id)" - } - # Add and de-dupe later - $variableTracking += $result - } + if ($project.IsVersionControlled) { + # For CaC Projects, loop through GitRefs + foreach ($gitRef in $gitRefs) { + $escapedGitRef = [Uri]::EscapeDataString($gitRef) + $processUrl = "$octopusURL/api/$($space.Id)/projects/$($project.Id)/$($escapedGitRef)/deploymentprocesses" + # Get project deployment process + $deploymentProcess = (Invoke-RestMethod -Method Get -Uri $processUrl -Headers $header) + # Add and de-dupe later + $variableTracking += Process-DeploymentSteps -steps $deploymentProcess.Steps -project $project -gitRef $gitRef } } + else { + # Get project deployment process + $deploymentProcess = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/deploymentprocesses/$($project.DeploymentProcessId)" -Headers $header) + # Add and de-dupe later + $variableTracking += Process-DeploymentSteps -steps $deploymentProcess.Steps -project $project + } } # Search Runbook processes if enabled @@ -118,30 +200,23 @@ foreach ($project in $projects) { # Loop through each runbook foreach ($runbook in $runbooks.Items) { - # Get runbook process - $runbookProcess = (Invoke-RestMethod -Method Get -Uri "$octopusURL$($runbook.Links.RunbookProcesses)" -Headers $header) - - # Loop through steps - foreach ($step in $runbookProcess.Steps) { - $props = $step | Get-Member | Where-Object { $_.MemberType -eq "NoteProperty" } - foreach ($prop in $props) { - $propName = $prop.Name - $json = $step.$propName | ConvertTo-Json -Compress -Depth 10 - if ($null -ne $json -and ($json -like "*$variableToFind*")) { - $result = [pscustomobject]@{ - Project = $project.Name - VariableSet = $null - MatchType = "Runbook Step" - Context = $runbook.Name - Property = $propName - AdditionalContext = $step.Name - Link = "$octopusURL$($project.Links.Web)/operations/runbooks/$($runbook.Id)/process/$($runbook.RunbookProcessId)/steps?actionId=$($step.Actions[0].Id)" - } - # Add and de-dupe later - $variableTracking += $result - } + # For CaC Projects, loop through GitRefs + if ($project.IsVersionControlled) { + foreach ($gitRef in $gitRefs) { + $escapedGitRef = [Uri]::EscapeDataString($gitRef) + $processUrl = "$octopusURL/api/$($space.Id)/projects/$($project.Id)/$($escapedGitRef)/runbookprocesses/$($runbook.RunbookProcessId)" + # Get runbook process + $runbookProcess = (Invoke-RestMethod -Method Get -Uri $processUrl -Headers $header) + # Add and de-dupe later + $variableTracking += Process-RunbookSteps -steps $runbookProcess.Steps -project $project -runbook $runbook -gitRef $gitRef } } + else { + # Get runbook process + $runbookProcess = (Invoke-RestMethod -Method Get -Uri "$octopusURL$($runbook.Links.RunbookProcesses)" -Headers $header) + # Add and de-dupe later + $variableTracking += Process-RunbookSteps -steps $runbookProcess.Steps -project $project -runbook $runbook + } } } } diff --git a/src/shared-content/teamcity/teamcity-pack.include.md b/src/shared-content/teamcity/teamcity-pack.include.md index 8ed75f347f..075a7d99c8 100644 --- a/src/shared-content/teamcity/teamcity-pack.include.md +++ b/src/shared-content/teamcity/teamcity-pack.include.md @@ -2,7 +2,7 @@ Octopus supports multiple [package formats](/docs/packaging-applications/#supported-formats) for deploying your software. TeamCity can be configured to monitor your source control and package your applications when changes are made. -You configure TeamCity to package your applications by creating a [build configuration](https://www.jetbrains.com/help/teamcity/build-configuration.html), and adding a step to the configuration of runner type, **Octopus Deploy: Pack**. +You configure TeamCity to package your applications by creating a [build configuration](https://www.jetbrains.com/help/teamcity/creating-and-editing-build-configurations.html), and adding a step to the configuration of runner type, **Octopus Deploy: Pack**. 1. Give the step a name. 2. Enter the [package ID](/docs/packaging-applications/#package-id).