Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename target roles to target tags on the Deployment targets page #2238

Merged
merged 7 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/pages/docs/infrastructure/deployment-targets/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2023-01-01
modDate: 2024-04-17
title: Deployment targets
description: How to configure deployment targets in Octopus
navOrder: 10
Expand Down Expand Up @@ -32,23 +32,23 @@ Deployment targets are added in different ways, depending on the type of target
- [Offline package drop](/docs/infrastructure/deployment-targets/offline-package-drop)
- [Cloud regions](/docs/infrastructure/deployment-targets/cloud-regions)

## Target roles \{#target-roles}
## Target tags (formerly target roles) \{#target-roles}

<TargetRoles />

### Add target roles \{#create-target-roles}
### Add target tags \{#create-target-roles}

Roles are created and saved in the database as soon as you assign them to a deployment target.
Target tags are created and saved in the database as soon as you assign them to a deployment target.

Decide on the naming convention you will use before creating your first target role as it's not possible to change the case after the role has been created, for instance, all lowercase to camel case.
Decide on the naming convention you will use before creating your first target tag as it's not possible to change the case after the target tag has been created, for instance, all lowercase to camel case.

1. Register a deployment target or click on an already registered deployment target and go to **Settings**.
2. In the **Target Roles** field, enter the target role you'd like to use (no spaces).
2. In the **Target Tags** field, enter the target tag you'd like to use (no spaces).
3. Save the target settings.

The role has been created and assigned to the deployment target and can be added to other deployment targets.
The target tag has been created and assigned to the deployment target and can be added to other deployment targets.

You can check all the roles assigned to your deployment targets from the **Infrastructure** tab.
You can check all the target tags assigned to your deployment targets from the **Infrastructure** tab.

## Dynamic infrastructure

Expand Down
11 changes: 8 additions & 3 deletions src/shared-content/infrastructure/target-roles.include.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
[Getting Started - Machine Roles](https://www.youtube.com/watch?v=AU8TBEOI-0M)

Before you can deploy software to your deployment targets, you need to tag them with target roles. This ensures you deploy the right software to the right deployment targets. Typical target roles include:
:::div{.info}
**Target roles** are **target tags** from Octopus Deploy **2024.2** onwards. The functionality remains the same. This is only a name change to make our terminology clearer.
:::

Before you can deploy software to your deployment targets, you need to associate them with target tags. This ensures you deploy the right software to the right deployment targets. Typical target tags include:

- product-cluster
- web-server
- app-server
- db-server
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth adding a cluster-like tag name in here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added product-cluster to the top of the list


Using target roles means the infrastructure in each of your environments doesn't need to be identical and the deployment process will know which deployment targets to deploy your software to.
Using target tags means the infrastructure in each of your environments doesn't need to be identical and the deployment process will know which deployment targets to deploy your software to.

Deployment targets can have more than one role, and more than one deployment target can have the same role, but every deployment target must have at least one role.
Deployment targets can have more than one target tag, and more than one deployment target can have the same tag, but every deployment target must have at least one tag.

Loading