Skip to content

Commit

Permalink
Update docs to include octopus-tenantedDeploymentMode (#2622)
Browse files Browse the repository at this point in the history
  • Loading branch information
IsaacCalligeros95 authored Feb 6, 2025
1 parent 6c4ba09 commit 212f1b5
Showing 1 changed file with 8 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,14 @@ Octopus looks for tags applied to cloud resources to discover and create deploym

Tags in cloud resource templates are in the format `octopus-{scope}` and support the following for discovery. Note that only a single value is supported in tags at the moment.

| Tag | Required | Description | Example |
| --------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| `octopus-environment` | Yes | The name of the [environment](/docs/infrastructure/environments) the target can be used in during deployments. Only deployments matching the environment will discover the target. | `octopus-environment = Development` |
| `octopus-role` | Yes | The [target tag](/docs/infrastructure/deployment-targets/target-tags) that should be applied to the target. Only deployments with a step that matches the target tag will discover the target. | `octopus-role = PetShotFrontEnd` |
| `octopus-space` | No | The name of the [space](/docs/administration/spaces) the target can be used in. If present only deployments within the matching space can discover the target. | `octopus-space = PetShopTeam` |
| `octopus-project` | No | The name of the [project](/docs/projects) the target will be discovered by. If present only deployments for the matching project can discover the target. | `octopus-project = PetShop` |
| `octopus-tenant` | No | The name of the [tenant](/docs/projects) the target can be discovered for. If present only deployments for the matching tenant will discover the target. | `octopus-tenant = MyClient` |
| Tag | Required | Description | Example |
|----------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
| `octopus-environment` | Yes | The name of the [environment](/docs/infrastructure/environments) the target can be used in during deployments. Only deployments matching the environment will discover the target. | `octopus-environment = Development` |
| `octopus-role` | Yes | The [target tag](/docs/infrastructure/deployment-targets/target-tags) that should be applied to the target. Only deployments with a step that matches the target tag will discover the target. | `octopus-role = PetShotFrontEnd` |
| `octopus-space` | No | The name of the [space](/docs/administration/spaces) the target can be used in. If present only deployments within the matching space can discover the target. | `octopus-space = PetShopTeam` |
| `octopus-project` | No | The name of the [project](/docs/projects) the target will be discovered by. If present only deployments for the matching project can discover the target. | `octopus-project = PetShop` |
| `octopus-tenant` | No | The name of the [tenant](/docs/projects) the target can be discovered for. If present only deployments for the matching tenant will discover the target. | `octopus-tenant = MyClient` |
| `octopus-tenantedDeploymentMode` | No | The TenantedDeploymentMode for the target created in Octopus. If present the target within Octopus will use the mode provided, the allowed values are Untenanted, TenantedOrUntenanted or Tenanted | `octopus-tenantedDeploymentMode = Tenanted` |

## Add step to deployment process

Expand Down

0 comments on commit 212f1b5

Please sign in to comment.