Browse Source

Lint all Markdown documents

Signed-off-by: David Gageot <david@gageot.net>
David Gageot 3 years ago
parent
commit
92fdcf2a41
1 changed files with 48 additions and 47 deletions
  1. 48
    47
      docs/drivers/openstack.md

+ 48
- 47
docs/drivers/openstack.md View File

@@ -9,60 +9,61 @@ parent="smn_machine_drivers"
9 9
 <![end-metadata]-->
10 10
 
11 11
 # OpenStack
12
+
12 13
 Create machines on [OpenStack](http://www.openstack.org/software/)
13 14
 
14 15
 Mandatory:
15 16
 
16
- - `--openstack-auth-url`: Keystone service base URL.
17
- - `--openstack-flavor-id` or `--openstack-flavor-name`: Identify the flavor that will be used for the machine.
18
- - `--openstack-image-id` or `--openstack-image-name`: Identify the image that will be used for the machine.
17
+-   `--openstack-auth-url`: Keystone service base URL.
18
+-   `--openstack-flavor-id` or `--openstack-flavor-name`: Identify the flavor that will be used for the machine.
19
+-   `--openstack-image-id` or `--openstack-image-name`: Identify the image that will be used for the machine.
19 20
 
20 21
 Options:
21 22
 
22
- - `--openstack-insecure`: Explicitly allow openstack driver to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.
23
- - `--openstack-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only)
24
- - `--openstack-username`: User identifier to authenticate with.
25
- - `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set.
26
- - `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created.
27
- - `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack.
28
- - `--openstack-availability-zone`: The availability zone in which to launch the server.
29
- - `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver
30
-   to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL`
31
- - `--openstack-net-name` or `--openstack-net-id`: Identify the private network the machine will be connected on. If your OpenStack project project contains only one private network it will be use automatically.
32
- - `--openstack-sec-groups`: If security groups are available on your OpenStack you can specify a comma separated list
33
-   to use for the machine (e.g. `secgrp001,secgrp002`).
34
- - `--openstack-floatingip-pool`: The IP pool that will be used to get a public IP can assign it to the machine. If there is an
35
-   IP address already allocated but not assigned to any machine, this IP will be chosen and assigned to the machine. If
36
-   there is no IP address already allocated a new IP will be allocated and assigned to the machine.
37
- - `--openstack-ip-version`: If the instance has both IPv4 and IPv6 address, you can select IP version. If not provided `4` will be used.
38
- - `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used.
39
- - `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port.
40
- - `--openstack-active-timeout`: The timeout in seconds until the OpenStack instance must be active.
23
+-   `--openstack-insecure`: Explicitly allow openstack driver to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.
24
+-   `--openstack-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only)
25
+-   `--openstack-username`: User identifier to authenticate with.
26
+-   `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set.
27
+-   `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created.
28
+-   `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack.
29
+-   `--openstack-availability-zone`: The availability zone in which to launch the server.
30
+-   `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver
31
+    to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL`
32
+-   `--openstack-net-name` or `--openstack-net-id`: Identify the private network the machine will be connected on. If your OpenStack project project contains only one private network it will be use automatically.
33
+-   `--openstack-sec-groups`: If security groups are available on your OpenStack you can specify a comma separated list
34
+    to use for the machine (e.g. `secgrp001,secgrp002`).
35
+-   `--openstack-floatingip-pool`: The IP pool that will be used to get a public IP can assign it to the machine. If there is an
36
+    IP address already allocated but not assigned to any machine, this IP will be chosen and assigned to the machine. If
37
+    there is no IP address already allocated a new IP will be allocated and assigned to the machine.
38
+-   `--openstack-ip-version`: If the instance has both IPv4 and IPv6 address, you can select IP version. If not provided `4` will be used.
39
+-   `--openstack-ssh-user`: The username to use for SSH into the machine. If not provided `root` will be used.
40
+-   `--openstack-ssh-port`: Customize the SSH port if the SSH server on the machine does not listen on the default port.
41
+-   `--openstack-active-timeout`: The timeout in seconds until the OpenStack instance must be active.
41 42
 
42 43
 Environment variables and default values:
43 44
 
44
-| CLI option                       | Environment variable   | Default     |
45
-|----------------------------------|------------------------|-------------|
46
-| `--openstack-auth-url`           | `OS_AUTH_URL`          | -           |
47
-| `--openstack-flavor-name`        | `OS_FLAVOR_NAME`       | -           |
48
-| `--openstack-flavor-id`          | `OS_FLAVOR_ID`         | -           |
49
-| `--openstack-image-name`         | `OS_IMAGE_NAME`        | -           |
50
-| `--openstack-image-id`           | `OS_IMAGE_ID`          | -           |
51
-| `--openstack-insecure`           | `OS_INSECURE`          | `false`     |
52
-| `--openstack-domain-name`        | `OS_DOMAIN_NAME`       | -           |
53
-| `--openstack-domain-id`          | `OS_DOMAIN_ID`         | -           |
54
-| `--openstack-username`           | `OS_USERNAME`          | -           |
55
-| `--openstack-password`           | `OS_PASSWORD`          | -           |
56
-| `--openstack-tenant-name`        | `OS_TENANT_NAME`       | -           |
57
-| `--openstack-tenant-id`          | `OS_TENANT_ID`         | -           |
58
-| `--openstack-region`             | `OS_REGION_NAME`       | -           |
59
-| `--openstack-availability-zone`  | `OS_AVAILABILITY_ZONE` | -           |
60
-| `--openstack-endpoint-type`      | `OS_ENDPOINT_TYPE`     | `publicURL` |
61
-| `--openstack-net-name`           | `OS_NETWORK_NAME`      | -           |
62
-| `--openstack-net-id`             | `OS_NETWORK_ID`        | -           |
63
-| `--openstack-sec-groups`         | `OS_SECURITY_GROUPS`   | -           |
64
-| `--openstack-floatingip-pool`    | `OS_FLOATINGIP_POOL`   | -           |
65
-| `--openstack-ip-version`         | `OS_IP_VERSION`        | `4`         |
66
-| `--openstack-ssh-user`           | `OS_SSH_USER`          | `root`      |
67
-| `--openstack-ssh-port`           | `OS_SSH_PORT`          | `22`        |
68
-| `--openstack-active-timeout`     | `OS_ACTIVE_TIMEOUT`    | `200`       |
45
+| CLI option                      | Environment variable   | Default     |
46
+| ------------------------------- | ---------------------- | ----------- |
47
+| `--openstack-auth-url`          | `OS_AUTH_URL`          | -           |
48
+| `--openstack-flavor-name`       | `OS_FLAVOR_NAME`       | -           |
49
+| `--openstack-flavor-id`         | `OS_FLAVOR_ID`         | -           |
50
+| `--openstack-image-name`        | `OS_IMAGE_NAME`        | -           |
51
+| `--openstack-image-id`          | `OS_IMAGE_ID`          | -           |
52
+| `--openstack-insecure`          | `OS_INSECURE`          | `false`     |
53
+| `--openstack-domain-name`       | `OS_DOMAIN_NAME`       | -           |
54
+| `--openstack-domain-id`         | `OS_DOMAIN_ID`         | -           |
55
+| `--openstack-username`          | `OS_USERNAME`          | -           |
56
+| `--openstack-password`          | `OS_PASSWORD`          | -           |
57
+| `--openstack-tenant-name`       | `OS_TENANT_NAME`       | -           |
58
+| `--openstack-tenant-id`         | `OS_TENANT_ID`         | -           |
59
+| `--openstack-region`            | `OS_REGION_NAME`       | -           |
60
+| `--openstack-availability-zone` | `OS_AVAILABILITY_ZONE` | -           |
61
+| `--openstack-endpoint-type`     | `OS_ENDPOINT_TYPE`     | `publicURL` |
62
+| `--openstack-net-name`          | `OS_NETWORK_NAME`      | -           |
63
+| `--openstack-net-id`            | `OS_NETWORK_ID`        | -           |
64
+| `--openstack-sec-groups`        | `OS_SECURITY_GROUPS`   | -           |
65
+| `--openstack-floatingip-pool`   | `OS_FLOATINGIP_POOL`   | -           |
66
+| `--openstack-ip-version`        | `OS_IP_VERSION`        | `4`         |
67
+| `--openstack-ssh-user`          | `OS_SSH_USER`          | `root`      |
68
+| `--openstack-ssh-port`          | `OS_SSH_PORT`          | `22`        |
69
+| `--openstack-active-timeout`    | `OS_ACTIVE_TIMEOUT`    | `200`       |

Loading…
Cancel
Save