Skip to content

Commit 596a1ae

Browse files
docs: sync --git-repo → --tenant-repo rename and add PR delivery feature (#3858)
- Rename --git-repo to --tenant-repo in tenant-management.mdx (ArgoCD section) - Rename --git-repo to --tenant-repo in features.mdx (2 code examples + bullet list) - Add --delivery pr bullet to features.mdx tenant management section Follows feat(tenant) in #3821. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f121c49 commit 596a1ae

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

docs/src/content/docs/features.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Onboard teams to a shared Kubernetes cluster with RBAC isolation, GitOps sync re
101101
ksail tenant create my-team \
102102
--type flux \
103103
--registry oci://ghcr.io \
104-
--git-repo my-org/my-team \
104+
--tenant-repo my-org/my-team \
105105
--namespace my-team \
106106
--output ./platform/tenants \
107107
--register
@@ -112,13 +112,14 @@ ksail tenant delete my-team \
112112
--output ./platform/tenants \
113113
--delete-repo \
114114
--git-provider github \
115-
--git-repo my-org/my-team
115+
--tenant-repo my-org/my-team
116116
```
117117

118118
- **Auto-detection:** Tenant type is auto-detected from `gitOpsEngine` in `ksail.yaml` when `--type` is omitted.
119119
- **Registration:** Pass `--register` to automatically add the tenant to the nearest `kustomization.yaml`.
120-
- **GitHub scaffolding:** Use `--git-provider github` and `--git-repo` to scaffold a tenant repo. The token is auto-resolved from `--git-token`, `GH_TOKEN`/`GITHUB_TOKEN` env vars, or GitHub CLI config (`gh auth login`). If no token is found, scaffolding is skipped with a warning and the command succeeds.
121-
- **Flux OCI:** `--git-repo` is required for Flux OCI sync sources even without scaffolding — it builds the `OCIRepository` URL.
120+
- **PR delivery:** Pass `--delivery pr --git-provider github` to open a pull request against the platform repo instead of committing directly. The platform repo is auto-detected from `git remote origin`; override with `--platform-repo`. Set the PR target branch with `--target-branch`.
121+
- **GitHub scaffolding:** Use `--git-provider github` and `--tenant-repo` to scaffold a tenant repo. The token is auto-resolved from `--git-token`, `GH_TOKEN`/`GITHUB_TOKEN` env vars, or GitHub CLI config (`gh auth login`). If no token is found, scaffolding is skipped with a warning and the command succeeds.
122+
- **Flux OCI:** `--tenant-repo` is required for Flux OCI sync sources even without scaffolding — it builds the `OCIRepository` URL.
122123

123124
**Commands:** [`ksail tenant`](/cli-flags/tenant/tenant-root/)
124125

docs/src/content/docs/guides/tenant-management.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Add `--register` to also merge the tenant RBAC policy into the shared `argocd-rb
146146
```bash
147147
ksail tenant create my-team --type argocd \
148148
--git-provider github \
149-
--git-repo my-org/my-team-infra \
149+
--tenant-repo my-org/my-team-infra \
150150
--register
151151
```
152152

0 commit comments

Comments
 (0)