Merge pull request #34 from Rakhmanov/patch-1 [skip ci]

Updated documentation
This commit is contained in:
Joachim Hill-Grannec
2018-03-01 11:47:39 -05:00
committed by GitHub
+6 -3
View File
@@ -3,10 +3,11 @@ Use the rancher plugin to upgrade a service in [rancher](http://rancher.com).
The following parameters are used to configure this plugin:
- `url` - url to your rancher server, including protocol and port
- `rancher_access_key` - rancher api access key
- `rancher_secret_key` - rancher api secret key
- `access_key` - rancher api access key
- `secret_key` - rancher api secret key
- `service` - name of rancher service to act on
- `docker_image` - new image to assign to service, including tag (`drone/drone:latest`)
- `sidekick` - sidekick name and docker image separated by space, multiple declaration supported
- `start_first` - start the new container before stopping the old one, defaults to `true`
- `confirm` - auto confirm the service upgrade if successful, defaults to `false`
- `timeout` - the maximum wait time in seconds for the service to upgrade, default to `30`
@@ -23,10 +24,12 @@ deploy:
access_key: 1234567abcdefg
secret_key: abcdefg1234567
service: drone/drone
sidekick: nginx nginx:latest
sidekick: node node:latest
docker_image: drone/drone:latest
```
if you want to add secrets for the access_key and secret it's RANCHER_ACCESS_KEY and RANCHER_SECRET_KEY
if you want to add secrets for the access_key and secret_key it's RANCHER_ACCESS_KEY and RANCHER_SECRET_KEY
Note that if your `service` is part of a stack, you should use the notation `stackname/servicename` as this will make sure that the found service is part of the correct stack. If no stack is specified, this plugin will update the first service with a matching name which may not be what you want.