You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.EN.MD
+81Lines changed: 81 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -157,6 +157,86 @@ When deleting a configuration, the profile field must be specified to indicate t
157
157
158
158
If the configuration to be deleted is currently in use, then after successful deletion, Volcano Engine CLI will attempt to randomly selectone of the remaining configurations as the new current configuration.
This command creates or updates an SSO session for later use with `configure sso`. Behaviors and parameters:
169
+
170
+
```shell
171
+
name: SSO session name;if omitted, enter interactive selection/creation mode
172
+
start-url: SSO Start URL; required;if editing an existing session, Enter keeps the default
173
+
region: SSO region; required; default is cn-beijing, existing session values are used as defaults
174
+
registration-scopes: SSO scope list (comma-separated); allowed values are cloudidentity:account:access, offline_access
175
+
```
176
+
177
+
Interactive flow notes:
178
+
- If no sessions exist, you will be prompted to enter a non-empty session name
179
+
- If sessions exist, you get a searchable list with “<Create new session>” to add one
180
+
- When editing, Start URL, Region, and Scopes are pre-filled; press Enter to keep defaults
181
+
- Scopes are deduplicated and validated; empty input falls back to cloudidentity:account:access, offline_access
182
+
183
+
###### Configure SSO Profile (configure sso)
184
+
185
+
```shell
186
+
ve configure sso --profile [profile name] --sso-session [session name] --no-browser
187
+
```
188
+
189
+
This command configures an SSO profile, links an SSO session, runs the device authorization flow, and writes the profile to ~/.volcengine/config.json. Behaviors and parameters:
190
+
191
+
```shell
192
+
profile: profile name; empty uses {sso-role-name}-{sso-account-id} as the default
193
+
sso-session: SSO session name;if omitted, enter interactive selection/creation mode
194
+
no-browser: do not automatically open the browser; default false
195
+
```
196
+
197
+
Notes:
198
+
- If the profile already exists and is not an SSO profile, the command will refuse to overwrite it
199
+
- If the SSO session does not exist, you will be guided to create it and enter Start URL, Region, and Scopes
200
+
201
+
202
+
#### SSO Login and Logout
203
+
204
+
##### SSO Login (sso login)
205
+
206
+
```shell
207
+
ve sso login --profile [profile name]
208
+
# or
209
+
ve sso login --sso-session [session name]
210
+
```
211
+
212
+
This command logs in via SSO, obtains an access token, and caches it. Parameters:
213
+
214
+
```shell
215
+
profile: the SSO profile to use; must exist, be of sso type, and have sso-session configured
216
+
sso-session: the SSO session to use; the session must exist and be valid
217
+
no-browser: do not automatically open the browser; default false
218
+
```
219
+
220
+
Login behavior:
221
+
- If neither profile nor sso-session is provided: error when no sessions are configured; use the only session if one exists; otherwise enter interactive selection with search
222
+
- Only the device code flow is supported; use `--no-browser` to disable auto-opening the browser
223
+
224
+
##### SSO Logout (sso logout)
225
+
226
+
```shell
227
+
ve sso logout --sso-session [session name]
228
+
```
229
+
230
+
This command logs out from SSO by revoking the cached token and clearing local credentials. Parameters:
231
+
232
+
```shell
233
+
sso-session: the SSO session name to log out
234
+
```
235
+
236
+
Logout behavior:
237
+
- If sso-session is not provided: error when no sessions are configured;logout the only session if one exists; otherwise enter interactive selection that includes “All SSO sessions”
238
+
- Batch logout logs out each session and returns aggregated errors on failure
239
+
160
240
#### Configure Auto-Completion
161
241
162
242
By executing ve completion --help, users can view the methods forconfiguring auto-completionin various terminals. Based on the instructions provided, users may choose whether to configure the auto-completion feature.
@@ -271,3 +351,4 @@ The following code examples are provided:
271
351
```shell
272
352
ve rds_mysql ModifyDBInstanceIPList --body '{"InstanceId":"xxxxxx", "GroupName": "xxxxxx", "IPList": ["10.20.30.40", "50.60.70.80"]}'
0 commit comments