Skip to content

doc: Add first draft documentation for ArgoCD v2 integration#2071

Open
flomedja wants to merge 4 commits into
loft-sh:mainfrom
flomedja:DOC-1398-first-documentation-draft-for-enabling-feature-load-testing
Open

doc: Add first draft documentation for ArgoCD v2 integration#2071
flomedja wants to merge 4 commits into
loft-sh:mainfrom
flomedja:DOC-1398-first-documentation-draft-for-enabling-feature-load-testing

Conversation

@flomedja
Copy link
Copy Markdown
Contributor

@flomedja flomedja commented May 7, 2026

Content Description

Adds a new page for v2 of ArgoCD integration.

Preview Link

https://deploy-preview-2071--vcluster-docs-site.netlify.app/docs/platform/next/integrations/argocd/overview

Internal Reference

Closes DOC-1398

AI review: mention @claude in a comment to request a review or changes. See CONTRIBUTING.md for available commands.

FORK LIMITATION: @claude does not work on pull requests opened from forks. GitHub Actions cannot access the required secrets for fork-originated PRs. To use AI review, push your branch directly to this repository.

@netlify /docs

@flomedja flomedja requested a review from a team as a code owner May 7, 2026 19:44
@netlify
Copy link
Copy Markdown

netlify Bot commented May 7, 2026

Deploy Preview for vcluster-docs-site ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit aba853c
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/6a0354efc41eb900083b33c5
😎 Deploy Preview https://deploy-preview-2071--vcluster-docs-site.netlify.app/docs
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

@flomedja flomedja force-pushed the DOC-1398-first-documentation-draft-for-enabling-feature-load-testing branch from 2bf95f2 to 024506f Compare May 7, 2026 19:53
Comment thread platform/integrations/argocd-v2.mdx Outdated
Comment thread platform/integrations/argocd-v2.mdx Outdated
Comment thread platform/integrations/argocd-v2.mdx Outdated
Comment thread platform/integrations/argocd-v2.mdx Outdated
Comment thread platform/integrations/argocd-v2.mdx Outdated

## Step 2: Enable the connector on a cluster

### On a tenant cluster
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Need UI component here, I only see legacy one. And legacy needs to be marked as deprecated.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Legacy deprecation is done — legacy.mdx opens with a :::warning Deprecated admonition linking to the new guides. The UI navigation labels (new Connectors tab, ArgoCD Apps tab) still need verification against the actual deployed UI before this merges.

Comment thread platform/integrations/argocd-v2.mdx Outdated
Comment thread platform/integrations/argocd-v2.mdx Outdated
Comment thread platform/integrations/argocd-v2.mdx Outdated
Comment thread platform/integrations/argocd-v2.mdx Outdated
Comment thread platform/integrations/argocd-v2.mdx Outdated
@djwfyi
Copy link
Copy Markdown
Collaborator

djwfyi commented May 7, 2026

I'm going to do a pass. There are some structural issues with the information architecture that need addressing that are really hard to convey in PR comments. I can also weave in fixes for most of the comments from @cbron when I do it.

@djwfyi
Copy link
Copy Markdown
Collaborator

djwfyi commented May 7, 2026

Restructure: single page → focused guides

The original argocd-v2.mdx was trying to be an explanation page, a connector setup guide, an Akuity guide, and an application deployment guide all at once — with three levels of nested tabs as a result. I've split it into a proper folder structure:

platform/integrations/argocd/
  overview.mdx           — explanation: concepts, connectors, registration, when Argo CD vs Akuity
  connect-argocd.mdx     — how-to: standard Argo CD connector end-to-end
  connect-akuity.mdx     — how-to: Akuity connector + agent provisioning
  deploy-applications.mdx — how-to: templates, inline spec, new/existing cluster, target: host
  legacy.mdx             — original project-level integration (deprecated)

The legacy argocd.mdx moves into the folder as legacy.mdx with a deprecation admonition. A netlify.toml redirect sends the old /docs/platform/integrations/argocd URL to the legacy page so existing bookmarks still land somewhere useful.

cbron comments addressed in this pass:

  • Control plane cluster added as a fourth feature bullet
  • "CLI" tab labels → "Platform UI" / "YAML"
  • Agent sizing fields explained with implementation detail (akuityAgentSize is an Akuity API concept; akuityRepoServerMemory sets both requests and limits)
  • Disabling warning expanded to explicitly cover vcluster.yaml, VirtualClusterInstance, and Cluster objects (confirmed from controller code)
  • "Helm values" replaced with vcluster.yaml throughout
  • New-vs-existing cluster tabs added to the UI deployment flow
  • target: host given its own subsection with a warning covering access boundaries, prerequisites, and risks
  • Legacy doc marked deprecated with links to the new guides

Still needs before merge:

  • UI navigation labels (Connectors tab, ArgoCD Apps tab, sidebar label for clusters) need verification against the deployed UI — flagged on the relevant review comments

@djwfyi
Copy link
Copy Markdown
Collaborator

djwfyi commented May 7, 2026

Question for review: platform/how-to/gitops-end-to-end.mdx currently links to the legacy Argo CD integration for the section on enabling ArgoCD on a project and configuring SSO/App Project mapping. I've updated the link to point to legacy.mdx to fix the broken build, but this page likely needs a broader update to cover the new connector-based flow (registering clusters, deploying applications via deploy.argoCD). Should that be in scope for this PR or tracked separately?

@djwfyi
Copy link
Copy Markdown
Collaborator

djwfyi commented May 7, 2026

Question for review: platform/administer/projects/create.mdx has a step that says "there are a couple of other integrations that can be configured" and points to the legacy Argo CD doc. With the new integration, Argo CD connectors are configured at the cluster level rather than the project level, so both the link and the step text are likely stale. Should this step be updated or removed as part of this PR, or tracked separately?

Optionally select a cluster template, then click <Button>Configure</Button>.
</Step>
<Step>
Select the <Label>ArgoCD Apps</Label> tab in the cluster creation form.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The options to deploy applications From the UI at creation didn't exist., either for the tenant or the host cluster. Is it something we want to add ?

@cbron @vaidaslamanauskas @andyluak

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For tenant clusters yes that is core workflow: I want to deploy this vcluster with this 3 argoApps installed to it.
For host clusters it would just flow through same workflow but with target host. Otherwise I don't think it makes sense to do a direct host cluster deploy tie in at vcluster creation time, those are separate objects.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This makes sense to me. @vaidaslamanauskas can you also take a look please ?

@djwfyi
Copy link
Copy Markdown
Collaborator

djwfyi commented May 8, 2026

Finding: authType is not a real connector Secret field

While verifying the YAML examples against the controller source, I found that authType is not read by the controller at all. The implementation in pkg/controllers/argocdapplication/helpers.go and argocd_client.go reads token, username, and password directly — if token is set it uses bearer token auth, otherwise it falls back to username/password. There is no authType key in the controller constants.

The original draft included authType: "token"" and authType: "basic"" in both the connect-argocd.mdx and connect-akuity.mdx YAML examples, and listed it as a required field in the reference tables. These have been removed in the latest commit. The conditional language in the token, username, and password table rows has been updated to reflect how the controller actually selects the auth method.

Copy link
Copy Markdown
Contributor

@cbron cbron left a comment

Choose a reason for hiding this comment

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

Looks like everything I commented on is resolved except for app deploy at creation time. Feel free to merge when thats added and docs team approves.

flomedja and others added 4 commits May 12, 2026 09:49
Split the single argocd-v2.mdx page into a folder of four focused files:
- overview.mdx: explanation of concepts (connectors, registration, ArgoCDApplication)
- connect-argocd.mdx: how-to for standard Argo CD connector
- connect-akuity.mdx: how-to for Akuity connector with agent sizing detail
- deploy-applications.mdx: how-to for application templates and deployment

Move the legacy project-level integration (argocd.mdx) into the folder as
legacy.mdx with a deprecation admonition. Add a netlify.toml redirect for
the old /docs/platform/integrations/argocd URL to the legacy page.

Addresses review feedback: CLI tab labels renamed to YAML, Helm values
language replaced with vcluster.yaml, disabling warning expanded to cover
VCI and Cluster objects, agent sizing fields explained with implementation
detail, target: host given its own section with security warnings, and
new-vs-existing cluster tabs added for UI deployment flow.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Update three pages that referenced the removed argocd.mdx:
- what-are-projects.mdx → argocd/overview.mdx (general integration link)
- gitops-end-to-end.mdx → argocd/legacy.mdx (SSO/App Project content is legacy)
- projects/create.mdx → argocd/legacy.mdx (project-level integration is legacy)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@flomedja flomedja force-pushed the DOC-1398-first-documentation-draft-for-enabling-feature-load-testing branch from 7bc83fc to aba853c Compare May 12, 2026 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants