Skip to content

Regenerate CLI reference (v0.42.0) - #587

Closed
Myothas wants to merge 1 commit into
masterfrom
cli-reference/v0.42.0
Closed

Myothas wants to merge 1 commit into
masterfrom
cli-reference/v0.42.0

Conversation

@Myothas

@Myothas Myothas commented Oct 19, 2026

Copy link
Copy Markdown
Member

Automated update generated by tools/gendocs in ankra-cli, with the CLI group in docs.json resynced by scripts/sync_cli_nav.py. Review the diff and merge to publish.

@ankra-platform

ankra-platform Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

✅ Run #233 succeeded

Run #233 for commit d263ac8 (pull request #587).

Stage Step Outcome Duration
build build success 2m 22s
checkout checkout success 16s
gate gate success 0s
publish publish skipped -
scan scan (tool=checkov) success 40s
scan scan (tool=semgrep) success 30s
scan scan (tool=trivy) success 46s

Open this run in Ankra

🔗 Details ↗ · Updated Oct 19, 2026, 9:51 AM UTC


Ankra AI review

Verdict: comments.

Docs-only regeneration of the CLI reference for v0.42.0: new provenance commands, secret variables, stdin-based credential entry, cluster-scoped delete/patch/describe, and live control-plane scaling. The content is internally consistent and the security-sensitive additions (stdin/password-stdin instead of keys on the command line, audited secret reveal, unknown-vs-refused distinction in provenance verify) are documented correctly. Only minor wording concerns, noted below.

Findings

  • [low] Proxmox parenthetical appears in every provider's control-plane docs (reference/cli/cluster.mdx:818)
    The AWS, DigitalOcean, Hetzner, Morpheus, OVH, Scaleway, UpCloud and ankracloud control-plane sections all now say "The controller count is 1 or 3 (1, 3 or 5 on Proxmox VE)". On a provider-specific page the Proxmox aside reads as if 5 controllers might be allowed there too; since this text is generated from shared CLI help, consider making the parenthetical conditional on the provider (or dropping it outside the Proxmox section) in the CLI source so the regenerated pages stay provider-accurate.

  • [low] TTL flag defaults of 0 sit outside the documented valid ranges (reference/cli/org.mdx:191)
    --demo-ttl-hours and --workspace-ttl-hours are documented as 1-720 and 1-168 respectively, but the flags table shows a default of 0, which is outside both ranges. If 0 means "leave unchanged / use the platform default", saying so in the description would save users from thinking 0 is a settable value; this likely needs a wording tweak in the CLI help text that generates this table.


Reviewed commit d263ac8. This review is read-only and advisory.

Comment thread reference/cli/cluster.mdx
The controller count can only be changed while the cluster is stopped, and
applies the next time the cluster is started.
Inspect and change the control plane configuration. The controller count
is 1 or 3 (1, 3 or 5 on Proxmox VE): etcd needs an odd number of voting

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.

[low] Proxmox parenthetical appears in every provider's control-plane docs

The AWS, DigitalOcean, Hetzner, Morpheus, OVH, Scaleway, UpCloud and ankracloud control-plane sections all now say "The controller count is 1 or 3 (1, 3 or 5 on Proxmox VE)". On a provider-specific page the Proxmox aside reads as if 5 controllers might be allowed there too; since this text is generated from shared CLI help, consider making the parenthetical conditional on the provider (or dropping it outside the Proxmox section) in the CLI source so the regenerated pages stay provider-accurate.

Ankra AI review. Read-only and advisory.

Comment thread reference/cli/org.mdx
| `--demo-cert-issuer` | | cert-manager ClusterIssuer to ask instead of the cluster's own; empty clears it |
| `--demo-ingress-class` | | Ingress class for demo ingresses; empty clears it |
| `--demo-tls-secret` | | Secret holding a certificate for the preview domain; empty clears it |
| `--demo-ttl-hours` | `0` | How long a PR demo lives by default, in hours (1-720) |

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.

[low] TTL flag defaults of 0 sit outside the documented valid ranges

--demo-ttl-hours and --workspace-ttl-hours are documented as 1-720 and 1-168 respectively, but the flags table shows a default of 0, which is outside both ranges. If 0 means "leave unchanged / use the platform default", saying so in the description would save users from thinking 0 is a settable value; this likely needs a wording tweak in the CLI help text that generates this table.

Ankra AI review. Read-only and advisory.

@Myothas

Myothas commented Oct 19, 2026

Copy link
Copy Markdown
Member Author

Superseded by the CLI reference regen for v0.43.0 (branch cli-reference/v0.43.0), which regenerates every page.

@Myothas Myothas closed this Oct 19, 2026
@Myothas
Myothas deleted the cli-reference/v0.42.0 branch October 19, 2026 12:02
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