manual/docs/machinery-deploy.1.md in machinery-tool-1.21.0 vs manual/docs/machinery-deploy.1.md in machinery-tool-1.22.0
- old
+ new
@@ -1,22 +1,20 @@
-
# deploy — Deploy Image to OpenStack Cloud
-## SYNOPSIS
+## Synopsis
`machinery deploy` NAME -c CONFIG_FILE | --cloud-config=CONFIG_FILE
[-i IMAGE_DIR | --image-dir=IMAGE_DIR]
[-n CLOUD_IMAGE_NAME | --cloud-image-name=CLOUD_IMAGE_NAME]
[-s | --insecure ]
`machinery` help [deploy]
+## Description
-## DESCRIPTION
-
The `deploy` command builds and deploys an image to an OpenStack cloud.
-This command is particularly useful for testing, debugging, or for validation.
+This command is particularly useful for testing, debugging, or validation.
> #### NOTE: Set Password for Unattended Work
> Machinery asks for a password when sourcing the configuration
> file. This interrupts the work flow and the user has to enter
@@ -28,19 +26,17 @@
>
> and set the password in the `OS_PASSWORD` variable:
>
> export OS_PASSWORD=YOUR_PASSWORD
+## Arguments
-## ARGUMENTS
-
* `NAME` (required):
Name of the system description.
+## Options
-## OPTIONS
-
* `-c CONFIG_FILE`, `--cloud-config=CONFIG_FILE` (required):
Path to file where the cloud config (openrc.sh) is located.
The configuration file is sourced by Machinery.
* `-i IMAGE_DIR`, `--image-dir=IMAGE_DIR` (optional):
@@ -51,19 +47,19 @@
* `-s`, `--insecure` (optional):
Allow to make "insecure" HTTPS requests, without checking the SSL
certificate when uploading to the cloud.
-## PREREQUISITES
+## Prerequisites
* The `deploy` command requires the packages `kiwi` for building the image
and `python-glanceclient` for uploading the image to the cloud.
-## SUPPORTED ARCHITECTURES
+## Supported Architectures
Machinery only supports deploying x86_64 images on x86_64 systems.
-## EXAMPLES
+## Examples
* Build an image under the system description named `jeos`.
Deploy it to the OpenStack cloud name `tux-cloud` by using the
configuration file `openrc.sh` in directory `tux`: