Skip to content

Commit

Permalink
Merge pull request #26 from AdamVB/update_readme
Browse files Browse the repository at this point in the history
Updated Readme
  • Loading branch information
zzhaoy authored Aug 27, 2019
2 parents 7cdb19a + 9cd7c55 commit 9f5bbb6
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ Option Name | Description
``--otc-root-volume-size``|Root Volume Size for your instance||
``--otc-root-volume-type``|Root Volume type for your instance||
``--otc-ssh-user``|Instance's optional ssh user||
``--otc-subnet-id``|Subnet ID for your instance private network||
``--otc-tenant-id``|Tenant ID||
``--otc-subnet-id``|Subnet ID for your instance private network (Network ID)||
``--otc-tenant-id``|Tenant ID (Project ID)||


## Environment variables and default values:
Expand Down Expand Up @@ -73,18 +73,34 @@ Option Name | Description

Each environment variable may be overloaded by its option equivalent at runtime.

## Hacking
### Get the sources
## Installing
### Install Go and git
```bash
yum install golang git
```
### Install DockerMachineDriver4OTC
```bash
export GOPATH=<Path to your Go Build Folder>
go get github.com/huawei/DockerMachineDriver4OTC
cd $GOPATH/src/github.com/huawei/DockerMachineDriver4OTC
./build.sh
```
The Driver Binary will be under ./bin/docker-machine-driver.linux-amd64
Rename it and copy it to you local path
```bash
cp ./bin/docker-machine-driver.linux-amd64 /usr/local/bin/docker-machine-driver-otc
```
### Test the driver
To test the driver, make sure your current build directory has been added into ```$PATH``` so that docker-machine can find it:

Alternatively you can also just rename it and add the folder to your ```$PATH```:
```
export PATH=$GOPATH/src/github.com/huawei/DockerMachineDriver4OTC:$PATH
```

### Binary direct download
You can also directly download the Binary from here:
https://dockermachinedriver.obs.eu-de.otc.t-systems.com/docker-machine-driver-otc


## Related links

- **Docker Machine**: https://docs.docker.com/machine/
Expand All @@ -97,4 +113,7 @@ Apache 2.0
## test command
docker-machine -D create -d otc --otc-access-key-id BCE_shortened --otc-access-key-secret 4UR_shortened --otc-available-zone eu-de-01 --otc-bandwidth-size 10 --otc-bandwidth-type PER --otc-elasticip-type 5_bgp --otc-flavor-id normal1 --otc-image-id d6944a41-5ec7-44a4-970e-ce330da390d2 --otc-region eu-de --otc-root-volume-size 40 --otc-root-volume-type SATA --otc-security-group sg-tino --otc-service-endpoint https://ecs.eu-de.otc.t-systems.com --otc-ssh-user ubuntu --otc-subnet-id 91e2f28b-50dc-4a2d-b856-39d9204323e2 --otc-tenant-id 16d53a84a13b49529d2e2c3646691288 --otc-vpc-id 9d5c46ec-b3f0-42a2-9a65-f2d77e124516 test

## debugging
docker-machine --debug [....]

**parameters may vary on different cloud platforms**

0 comments on commit 9f5bbb6

Please sign in to comment.