Commit 192bb12
ccloud CLI: Document new commands from SDK v6 update (ccloud-private#122) (#22950)
* ccloud CLI: document new commands from SDK v6 update
Documents all new command groups added in cockroachlabs/ccloud-private#122,
which updated the ccloud CLI from SDK v3 to v6 and added comprehensive
support for new Cloud API features.
New command groups documented:
- ccloud cluster connection-string
- ccloud cluster database (list/create/delete)
- ccloud cluster backup (list/config get/config update)
- ccloud cluster restore (list/create)
- ccloud cluster versions
- ccloud cluster version-deferral (get/set)
- ccloud cluster blackout-window (list/create/delete)
- ccloud cluster maintenance (get/set/delete)
- ccloud cluster disruption (get/set/clear)
- ccloud cluster cmek get
- ccloud cluster log-export (get/enable/disable)
- ccloud cluster metric-export (cloudwatch/datadog/prometheus)
- ccloud cluster networking egress-rule (list/create/delete)
- ccloud cluster networking egress-private-endpoint (list/get/create/delete)
- ccloud cluster networking client-ca-cert (get/set/update/delete)
- ccloud cluster networking private-endpoint (services/connections/etc.)
- ccloud organization get
- ccloud audit list
- ccloud billing invoice (list/get)
- ccloud folder (list/get/create/update/delete/contents)
- ccloud service-account (list/get/create/delete + api-key management)
- ccloud jwt-issuer (list/get/create/update/delete)
- ccloud replication (list/get/create/update)
* Fix ccloud CLI docs: correct flags, commands, and output formats
- backup config update: --frequency-minutes/--retention-days → --frequency/--retention
- restore create: backup ID is --backup-id flag, not positional arg; add --source-cluster-id and --type
- version-deferral set: policy is --policy flag, not positional; list valid values
- maintenance set: add required --duration flag, document --offset alternative, fix output format
- disruption: rewrite section - it's disruption simulation, not "disruption budget"
- log-export enable: --log-group → --log-name; fix output format
- egress-rule create: remove nonexistent --ports flag; add --description
- egress-private-endpoint create: --name/--service-name → --region/--target-service-identifier/--target-service-type
- private-endpoint: fix command names (services → service list, add-connection → connection add, etc.)
- private-endpoint: add missing trusted-owner subcommand group (list/add/remove)
- replication create: --source-cluster/--target-cluster → --primary-cluster/--standby-cluster
- replication update: --cutover → --status FAILING_OVER; add --failover-at
- replication list: add required cluster name argument
- folder list: PARENT ID → PARENT PATH, add TYPE column
- Fix output table columns across multiple commands to match actual CLI output
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* Fix ccloud CLI docs: correct output formats, flags, and command syntax
Verified all new command documentation against the actual ccloud codebase
(testdata files and source code) and corrected:
- Output formats: backup config/versions/version-deferral/cmek/client-ca-cert/
org get all use key-value format, not tables
- Column names: backup list (AS OF TIME), versions (RELEASE TYPE/SUPPORT
STATUS/SUPPORT END/ALLOWED UPGRADES), billing (STATUS/TOTAL), folder
contents (ID/NAME/TYPE/PARENT PATH), service-account list (no CREATOR)
- Status values: restore (SUCCESS/PENDING), egress-private-endpoint
(AVAILABLE/PENDING), replication create (STARTING)
- Positional args vs flags: folder create, service-account create, api-key
create all take name as positional arg not --name flag; api-key list uses
--service-account-id flag; api-key delete takes 1 arg not 2
- Connection string output includes Connection String header and Parameters
section
- Prometheus uses "metric scrape endpoint" not "metric export"
- Various output message formatting (Successfully vs Success!, casing)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* Fix metric export and client-ca-cert output formats
- CloudWatch/Datadog/Prometheus enable: add missing Cluster and Status
lines to match source code output
- Prometheus enable: revert incorrect "scrape endpoint" wording back to
"metric export" to match source
- Datadog enable: fix --site flag value to uppercase (US5) to match
expected enum values
- client-ca-cert set/update: fix "Success!" prefix to "Successfully" and
add Status line to match source
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* Refactor into reference vs get started content
* Fix links
* Ryan comments
* Apply suggestions from code review
Co-authored-by: bsanchez-the-roach <brandon.sanchez@cockroachlabs.com>
* Address Brandon comments
* Fix typos
* Correct plan names
---------
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Joe Lodin <joe.lodin@cockroachlabs.com>
Co-authored-by: bsanchez-the-roach <brandon.sanchez@cockroachlabs.com>1 parent 30a9d41 commit 192bb12
File tree
8 files changed
+1633
-456
lines changed- src/current
- _includes
- cockroachcloud/limitations
- v26.1/sidebar-data
- cockroachcloud
- releases
8 files changed
+1633
-456
lines changedLines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 13 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
606 | 606 | | |
607 | 607 | | |
608 | 608 | | |
609 | | - | |
610 | | - | |
| 609 | + | |
| 610 | + | |
| 611 | + | |
| 612 | + | |
| 613 | + | |
| 614 | + | |
| 615 | + | |
| 616 | + | |
| 617 | + | |
| 618 | + | |
| 619 | + | |
| 620 | + | |
| 621 | + | |
611 | 622 | | |
612 | 623 | | |
613 | 624 | | |
| |||
0 commit comments