Skip to content

Update CLI usages in docs for v1 API and new CLI #2409

@david-crespo

Description

@david-crespo

Depending on how the new CLI works, most of the changes should be small.

~/oxide/omicron $ rg "oxide " -g "*.{adoc,sh}"
docs/cli.adoc
16:Run `oxide auth login` to authenticate with your Oxide account. Alternatively,
25:$ oxide org create myorg \
29:$ oxide project create myproject \
34:$ oxide instance create myinstance \
43:$ oxide instance view myinstance \
61:$ oxide disk create nginx \
69:$ oxide disk view nginx \
88:$ oxide disk attach nginx myinstance \
93:$ oxide instance disks myinstance \
113:$ oxide api --help
142:    oxide api [OPTIONS] <endpoint>
180:$ oxide api /session/me

docs/how-to-run.adoc
205:    oxide org create myorg
206:    oxide project create -o myorg myproj
217:    oxide api /system/ip-pools/default/ranges/add --method POST --input - <<EOF
228:    oxide api /system/images --method POST --input - <<EOF
245:    oxide api /system/images --method POST --input - <<EOF
263:    oxide api /organizations/myorg/projects/myproj/disks/ --method POST --input - <<EOF
271:          "image_id": "$(oxide api /system/images/alpine | jq -r .id)"
278:    oxide api /organizations/myorg/projects/myproj/instances --method POST --input - <<EOF
297:    oxide instance serial --interactive -p myproj -o myorg myinst

tools/populate/populate-images.sh
11:oxide api /system/images --method POST --input - <<EOF
28:oxide api /system/images --method POST --input - <<EOF
45:oxide api /system/images --method POST --input - <<EOF
62:oxide api /system/images --method POST --input - <<EOF
79:oxide api /system/images --method POST --input - <<EOF
96:oxide api /system/images --method POST --input - <<EOF

tools/populate/populate-alpine.sh
4:if ! oxide api /system/images > /dev/null; then
5:    echo "Problem detected running the oxide CLI"
10:oxide api /system/images --method POST --input - <<EOF

Metadata

Metadata

Assignees

No one assigned

    Labels

    apiRelated to the API.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions