Skip to content

Commit 7939ee3

Browse files
flomedjadjwfyi
authored andcommitted
doc: clarify cluster registration wording and fix prose issues in overview and connect-argocd pages
1 parent 895d573 commit 7939ee3

3 files changed

Lines changed: 10 additions & 8 deletions

File tree

platform/integrations/argocd/connect-argocd.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ stringData:
151151

152152
### On a tenant cluster
153153

154-
Add the `integrations.argoCD` block to the tenant cluster's `vcluster.yaml`. The `connector` field references the Secret name from Step 1.
154+
Add the `integrations.argoCD` block to the tenant cluster's `vcluster.yaml`. The `connector` field references the Secret name from [Step 1](#step-1-create-a-connector).
155155

156156
```yaml
157157
integrations:

platform/integrations/argocd/deploy-applications.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ An `ArgoCDApplicationTemplate` is a reusable Argo CD ApplicationSpec. Create one
3131

3232
<Flow>
3333
<Step>
34-
Click <Label>Templates</Label> in the left sidebar, then select <Label>Argo CD Templates</Label>.
34+
Click <Label>Argo CD Templates</Label> in the left sidebar.
3535
</Step>
3636
<Step>
3737
Click <Button>Add ArgoCD Application Template</Button>.

platform/integrations/argocd/overview.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,12 @@ A single connector can be referenced by many clusters. You create it once and re
2727

2828
### Cluster registration
2929

30-
When a tenant cluster or control plane cluster references a connector, Platform registers it as a destination cluster in Argo CD using the Platform proxy as the API server endpoint and a scoped access key as the bearer token. This means:
30+
When a tenant cluster or control plane cluster references a connector, Platform registers that cluster as
31+
a destination in Argo CD. The registration uses the Platform proxy as the API server endpoint and a
32+
scoped access key as the bearer token. This means:
3133

3234
- The cluster's Kubernetes API server does not need to be publicly reachable from Argo CD.
33-
- Access is scoped per clusterArgo CD uses the Platform-issued access key, not a long-lived kubeconfig.
35+
- Access is scoped per cluster. Argo CD authenticates using a Platform-issued access key, not a long-lived kubeconfig.
3436
- When a tenant cluster is deleted or the integration is disabled, Platform deregisters it from Argo CD automatically.
3537

3638
For Akuity, registration also provisions an agent inside the cluster (see [Connect to Akuity](./connect-akuity.mdx) for details).
@@ -39,15 +41,15 @@ For Akuity, registration also provisions an agent inside the cluster (see [Conne
3941

4042
The integration introduces two Platform-level resources:
4143

42-
- **`ArgoCDApplication`**: Represents a single Argo CD application with a vCluster-aware destination type — either the tenant cluster itself (`vcluster`) or the control plane cluster it runs on (`host`). Platform reconciles these into actual Argo CD Application objects.
43-
- **`ArgoCDApplicationTemplate`**: A reusable Argo CD ApplicationSpec with named parameters. Templates allow the same application definition to be referenced across many tenant clusters without duplication.
44+
- **`ArgoCDApplication`**: Represents an Argo CD application targeted at either the tenant cluster (`vcluster`) or its control plane cluster (`host`). Platform creates the corresponding Argo CD Application object and keeps it in sync
45+
- **`ArgoCDApplicationTemplate`**: A reusable Argo CD ApplicationSpec with named parameters. Templates allow the same application definition to be referenced across many tenant clusters and control plane clusters without duplication.
4446

4547
These resources live in the Platform project namespace and are managed by Platform, not by Argo CD directly.
4648

4749
## Standard Argo CD vs Akuity
4850

49-
Use the standard Argo CD integration when you operate your own Argo CD server and want direct API access. Use Akuity when you use Akuity's managed Argo CD service, which uses an in-cluster agent rather than direct API server access.
50-
51+
Use the standard Argo CD integration if you run your own Argo CD server.
52+
Choose the Akuity integration if your Argo CD instance is managed by Akuity. Akuity connects to clusters through an in-cluster agent rather than direct API access.
5153
| | Standard Argo CD | Akuity |
5254
|---|---|---|
5355
| Argo CD hosting | Self-hosted | Akuity-managed |

0 commit comments

Comments
 (0)