Skip to content

Commit 2592f27

Browse files
authored
Add usage description to the README.md (#40)
[skip ci]
1 parent c437234 commit 2592f27

File tree

2 files changed

+58
-1
lines changed

2 files changed

+58
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,35 @@
66

77
OpenTelekomCloud driver for docker-machine
88

9+
### Comparing with other drivers
10+
11+
There are two more options of docker-machine driver suitable for usage with OpenTelekomCloud:
12+
* [docker-machine-openstack](https://opendev.org/x/docker-machine-openstack) ― docker-machine built-in
13+
* [DockerMachine4OTC](https://github.com/Huawei/DockerMachineDriver4OTC) ― older OTC driver implementation by Huawei
14+
15+
This driver is inspired by `docker-machine-openstack` and targets to provide full backward compatibility with `DockerMachineDriver4OTC`.
16+
17+
Backward compatibility meaning, that this driver uses flags and env variable naming that differs from OpenStack convention.
18+
Thus, in versions `0.3+` duplicating options will be removed and all environment variables will be prefixed with `OS_`.
19+
20+
Feature | OTC (new) | OTC (old) | Openstack
21+
--- | --- | --- | ---
22+
Automated creation of required infrastructure | **Yes** | No | No
23+
Support of `clouds.yaml` and `OS_CLOUD` | **Yes** | No | No
24+
Support using of resource names instead of IDs | Yes | No | Yes
25+
User data injection | Yes | No | Yes
26+
Floating IP pool selection | No | No | Yes
27+
Custom CA usage | No | No | Yes
28+
Insecure mode (without TLS certificate check) | No | No | Yes
29+
Bandwidth configuration | Yes | Yes | No
30+
Root volume configuration | Yes | Yes | No
31+
Optional usage of floating IP | Yes | Yes | No
32+
AK/SK auth | Yes | Yes | No
33+
Server group | **Yes** | No | No
34+
Security group(s) | Multiple | Single | Multiple
35+
Prepared k8s security group | Yes | No | No
36+
Usage with rancher | Needs setup | Built-in | Built-in
37+
938
### Installation
1039

1140
Driver can be installed several ways
@@ -16,13 +45,17 @@ _(Requires Go 1.11+, gcc and make installed)_
1645
2. Run `make build && sudo make install`, driver for linux will be built and copied to `/usr/local/bin`
1746

1847
#### Using built binary
19-
Already built driver for both Linux and Windows distributions can be found in
48+
An already built driver for both Linux and Windows distributions can be found in
2049
[releases section](https://github.com/opentelekomcloud/docker-machine-opentelekomcloud/releases)
2150

2251
You will have to copy driver to directory in `PATH` so `docker-machine` would be able to find it
2352

2453
### Usage
2554

55+
`docker-machine-opentelekomcloud` can be used either as Rancher node driver or as stand-alone Docker Machine driver
56+
57+
#### Stand-alone
58+
2659
`OpenTelekomCloud` driver processes existing `clouds.yaml` files to authenticate in OTC
2760

2861
Having `otc` cloud in your `clouds.yaml`, creating of docker-machine is as easy as running
@@ -92,3 +125,7 @@ Flag | Env variable | Default value | Description
92125
`--otc-username` | `OS_USERNAME` | | OpenTelekomCloud username
93126
`--otc-vpc-id` | `VPC_ID` | | VPC id the machine will be connected on
94127
`--otc-vpc-name` | `OS_VPC_NAME` | vpc-docker-machine | VPC name the machine will be connected on
128+
129+
#### With rancher
130+
131+
See [usage with rancher](usage-with-rancher.md)

usage-with-rancher.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Usage With Rancher
2+
3+
Currently, `docker-machine-opentelekomcloud` is not a part of the Rancher,
4+
so additional steps required to use it as a node driver
5+
6+
7+
### Remove old node driver:
8+
9+
* Open Rancher UI page and go to `Tools``Drivers``Node Drivers`
10+
* Check current preinstalled `Open Telekom Cloud` driver and remove it, because it produces conflicts with current implementation.
11+
12+
### Add new node driver:
13+
14+
* Open OpenTelekomDriver [releases](https://github.com/opentelekomcloud/docker-machine-opentelekomcloud/releases) page and copy link of binary for 64-bit Linux
15+
* Click `Add New Driver` button, insert copied link and click `Create`
16+
* Wait for a while. Driver should be downloaded and be in `Active` state.
17+
18+
## Create new template
19+
20+
New OTC driver template supports all parameters supported by the old version

0 commit comments

Comments
 (0)