Skip to content

Commit 8dc4415

Browse files
outcatcheroutcatcher
authored
Add driver flags description (#31)
1 parent 6db5f97 commit 8dc4415

File tree

1 file changed

+47
-6
lines changed

1 file changed

+47
-6
lines changed

‎README.md‎

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@
66

77
OpenTelekomCloud driver for docker-machine
88

9-
---
10-
NB! Driver is currently in active development phase
11-
---
12-
139
### Installation
1410

1511
Driver can be installed several ways
@@ -32,10 +28,10 @@ You will have to copy driver to directory in `PATH` so `docker-machine` would be
3228
Having `otc` cloud in your `clouds.yaml`, creating of docker-machine is as easy as running
3329

3430
```bash
35-
docker-machine create -d opentelekomcloud --otc-cloud otc default
31+
docker-machine create -d otc --otc-cloud otc default
3632
```
3733

38-
**Following will be created:**
34+
**Following will be created if not provided:**
3935

4036
- **Security Group**: `docker-machine-grp`
4137
- **VPC** `vpc-docker-machine`
@@ -47,3 +43,48 @@ docker-machine create -d opentelekomcloud --otc-cloud otc default
4743
- **Image** `Standard_Debian_10_latest`
4844

4945
*Removing machine will remove all resources created on machine creation*
46+
47+
#### Supported options
48+
Flag | Env variable | Default value | Description
49+
--- | --- | --- | ---
50+
`--otc-access-key-id` | `ACCESS_KEY_ID` | | Access key ID for AK/SK auth
51+
`--otc-access-key-key` | `ACCESS_KEY_SECRET` | | Secret access key for AK/SK auth
52+
`--otc-auth-url` | `OS_AUTH_URL` | https://iam.eu-de.otc.t-systems.com | Authentication URL
53+
`--otc-availability-zone` | `OS_AVAILABILITY_ZONE` | eu-de-03 | Availability zone
54+
`--otc-available-zone` | | | Availability zone. **DEPRECATED**: use `-otc-availability-zone` instead
55+
`--otc-bandwidth-size` | `BANDWIDTH_SIZE` | 100 (MBit/s) | Bandwidth size
56+
`--otc-bandwidth-type` | `BANDWIDTH_TYPE` | PER (exclusive bandwidth) | Bandwidth share type
57+
`--otc-cloud` | `OS_CLOUD` | | Name of cloud in `clouds.yaml` file
58+
`--otc-domain-id` | `OS_DOMAIN_ID` | | OpenTelekomCloud Domain ID
59+
`--otc-domain-name` | `OS_DOMAIN_NAME` | | OpenTelekomCloud Domain name
60+
`--otc-elastic-ip` | `ELASTIC_IP` | 1 | If set to 0, elastic IP won't be created. **DEPRECATED**: use `-otc-skip-ip` instead
61+
`--otc-elastic-ip-type` | `ELASTICIP_TYPE` | | Bandwidth type. **DEPRECATED!** Use `-otc-floating-ip-type` instead
62+
`--otc-endpoint-type` | | public | Endpoint type
63+
`--otc-flavor-id` | `OS_FLAVOR_ID` | | Flavor id to use for the instance
64+
`--otc-flavor-name` | `OS_FLAVOR_NAME` | s2.large.2 | Flavor name to use for the instance
65+
`--otc-floating-ip` | `OS_FLOATINGIP` | | Floating IP to use
66+
`--otc-floating-ip-type` | | 5_bgp | Bandwidth type (either `5_bgp` or `5_mailbgp`)
67+
`--otc-image-id` | `OS_IMAGE_ID` | | Image id to use for the instance
68+
`--otc-image-name` | `OS_IMAGE_NAME` | Standard_Debian_10_latest | Image name to use for the instance
69+
`--otc-ip-version ` | `OS_IP_VERSION` | 4 | Version of IP address assigned for the machine
70+
`--otc-k8s-group` | | | Create security group with k8s ports allowed
71+
`--otc-keypair-name` | `OS_KEYPAIR_NAME` | | Key pair to use to SSH to the instance
72+
`--otc-password` | `OS_PASSWORD` | | OpenTelekomCloud Password
73+
`--otc-private-key-file` | `OS_PRIVATE_KEY_FILE` | | Private key file to use for SSH (absolute path)
74+
`--otc-project-id` | `OS_TENANT_ID` | | OpenTelekomCloud Project ID
75+
`--otc-project-name` | `OS_TENANT_NAME` | | OpenTelekomCloud Project name
76+
`--otc-region` | `OS_REGION_NAME` | eu-de | Region name
77+
`--otc-root-volume-size` | | 40 | Set volume size of root partition (in GB)
78+
`--otc-root-volume-type` | | SATA | Set volume type of root partition (one of SATA, SAS, SSD)
79+
`--otc-sec-groups` | `OS_SECURITY_GROUP` | | Existing security groups to use, separated by comma
80+
`--otc-skip-default-sg` | | | Don't create default security group
81+
`--otc-skip-ip` | | | If set, elastic IP won't be created
82+
`--otc-ssh-port` | `OS_SSH_PORT` | 22 | Machine SSH port
83+
`--otc-ssh-user` | `OS_SSH_USER` | linux | SSH user
84+
`--otc-subnet-id` | | | Subnet id the machine will be connected on
85+
`--otc-subnet-name` | | subnet-docker-machine | Subnet name the machine will be connected on
86+
`--otc-token` | `OS_TOKEN` | | Authorization token
87+
`--otc-user-data-file` | `OS_USER_DATA_FILE` | | File containing an userdata script
88+
`--otc-username` | `OS_USERNAME` | | OpenTelekomCloud username
89+
`--otc-vpc-id` | | | VPC id the machine will be connected on
90+
`--otc-vpc-name` | | vpc-docker-machine | VPC name the machine will be connected on

0 commit comments

Comments
 (0)