stack-ssh-deploy/README.md
Luke Murphy bdeba12004
All checks were successful
continuous-integration/drone/push Build is passing
More docs: plugin + semver ref
2020-09-23 08:56:27 +02:00

37 lines
1.1 KiB
Markdown

# stack-ssh-deploy
[![Build Status](https://drone.autonomic.zone/api/badges/autonomic-cooperative/stack-ssh-deploy/status.svg)](https://drone.autonomic.zone/autonomic-cooperative/stack-ssh-deploy)
Deploy swarm stacks against a SSH based remote docker daemon context.
This is meant to be used as a [Drone plugin](http://plugins.drone.io/).
## Settings
- **stack**: Name of the stack to be deployed
- **compose** (default: `compose.yml`): compose file to use for deploying
- **host**: SSH-based docker daemon context to deploy against
- **deploy_key**: SSH private key part for ssh public key authentication
## Example
```yaml
---
kind: pipeline
name: deploy to swarm
steps:
- name: stack deploy
image: decentral1se/stack-ssh-deploy:0.0.1
settings:
stack: mystack
host: "ssh://drone@swarm.autonomic.zone:222"
deploy_key:
from_secret: drone_deploy_key
```
## Publishing
The version can be bumped in the [.drone.yml](./.drone.yml) file. Please use [semver](https://semver.org).
If you push a commit to master, the [Drone config](./.drone.yml) will publish to [Docker Hub](https://hub.docker.com/r/decentral1se/stack-ssh-deploy).