Skip to content

ccloud CLI: Document new commands from SDK v6 update (ccloud-private#122)#22950

Open
jordanlewis wants to merge 2 commits intomainfrom
jl/ccloud-cli-new-commands-docs
Open

ccloud CLI: Document new commands from SDK v6 update (ccloud-private#122)#22950
jordanlewis wants to merge 2 commits intomainfrom
jl/ccloud-cli-new-commands-docs

Conversation

@jordanlewis
Copy link
Member

Summary

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 commands documented

Cluster commands

Command Subcommands Description
ccloud cluster connection-string Get a formatted connection string
ccloud cluster database list, create, delete Manage databases within a cluster
ccloud cluster backup list, config get, config update View backups and manage backup configuration
ccloud cluster restore list, create Restore from backups
ccloud cluster versions List available CockroachDB major versions
ccloud cluster version-deferral get, set Manage version upgrade deferral (Advanced)
ccloud cluster blackout-window list, create, delete Manage maintenance blackout windows (Advanced)
ccloud cluster maintenance get, set, delete Configure maintenance windows (Advanced)
ccloud cluster disruption get, set, clear Manage disruption budget (Advanced)
ccloud cluster cmek get View CMEK configuration (Advanced)
ccloud cluster log-export get, enable, disable Configure log export (Advanced)
ccloud cluster metric-export cloudwatch, datadog, prometheus (each: get/enable/disable) Configure metric export (Advanced)
ccloud cluster networking egress-rule list, create, delete Manage egress traffic rules (Advanced)
ccloud cluster networking egress-private-endpoint list, get, create, delete Manage egress private endpoints (Advanced)
ccloud cluster networking client-ca-cert get, set, update, delete Manage client CA certificates (Advanced)
ccloud cluster networking private-endpoint services, create-services, connections, add-connection, delete-connection Manage private endpoint connectivity (Advanced)

Top-level commands

Command Subcommands Description
ccloud organization get View organization information
ccloud audit list View audit logs
ccloud billing invoice list, get View invoices and billing
ccloud folder list, get, create, update, delete, contents Manage folders
ccloud service-account list, get, create, delete + api-key subcommands Manage service accounts
ccloud jwt-issuer list, get, create, update, delete Manage JWT/OIDC issuers
ccloud replication list, get, create, update Manage physical cluster replication

Notes

  • All Advanced/Dedicated-only features are wrapped in the existing filter-content section pattern
  • New sections follow the established formatting: {% include_cached copy-clipboard.html %} before code blocks, ~~~ shell for commands, ~~~ for output
  • Example output is realistic but uses placeholder IDs
  • This is a draft PR — please review for accuracy and completeness before merging

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)
@netlify
Copy link

netlify bot commented Mar 4, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 4fff0a7
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69a7b31a7465a1000839cbb1

@github-actions
Copy link

github-actions bot commented Mar 4, 2026

@netlify
Copy link

netlify bot commented Mar 4, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 4fff0a7
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69a7b31a7465a1000839cbb3

@jordanlewis jordanlewis requested a review from fantapop March 4, 2026 03:27
@netlify
Copy link

netlify bot commented Mar 4, 2026

Netlify Preview

Name Link
🔨 Latest commit 4fff0a7
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69a7b31a3b140f0008a7a6d7
😎 Deploy Preview https://deploy-preview-22950--cockroachdb-docs.netlify.app
📱 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.

- 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>
@laurenbarker laurenbarker requested a review from a team March 4, 2026 19:36
@jordanlewis jordanlewis marked this pull request as ready for review March 4, 2026 19:43
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.

1 participant