chaos/drone-rsync
Archived
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs for Drone v1, remove docs for older versions, update base image to Alpine 3.13

Browse Source
This commit is contained in:
Michael de Wit
2021-02-08 12:47:38 +01:00
parent 21497cd5b8
commit b311cd7457
4 changed files with 11 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
0-DOCS.md
View File

@@ -1,104 +0,0 @@
Use the Rsync plugin to synchronize files to remote hosts, and execute arbitrary commands on those hosts.
## Config
The following parameters are used to configure the plugin:
- **user** - user to log in as on the remote machines, defaults to `root`
- **key** - private SSH key for the remote machines
- **hosts** - hostnames or ip-addresses of the remote machines
- **port** - port to connect to on the remote machines, defaults to `22`
- **source** - source folder to synchronize from, defaults to `./`
- **target** - target folder on remote machines to synchronize to
- **include** - rsync include filter
- **exclude** - rsync exclude filter
- **recursive** - recursively synchronize, defaults to `false`
- **delete** - delete target folder contents, defaults to `false`
- **script** - list of commands to execute on remote machines
## Secrets
The following secrets can be used to secure the sensitive parts of your configuration:
- **rsync_key** - private SSH key for the remote machines
- **rsync_user** - user to log in as on the remote machines
It is highly recommended to put your private key into a secret (`rsync_key`) so it is not exposed to users. This can be done using the drone-cli:
```sh
drone secret add \
--repository your/repo \
--name rsync_key \
--value @./id_rsa \
--image drillster/drone-rsync
```
Add the secret to your `.drone.yml`:
```yaml
pipeline:
rsync:
image: drillster/drone-rsync
user: some-user
hosts:
- remote1
source: ./dist
target: ~/packages
secrets: [ rsync_key ]
```
See the [Secret Guide](http://docs.drone.io/manage-secrets/) for additional information on secrets.
## Examples
```yaml
pipeline:
rsync:
image: drillster/drone-rsync
hosts:
- remote1
- remote2
source: ./dist
target: ~/packages
include:
- "app.tar.gz"
- "app.tar.gz.md5"
exclude:
- "**.*"
prescript:
- cd ~/packages
- md5sum -c app.tar.gz.md5
- tar -xf app.tar.gz -C ~/app
script:
- cd ~/packages
- md5sum -c app.tar.gz.md5
- tar -xf app.tar.gz -C ~/app
secrets: [ rsync_user, rsync_key ]
```
The example above illustrates a situation where an app package (`app.tar.gz`) will be deployed to 2 remote hosts (`remote1` and `remote2`). An md5 checksum will be deployed as well. After deploying, the md5 checksum is used to check the deployed package. If successful the package is extracted.
## Important
The script passed to **script** will be executed on remote machines directly after rsync completes to deploy the files. It will be executed step by step until a command returns a non-zero exit-code. If this happens, the entire plugin will exit and fail the build.
## Secrets in Drone 0.5
Secret injection has changed for Drone 0.6 and up. To use this plugin with Drone 0.5, use:
```sh
drone secret add octocat/hello-world RSYNC_KEY @path/to/.ssh/id_rsa
```
to add the secret. Then add the secret to your `.drone.yml`:
```yaml
pipeline:
rsync:
image: drillster/drone-rsync
user: some-user
key: ${RSYNC_KEY}
hosts:
- remote1
source: ./dist
target: ~/packages
```
and then sign your configuration using:
```sh
drone sign octocat/hello-world
```

22
1-DOCS.md → DOCS.md
View File

@@ -12,21 +12,17 @@ The following parameters are used to configure the plugin:
- **exclude** - rsync exclude filter
- **recursive** - recursively synchronize, defaults to `false`
- **delete** - delete target folder contents, defaults to `false`
- **args** - instruct plugin to use these additional rsync CLI arguments, example: `"--blocking-io"`
- **prescript** - list of commands to execute on remote machines before rsync occurs
- **script** - list of commands to execute on remote machines after rsync occurs
## Secrets
The following secrets can be used to secure the sensitive parts of your configuration:
- **rsync_key** - private SSH key for the remote machines
- **rsync_user** - user to log in as on the remote machines
It is highly recommended to put your private key into a secret (`rsync_key`) so it is not exposed to users. This can be done using the drone-cli:
```sh
drone secret add \
--repository your/repo \
--name rsync_key \
--value @./id_rsa \
--data @./id_rsa \
```
Add the secret to your `.drone.yml`:
@@ -36,11 +32,10 @@ kind: pipeline
steps:
- name: rsync
image: drillster/drone-rsync
environment:
RSYNC_KEY:
from_secret: rsync_key
settings:
user: some-user
key:
from_secret: rsync_key
hosts:
- remote1
source: ./dist
@@ -58,15 +53,14 @@ name: default
steps:
- name: rsync
image: drillster/drone-rsync
environment:
RSYNC_KEY:
from_secret: rsync_key
RSYNC_USER:
from_secret: rsync_user
settings:
hosts:
- remote1
- remote2
user:
from_secret: rsync_user
key:
from_secret: rsync_key
source: ./dist
target: ~/packages
include:

5
Dockerfile
View File

@@ -1,7 +1,6 @@
FROM alpine:3.8
MAINTAINER Michael de Wit <michael@drillster.com>
FROM alpine:3.13
RUN apk add --no-cache ca-certificates bash openssh-client rsync
RUN apk add --no-cache --update ca-certificates bash openssh-client rsync
COPY upload.sh /usr/local/
ENTRYPOINT ["/usr/local/upload.sh"]

5
README.md
View File

@@ -3,10 +3,7 @@
This is a pure Bash [Drone](https://github.com/drone/drone) >= 0.5 plugin to sync files to remote hosts.
For more information on how to use the plugin, please take a look at the docs:
- For Drone CI versions `< 1` : https://github.com/Drillster/drone-rsync/blob/master/0-DOCS.md
- For Drone CI versions `>= 1` : https://github.com/Drillster/drone-rsync/blob/master/1-DOCS.md
For more information on how to use the plugin, please take a look at [the docs](https://github.com/Drillster/drone-rsync/blob/master/DOCS.md).
## Docker
Build the docker image by running: