rm -rf oxapi_demo, replace w cli #802
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -188,208 +188,80 @@ Dec 02 18:00:01.093 DEBG registered endpoint, path: /producers, method: POST, lo | |
| ... | ||
| ---- | ||
|
|
||
| Once everything is up and running, you can use `curl` directly to hit either of | ||
| the servers. But it's easier to use the [`oxide` cli](https://docs.oxide.computer/cli/manual) (see below). | ||
|
|
||
| == Docker image | ||
|
|
||
| This repo includes a Dockerfile that builds an image containing the Nexus and sled agent. There's a GitHub Actions workflow that builds and publishes the Docker image. This is used by the https://github.com/oxidecomputer/console/[console] project for prototyping, demoing, and testing. This is **not** the way Omicron will be deployed on production systems, but it's a useful vehicle for working with it. | ||
|
|
||
| == Quick demo | ||
|
|
||
| The `oxide` CLI can be installed from the [latest | ||
| release](https://github.com/oxidecomputer/cli/releases). | ||
|
Collaborator
There was a problem hiding this comment. Are we publishing releases for illumos?
Contributor
Author
There was a problem hiding this comment. I couldnt get cargo cross to work for illumos but maybe @jclulow can, its easy to turn on if it compiles
Contributor
Author
There was a problem hiding this comment.
Collaborator
There was a problem hiding this comment. I'm reading through https://github.com/cross-rs/cross - I don't think illumos is a supported target by that project. Manually, I checked out the CLI repo and tried building the On the other hand, I can totally check out the CLI repo and build it manually on my Helios machine. If cross-compilation doesn't work, we could add a buildomat job to natively compile + publish the CLI tool?
Contributor
Author
There was a problem hiding this comment. yep for sure i already have a matrix for the others on release https://github.com/oxidecomputer/cli/blob/main/.github/workflows/make-release.yml#L10
Collaborator
There was a problem hiding this comment. I have opened a PR: oxidecomputer/oxide.rs#117 This should produce an
Contributor
Author
There was a problem hiding this comment. dope! hmm not sure, but since I'm uploading things to GCS maybe the release stuff could be changed to wait for everything to be in the bucket before generating things, idk
Contributor
Author
There was a problem hiding this comment. |
||
|
|
||
| Run `oxide auth login` to authenticate with your Oxide account. Alternatively, | ||
| oxide will respect the `OXIDE_TOKEN` and `OXIDE_HOST` environment variables. | ||
jessfraz marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| If you find bugs or have feedback, leave it on the [cli | ||
| repo](https://github.com/oxidecomputer/cli/issues). | ||
|
|
||
| Here's a small demo that creates a project, creates an instance, and attaches a disk to it: | ||
|
|
||
| [source,text] | ||
| ---- | ||
| $ oxide org create myorg \ | ||
| --description "My organization" | ||
| ✔ Created organization myorg | ||
|
|
||
| $ oxide project create myproject \ | ||
| --description "My project" \ | ||
| --organization myorg | ||
| ✔ Created project myorg/myproject | ||
|
|
||
| $ oxide instance create myinstance \ | ||
| --description "My instance" \ | ||
| --project myproject \ | ||
| --org myorg \ | ||
| --hostname "myinstance.maze-war.com" \ | ||
| --ncpus 1 \ | ||
| --memory 8 | ||
| ✔ Created instance myinstance in myorg/myproject | ||
|
|
||
| $ oxide instance view myinstance \ | ||
| --org myorg \ | ||
| --project myproject \ | ||
| --format json | ||
| { | ||
| "id": "99ad2514-050c-4493-9cb9-d9ceba980a98", | ||
| "name": "myinstance", | ||
| "description": "My instance", | ||
| "timeCreated": "2021-11-17T01:45:07.606749Z", | ||
| "timeModified": "2021-11-17T01:45:07.606749Z", | ||
| "projectId": "c197b9d2-285c-4e9f-9461-1815ef093c8d", | ||
| "ncpus": 1, | ||
| "memory": 8, | ||
| "hostname": "myinstance.maze-war.com", | ||
| "runState": "running", | ||
| "timeRunStateUpdated": "2021-11-17T01:45:09.120652Z" | ||
| } | ||
|
|
||
| $ oxide disk create nginx \ | ||
| -D "The nginx disk." \ | ||
| -o myorg \ | ||
| -p myproject \ | ||
| --size 10 | ||
| ✔ Created disk nginx in myorg/myproject | ||
|
|
||
|
|
||
| $ oxide disk view nginx \ | ||
| --org myorg \ | ||
| --project myproject \ | ||
| --format json | ||
| { | ||
| "id": "551bbe67-3640-41c9-b968-249a136e5e31", | ||
| "name": "nginx", | ||
| "description": "The nginx disk.", | ||
| "timeCreated": "2021-11-17T01:47:36.524136Z", | ||
| "timeModified": "2021-11-17T01:47:36.524136Z", | ||
| "projectId": "c197b9d2-285c-4e9f-9461-1815ef093c8d", | ||
|
|
@@ -398,46 +270,105 @@ date: Wed, 17 Nov 2021 01:48:17 GMT | |
| "state": { | ||
| "state": "detached" | ||
| }, | ||
| "devicePath": "/mnt/nginx" | ||
| } | ||
|
|
||
| $ oxide disk attach nginx myinstance \ | ||
| -o maze-war \ | ||
| -p prod-online | ||
| ✔ Attached disk nginx to instance myinstance in myorg/myproject | ||
|
|
||
| $ oxide instance disks myinstance \ | ||
| -o maze-war \ | ||
| -p prod-online \ | ||
| --format json | ||
| { | ||
| "instanceId": "99ad2514-050c-4493-9cb9-d9ceba980a98", | ||
| "diskId": "551bbe67-3640-41c9-b968-249a136e5e31", | ||
| "diskName": "nginx", | ||
| "diskState": { | ||
| "state": "attached", | ||
| "instance": "99ad2514-050c-4493-9cb9-d9ceba980a98" | ||
| } | ||
| } | ||
|
|
||
| # Alternatively, you can use the API command to run any endpoint. | ||
| # This operates like a fancy, authenticated curl. | ||
|
|
||
| $ oxide api --help | ||
| Makes an authenticated HTTP request to the Oxide API and prints the response. | ||
|
|
||
| The endpoint argument should be a path of a Oxide API endpoint. | ||
|
|
||
| The default HTTP request method is "GET" normally and "POST" if any parameters | ||
| were added. Override the method with `--method`. | ||
|
|
||
| Pass one or more `-f/--raw-field` values in "key=value" format to add static string | ||
| parameters to the request payload. To add non-string or otherwise dynamic values, see | ||
| `--field` below. Note that adding request parameters will automatically switch the | ||
| request method to POST. To send the parameters as a GET query string instead, use | ||
| `--method GET`. | ||
|
|
||
| The `-F/--field` flag has magic type conversion based on the format of the value: | ||
|
|
||
| - literal values "true", "false", "null", and integer/float numbers get converted to | ||
| appropriate JSON types; | ||
| - if the value starts with "@", the rest of the value is interpreted as a | ||
| filename to read the value from. Pass "-" to read from standard input. | ||
|
|
||
| Raw request body may be passed from the outside via a file specified by `--input`. | ||
| Pass "-" to read from standard input. In this mode, parameters specified via | ||
| `--field` flags are serialized into URL query parameters. | ||
|
|
||
| In `--paginate` mode, all pages of results will sequentially be requested until | ||
| there are no more pages of results. | ||
|
|
||
| USAGE: | ||
| oxide api [OPTIONS] <endpoint> | ||
|
|
||
| ARGS: | ||
| <endpoint> | ||
| The endpoint to request | ||
|
|
||
| OPTIONS: | ||
| -d, --debug | ||
| Print debug info | ||
|
|
||
| [env: DEBUG=] | ||
|
|
||
| -f, --raw-field <RAW_FIELD> | ||
| Add a string parameter in key=value format | ||
|
|
||
| -F, --field <FIELD> | ||
| Add a typed parameter in key=value format | ||
|
|
||
| -h, --help | ||
| Print help information | ||
|
|
||
| -H, --header <HEADER> | ||
| Add a HTTP request header in `key:value` format | ||
|
|
||
| -i, --include | ||
| Include HTTP response headers in the output | ||
|
|
||
| --input <INPUT> | ||
| The file to use as body for the HTTP request (use "-" to read from standard input) | ||
|
|
||
| [default: ] | ||
|
|
||
| --paginate | ||
| Make additional HTTP requests to fetch all pages of results | ||
|
|
||
| -X, --method <METHOD> | ||
| The HTTP method for the request | ||
|
|
||
| $ oxide api /session/me | ||
| { | ||
| "id": "99ad2514-050c-4493-9cb9-d9ceba980a98" | ||
| } | ||
|
|
||
|
|
||
| ----- | ||
|
|
||
| == Deploying Omicron | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.