Skip to content

Commit 6e0421c

Browse files
authored
Merge branch 'main' into improve-ad-docs
2 parents 1ff080b + fdde092 commit 6e0421c

21 files changed

Lines changed: 236 additions & 203 deletions

File tree

18.4 KB
Loading
18.9 KB
Loading
8.54 KB
Loading
26.2 KB
Loading
46.5 KB
Loading
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"width":1019,"height":290,"updated":"2026-03-03T01:07:53.858Z"}

src/pages/docs/argo-cd/annotations/cluster-annotations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ hideInThisSectionHeader: true
1010

1111
By default, a Kubernetes cluster will use `docker.io` as the image registry when none is defined. This means that if an image is defined without the registry, for example `nginx/nginx:latest`, then this image will be resolved from the `docker.io` registry.
1212

13-
This default registry can be changed via the [kubeadm init --image-repository](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-init/) command & flag. When executing the [Update Argo CD Image Tags](/docs/argo-cd/steps/update-application-image-tags) step, Octopus will exactly match the specified image using the registry and name.
13+
This default registry can be changed via the [kubeadm init --image-repository](https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-init/) command and flag. When executing the [Update Argo CD Image Tags](/docs/argo-cd/steps/update-application-image-tags) step, Octopus will exactly match the specified image using the registry and name.
1414

15-
If the default cluster version has been changed, then Octopus needs to be made aware so that it correctly matches images.
15+
If the default cluster registry has been changed, then Octopus needs to be made aware so that it correctly matches images.
1616

1717
:::div{.info}
1818
If the cluster default registry has not been changed, then you do not need to do the following steps.
1919
:::
2020

2121
## Setting the default container registry annotation
2222

23-
To make Octopus aware of a clusters default registry, an annotation needs to be added to each cluster object in Argo CD instance.
23+
To make Octopus aware of a cluster's default registry, an annotation needs to be added to each cluster object in Argo CD instance.
2424

2525
The annotation and value is:
2626

@@ -34,7 +34,7 @@ For example:
3434
argo.octopus.com/default-container-registry : my-company-registry.com
3535
```
3636
37-
This should be added via the Argo CD web UI by selecting from the menu Settings --> Clusters, then editing the annotations
37+
This should be added via the Argo CD web UI by navigating to **Settings Clusters**, then editing the annotations
3838
field on the cluster of interest.
3939
4040
![Default Registry Cluster Annotation](/docs/img/argo-cd/default-registry-annotation.png)

src/pages/docs/argo-cd/annotations/helm-annotations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Note that while the scoping annotation for the project/environment is defined fo
4949

5050
## Details
5151

52-
For Octopus to be able to update the tag of a container image, it must know the fully qualified name, including the registry. An example of a fully qualified name is: `docker.io/nginx/nginx:1.29.1`. This is important so that Octopus doesn't erroneously update an image from a different registry. For example: images may be set to be sourced from a company-managed registry, where only vetted & tested tags are added. In this case, we don't want to update an image that looks like this: `my-company-registry.com/nginx/nginx:1.18.1`.
52+
For Octopus to be able to update the tag of a container image, it must know the fully qualified name, including the registry. An example of a fully qualified name is: `docker.io/nginx/nginx:1.29.1`. This is important so that Octopus doesn't erroneously update an image from a different registry. For example: images may be set to be sourced from a company-managed registry, where only vetted and tested tags are added. In this case, we don't want to update an image that looks like this: `my-company-registry.com/nginx/nginx:1.18.1`.
5353

5454
As described above however, the structure of Helm values files can vary significantly. Rather than Octopus guessing (and possibly making a mistake), the onus is on you to specify a Helm-template string that builds a fully qualified name. Octopus can then use this to match on containers being updated and can then use this information to update the specific Helm value that contains the image tag.
5555

src/pages/docs/argo-cd/annotations/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ spec:
4747
path: ./
4848
```
4949
50-
If the source is named, then the annotations must also source-scoped.
50+
If the source is named, then the annotations must also be source-scoped.
5151
5252
```yaml
5353
apiVersion: argoproj.io/v1alpha1
@@ -127,15 +127,15 @@ spec:
127127
...
128128
```
129129

130-
### Generating the yaml annotations
130+
### Generating the YAML annotations
131131

132-
To help generate the correct annotations, in the Octopus UI there is a form that allows for easy selection of projects, environments and/or tenants and the correct scoping annotations will be generated for you.
132+
To help generate the correct annotations, the Octopus UI provides a form that lets you select projects, environments, and/or tenants, and the correct scoping annotations will be generated for you.
133133

134134
To find this form go to:
135135

136136
1. Navigate to **Infrastructure ➜ Argo CD Instances**, then click the name of the relevant Argo CD instance
137137
2. On the Argo CD instance Settings page, click the **Generate Scoping Annotations** button
138-
3. In the drawer, you can select a **Project**, **Environment** and optionally a **Tenant**. The annotation yaml will be generated and can be copied directly into the manifest.
138+
3. In the drawer, you can select a **Project**, **Environment** and optionally a **Tenant**. The annotation YAML will be generated and can be copied directly into the manifest.
139139

140140
:::figure
141141
![Generate Scoping Annotations drawer](/docs/img/argo-cd/generate-scoping-annotations-drawer.png)

src/pages/docs/argo-cd/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pubDate: 2025-09-15
44
modDate: 2026-02-22
55
title: Argo CD deployments with Octopus
66
navTitle: Overview
7-
description: Octopus Deploy can help you manage your Argo CD applications navigate lifecycle promotion
7+
description: Octopus Deploy manages your Argo CD applications' environment promotion
88
navSection: Argo CD
99
navOrder: 28
1010
hideInThisSectionHeader: true
@@ -18,12 +18,12 @@ Octopus makes it easy to improve your Argo CD deployments with environment model
1818

1919
Argo CD excels at synchronizing manifests to clusters and provides a powerful UI to verify and troubleshoot deployments.
2020

21-
However, it treats each of your applications as independent entities, meaning there's no `codified` relationship between staging and production installations of your applications. Because of this, you need to manage this staging/production relationship and promotion between them through external mechanisms, eg:
21+
However, it treats each of your applications as independent entities, meaning there's no *codified* relationship between staging and production installations of your applications. Because of this, you need to manage this staging/production relationship and promotion between them through external mechanisms, e.g.:
2222

2323
- Manual file manipulations
2424
- Custom scripts, run automatically or via Jenkins/CI tooling
2525

26-
The Octopus/Argo integration means your Argo Applications can be updated and deployed via an Octopus Deployment Process (or runbook). Which in turn means your Applications can be safely promoted through a controlled lifecycle.
26+
The Octopus/Argo integration means your Argo Applications can be updated and deployed via an Octopus Deployment Process (or runbook), which in turn means your Applications can be safely promoted through a controlled lifecycle.
2727

2828
Octopus makes integrating and deploying with Argo CD simple:
2929

0 commit comments

Comments
 (0)