Skip to content

Commit 5f26cab

Browse files
authored
AIT-68714: update ac CLI manual docs (#615)
* AIT-68714: update ac CLI manual docs Signed-off-by: Tianpeng Wang <tpwang@alauda.io> * docs: update AC manual sync branch parameter docs * docs(upgrade): add AC global entrypoint and remove --cvo guidance * docs(upgrade): add workload preflight step before upgrade request Signed-off-by: Tianpeng Wang <tpwang@alauda.io> --------- Signed-off-by: Tianpeng Wang <tpwang@alauda.io>
1 parent ef95af0 commit 5f26cab

10 files changed

Lines changed: 441 additions & 21 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/.vscode
12
**/node_modules
23
**/dist
34
local/*

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ yarn update-ac-manual
3737
This command runs:
3838

3939
```bash
40-
node scripts/update-ac-manual.js release-1.0
40+
node scripts/update-ac-manual.js
4141
```
4242

43-
When you use `yarn update-ac-manual`, the repository sync pulls the `release-1.0` branch from `git@gitlab-ce.alauda.cn:alauda/ac.git` because the project script explicitly passes that branch name.
43+
When you use `yarn update-ac-manual`, the repository sync pulls the `release-1.0` branch from `git@gitlab-ce.alauda.cn:alauda/ac.git` by default.
4444

4545
### What the Sync Script Does
4646

@@ -62,15 +62,21 @@ The workflow is:
6262

6363
### Updating from a Different Branch
6464

65-
If you need to sync from a branch other than `release-1.0`, run the script directly:
65+
If you need to sync from a branch other than `release-1.0`, pass the branch name as an argument:
66+
67+
```bash
68+
yarn update-ac-manual <branch>
69+
```
70+
71+
This is equivalent to running the script directly:
6672

6773
```bash
6874
node scripts/update-ac-manual.js <branch>
6975
```
7076

7177
Replace `<branch>` with the branch name you want to pull from.
7278

73-
If you run `node scripts/update-ac-manual.js` without a branch argument, the script itself defaults to `main`.
79+
If you run `node scripts/update-ac-manual.js` without a branch argument, the script defaults to `release-1.0`.
7480

7581
### Recommended Verification Steps
7682

docs/en/ui/cli_tools/ac/administrator-command-reference.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,34 @@ Assign a kubernetes role to a user in current context cluster
172172
ac adm policy add-role-to-user view alice -n my-namespace
173173
```
174174

175+
## ac adm release
176+
177+
Manage release metadata and related administrative workflows
178+
179+
### Example usage
180+
181+
```bash
182+
# Import a ProductManifest for a release version
183+
ac adm release import-manifest --version 4.20.0
184+
```
185+
186+
## ac adm release import-manifest
187+
188+
Import release metadata as a ProductManifest
189+
190+
### Example usage
191+
192+
```bash
193+
# Import release metadata for version 4.20.0
194+
ac adm release import-manifest --version 4.20.0
195+
196+
# Import metadata and wait for the ProductManifest to become Ready
197+
ac adm release import-manifest --version 4.20.0 --wait
198+
199+
# Override the wait timeout
200+
ac adm release import-manifest --version 4.20.0 --wait --timeout=10m
201+
```
202+
175203
## ac adm taint
176204

177205
Update the taints on one or more nodes
@@ -205,4 +233,44 @@ Mark node as schedulable
205233
```bash
206234
# Mark node "foo" as schedulable
207235
ac adm uncordon foo
236+
```
237+
238+
## ac adm upgrade
239+
240+
Review or request a cluster upgrade
241+
242+
### Example usage
243+
244+
```bash
245+
# View the update status and available cluster updates
246+
ac adm upgrade
247+
248+
# View summary for a specific cluster
249+
ac adm upgrade --cluster=workload-a
250+
251+
# Update to the latest version
252+
ac adm upgrade --to-latest
253+
254+
# Update to a specific version from available updates
255+
ac adm upgrade --cluster=workload-a --to=4.15.0
256+
257+
# Allow an explicit version outside available updates
258+
ac adm upgrade --to=4.15.0 --allow-explicit-upgrade
259+
```
260+
261+
## ac adm upgrade status
262+
263+
Review preflight and stage details for the target cluster upgrade
264+
265+
### Example usage
266+
267+
```bash
268+
# Review the status of the Cluster Version Operator for default cluster
269+
ac adm upgrade status
270+
271+
# Review the status of a specific cluster
272+
ac adm upgrade status --cluster=workload-a
273+
274+
# Review the full controller-reported details
275+
ac adm upgrade status --verbose
208276
```

docs/en/ui/cli_tools/ac/developer-command-reference.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1395,6 +1395,12 @@ ac login https://example.com --name prod --cluster=my-cluster --namespace=my-nam
13951395

13961396
# Login with custom kubeconfig file
13971397
ac login https://example.com --name prod --kubeconfig=/path/to/kubeconfig
1398+
1399+
# Login with workload cluster LDAP identity provider
1400+
ac login https://192.168.1.2:11780 --idp ldap-test --workload --auth-type ldap --username 'xx' --password 'xx'
1401+
1402+
# Login with workload cluster OIDC identity provider
1403+
ac login https://192.168.1.2:11780 --idp oidc --workload --auth-type oidc
13981404
```
13991405

14001406
## ac logout

0 commit comments

Comments
 (0)