docs: add Use the ADP CLI section with GitOps how-to#112
Draft
birdayz wants to merge 1 commit into
Draft
Conversation
The rpk ai CLI can manage every ADP resource declaratively from YAML manifests, but the docs only shipped the autogenerated command reference. Operators automating ADP in Git and CI had no guide for the apply/diff workflow, its reconcile semantics, or drift gating. Add a top-level "Use the ADP CLI" section (beta) with two pages: - index.adoc: what rpk ai is, install, connect (reuses rpk cloud login and the active profile), the resource command surface, and output formats. Links to the existing connect-agent setup walkthrough rather than duplicating it. - gitops.adoc: export with get -o yaml, preview with diff, reconcile with apply, directory/stdin/multi-document inputs, CI drift gating, the declarative omitted-means-zero caveat, and troubleshooting. Covers llm, mcp, oauth, oauth-client, and agent. Wire both into the nav between Routing & LLM Settings and Reference. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
👷 Deploy request for redpanda-agentic-data-plane pending review.Visit the deploys page to approve it
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add a new top-level Use the ADP CLI section (beta) with two pages, and wire them into the nav:
modules/cli/pages/index.adoc) — whatrpk aiis, how to install it, how to connect it, the resource command surface, and output formats.modules/cli/pages/gitops.adoc) — therpk ai <resource> apply/diffworkflow.Why
The
rpk aiCLI can manage every ADP resource declaratively from YAML manifests, but the docs only shipped the autogenerated command reference. Operators automating ADP in Git and CI had no guide for the apply/diff workflow, its reconcile semantics, or drift gating. GitOps is a first-class CLI workflow and belongs in a guide section distinct from the command reference, the same split Kubernetes, Confluent, and Databricks use.Implementation details
New module
modules/cli, both pages marked:page-beta:because the ADP CLI and GitOps are beta.rpk ai install) and connect (reuses therpk cloud logintoken and the active profile, with--rpai-endpointfor one-off overrides). It links to the existinggateway:connect-agent.adocsetup walkthrough rather than forking the install steps, so there is one source of truth.diffexits non-zero on drift for CI gating. It coversllm,mcp,oauth,oauth-client, andagent, with an exported manifest example, a worked apply/diff cycle, the declarative omitted-means-zero caveat, and troubleshooting.nav.adoc: the section sits between Routing & LLM Settings and Reference.References
rpk aicommand reference:reference:rpk/rpk-ai/rpk-ai.adocgateway:connect-agent.adoc