Skip to content

feat: add understackctl docs#1894

Open
mfencik wants to merge 1 commit intomainfrom
understackctl_docs
Open

feat: add understackctl docs#1894
mfencik wants to merge 1 commit intomainfrom
understackctl_docs

Conversation

@mfencik
Copy link
Copy Markdown
Contributor

@mfencik mfencik commented Mar 30, 2026

generated by Kiro, please verify properly.

@mfencik mfencik requested review from abhimanyu003 and cardoe March 30, 2026 18:52
@mfencik mfencik force-pushed the understackctl_docs branch from fb935fc to 0032537 Compare March 30, 2026 18:57
| `UC_DEPLOY_SSH_FILE` | `argocd-secrets` | Path to SSH key for deploy repo access |
| `DNS_ZONE` | secret generators, `helm-config` | DNS zone for service endpoints (e.g. `example.com`) |
| `UC_DEPLOY_EMAIL` | `certmanager-secrets` | Email address for Let's Encrypt certificates |
| `UC_AIO` | `quickstart` | Set for all-in-one deployments |
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.

The bottom 6 are still there but need to be removed.

- `--name`, `-n` — Name of the Nautobot CR (auto-detected if omitted).
- `--operator` — Operator deployment as `namespace/name` (auto-detected if omitted).

### Secret Generation Commands
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.

From here down still exists but needs to be removed from the code base.

# understackctl

understackctl is a CLI tool for managing UnderStack deployments.
`understackctl` is the CLI tool for managing UnderStack deployments. It handles deployment repository scaffolding, secret generation, hardware definitions, node lifecycle workflows, and more.
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.

I'd probably nuke this file and just point at your rendered doc.

Copy link
Copy Markdown
Contributor

@cardoe cardoe left a comment

Choose a reason for hiding this comment

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

I'd probbaly nuke the README.md and just have it point at your rendered doc.

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.

2 participants