Skip to content

Updated how-to-run instructions for image size #1257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 23, 2022
Merged

Updated how-to-run instructions for image size #1257

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90799c1
Updated how-to-run instructions for image size
leftwo Jun 23, 2022
891f90f
Add sub section to section 2, fix formatting
leftwo Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/how-to-run.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,16 @@ other services and allocating them with vNICs and IPv6 addresses.
=== How to provision an instance using the CLI

Here are the current steps to provision an instance using the https://github.com/oxidecomputer/cli[oxide]
command line interface.
command line interface. Note that the `jq` command is required. In addition, the examples build on each other, so a previous name (or org, or project) are used in later steps.

1. Create an organization and project that the resources will live under:

oxide org create myorg
oxide project create -o myorg myproj

2. Define a global image that will be used as initial disk contents. This can be the alpine.iso image that ships with propolis, or an ISO / raw disk image / etc hosted at a URL:
2. Define a global image that will be used as initial disk contents.

a. This can be the alpine.iso image that ships with propolis:

oxide api /images --method POST --input - <<EOF
{
Expand All @@ -161,6 +163,8 @@ command line interface.
}
EOF

b. Or an ISO / raw disk image / etc hosted at a URL:

oxide api /images --method POST --input - <<EOF
{
"name": "crucible-tester-sparse",
Expand All @@ -177,22 +181,22 @@ command line interface.
}
EOF

3. Create a disk from that global image (note that disk size must be greater than or equal to image size!). The example below creates a disk using the image made from the alpine ISO that ships with propolis, and sets the size to be the exact same as the image size:
3. Create a disk from that global image (note that disk size must be greater than or equal to image size and a 1GiB multiple!). The example below creates a disk using the image made from the alpine ISO that ships with propolis, and sets the size to the next 1GiB multiple of the original alpine source:

oxide api /organizations/myorg/projects/myproj/disks/ --method POST --input - <<EOF
{
"name": "alpine",
"description": "alpine.iso blob",
"block_size": 512,
"size": $(oxide api /images/alpine | jq -r .size),
"size": 1073741824,
"disk_source": {
"type": "global_image",
"image_id": "$(oxide api /images/alpine | jq -r .id)"
}
}
EOF

4. Create an instance, attaching the disk created above:
4. Create an instance, attaching the alpine disk created above:

oxide api /organizations/myorg/projects/myproj/instances --method POST --input - <<EOF
{
Expand All @@ -210,7 +214,7 @@ command line interface.
}
EOF

5. Optionally, attach to the propolis server serial console:
5. Optionally, attach to the propolis server serial console, though the serial console is under active development and these commands are subject to change:

a. find the zone launched for the instance: `zoneadm list -c | grep oxz_propolis-server`
b. get the instance uuid from the zone name. if the zone's name is `oxz_propolis-server_3b03ad43-4e9b-4f3a-866c-238d9ec4ac45`, then the uuid is `3b03ad43-4e9b-4f3a-866c-238d9ec4ac45`
Expand Down