openstack-{help, image, server, volume}: add page #15843
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # openstack help | ||
|
|
||
| > Display help information about the openstackclient cli. | ||
| > More information: <https://docs.openstack.org/python-openstackclient/latest/cli/man/openstack.html>. | ||
|
|
||
| - Display list of available commands: | ||
|
|
||
| `openstack --help` | ||
|
|
||
| - Description of a particular command: | ||
|
|
||
| `openstack help {{command_name}}` | ||
|
|
||
| - Get help for Identity v3: | ||
|
|
||
| `openstack --os-identity-api-version 3 --help` | ||
This file contains 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 | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,24 @@ | ||||||
| # openstack image | ||||||
|
|
||||||
| > OpenStack Image service, aka OpenStack Glance, allows users to upload and discover data assets meant to be used with other services. | ||||||
| > More information: <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/image-v2.html>. | ||||||
|
|
||||||
| - List available images: | ||||||
|
|
||||||
| `openstack image list [--public | --private | --community | --shared | --all] [--long]` | ||||||
|
There was a problem hiding this comment. Please refer to the style guide on how to format placeholders in tldr pages https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#placeholder-syntax Here for example I would disregard all the options and just put |
||||||
|
|
||||||
| - Display image details: | ||||||
|
|
||||||
| `openstack image show --human-readable {{image_id}}` | ||||||
|
|
||||||
| - Create/upload an image: | ||||||
|
|
||||||
| `openstack image create [--file <file> | --volume <volume>] [--public | --private | --community | --shared] {{image_name}}` | ||||||
|
|
||||||
| - Delete image(s): | ||||||
|
|
||||||
| `openstack image delete {{image_id}} [{{image_id}} ...]` | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| - Save an image locally: | ||||||
|
|
||||||
| `openstack image save --file {{filename}} {{image_id}}` | ||||||
This file contains 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 | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,33 @@ | ||||||
| # openstack server | ||||||
|
|
||||||
| > Manage OpenStack virtual machines. | ||||||
| > OpenStack Compute service, aka OpenStack Nova, mainly hosts and manages cloud computing systems. | ||||||
| > More information: <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/server.html>. | ||||||
|
|
||||||
| - List servers: | ||||||
|
|
||||||
| `openstack server list` | ||||||
|
|
||||||
| - Start server(s): | ||||||
|
|
||||||
| `openstack server start {{instance_id}} [{{instance_id}} ...]` | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| - Stop server: | ||||||
|
|
||||||
| `openstack server stop {{instance_id}} [{{instance_id}} ...]` | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| - Create new server: | ||||||
|
|
||||||
| `openstack server create --image {{image_id}} --flavor {{flavor_id}} --network {{network_id}} --wait {{server_name}}` | ||||||
|
|
||||||
| - Delete server(s): | ||||||
|
|
||||||
| `openstack server delete {{instance_id}} [{{instance_id}} ...]` | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| - Migrate server to different host: | ||||||
|
|
||||||
| `openstack server migrate [--live {{host_hostname}}] [--shared-migration | --block-migration] --wait {{instance_id}}` | ||||||
|
|
||||||
| - Perform a soft or hard reset to the server: | ||||||
|
|
||||||
| `openstack server reboot [--hard | --soft] [--wait] {{instance_id}}` | ||||||
This file contains 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 | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,29 @@ | ||||||
| # openstack volume | ||||||
|
|
||||||
| > Manage OpenStack volumes. | ||||||
| > OpenStack Block Storage service, aka OpenStack Cinder, provides volumes to Nova vm's, Ironic bare-metal hosts, containers, and others. | ||||||
| > More information: <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/volume.html>. | ||||||
|
|
||||||
| - List volumes: | ||||||
|
|
||||||
| `openstack volume list [--all-projects] [--long]` | ||||||
|
|
||||||
| - Show volume details: | ||||||
|
|
||||||
| `openstack volume show {{volume_id}}` | ||||||
|
|
||||||
| - Create new volume: | ||||||
|
|
||||||
| `openstack volume create --size {{size_in_GB}} [--image {{image_id}} --snapshot {{snapshot_id}}] [--bootable | --non-bootable] {{volume_name}}` | ||||||
|
|
||||||
| - Delete volumes(s): | ||||||
|
|
||||||
| `openstack volume delete {{volume_id}} [{{volume_id}} ...]` | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| - Migrate volume to a new host: | ||||||
|
|
||||||
| `openstack volume migrate --host {{host_hostname}} {{instance_id}}` | ||||||
|
|
||||||
| - Set volume properties: | ||||||
|
|
||||||
| `openstack volume set [--name {{volume_new_name}}] [--size {{volume_new_size}}] [--attached | --detached] [--bootable | --non-bootable] {{volume_id}}` | ||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.