Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wshihadeh/docker-deployment-action
A GitHub Action that supports docker-compose and Docker Swarm deployments
https://github.com/wshihadeh/docker-deployment-action
action github githubactions
Last synced: 5 days ago
JSON representation
A GitHub Action that supports docker-compose and Docker Swarm deployments
- Host: GitHub
- URL: https://github.com/wshihadeh/docker-deployment-action
- Owner: wshihadeh
- License: mit
- Created: 2020-05-10T09:51:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-27T18:42:47.000Z (11 months ago)
- Last Synced: 2024-12-16T19:05:04.792Z (6 days ago)
- Topics: action, github, githubactions
- Language: Shell
- Homepage: https://docs.shihadeh.dev
- Size: 20.5 KB
- Stars: 132
- Watchers: 4
- Forks: 75
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Deployment Action
A [GitHub Action](https://github.com/marketplace/actions/docker-deployment) that supports docker-compose and Docker Swarm deployments. [Documentaion Page](https://wshihadeh.github.io/actions/Docker-Deployment/).
## Example
Below is a brief example on how the action can be used:
```yaml
- name: Deploy to Docker swarm
uses: wshihadeh/docker-deployment-action@v1
with:
remote_docker_host: [email protected]
ssh_private_key: ${{ secrets.DOCKER_SSH_PRIVATE_KEY }}
ssh_public_key: ${{ secrets.DOCKER_SSH_PUBLIC_KEY }}
deployment_mode: docker-swarm
copy_stack_file: true
deploy_path: /root/my-deployment
stack_file_name: docker-compose.yaml
keep_files: 5
args: my_applicaion
```
## Input Configurations
Below are all of the supported inputs. Some inputs are considered sensitive information and it should be stored as secrets.
### `args`
Arguments to pass to the deployment command either `docker` or `docker-compose`. The actions will automatically generate the follwing commands for each of the cases.
- `docker stack deploy --compose-file $FILE --log-level debug --host $HOST`
- `docker-compose -f $INPUT_STACK_FILE_NAME`
### `remote_docker_host`
Specify Remote Docker host. The input value must be in the follwing format (user@host)
### `remote_docker_port`
Specify Remote Docker ssh port if its not 22 default ie (2222)
### `ssh_public_key`
Remote Docker SSH public key.
Do not give the content of `id_rsa.pub`
The content of `~/.ssh/known_hosts` needs to be given here. You can get it by connecting to host once using your own machine. Example:
```
1.1.1.1 ecdsa-sha2-nistp256 AAAAE2VjZHNhLNTYAAAAIbmlzdHAyNCN5F3TLxUllpSRx8y+9C2uh+lWZDFmAsFMjcz2Zgq4d5F+oGicGaRk=
```
### `ssh_private_key`
SSH private key used to connect to the docker host
SSH key must be in PEM format (begins with -----BEGIN RSA PRIVATE KEY-----), or you can randomly get _Load key "/HOME/.ssh/id_rsa": invalid format_ error.
Convert it from OPENSSH (key begins with -----BEGIN OPENSSH PRIVATE KEY-----) format using `ssh-keygen -p -m PEM -f ~/.ssh/id_rsa`
### `deployment_mode`
Deployment mode either docker-swarm or docker-compose. Default is docker-compose.
### `copy_stack_file`
Copy stack file to remote server and deploy from the server. Default is false.
### `deploy_path`
The path where the stack files will be copied to. Default ~/docker-deployment.
### `stack_file_name`
Docker stack file used. Default is docker-compose.yaml
### `keep_files`
Number of the files to be kept on the server. Default is 3.
### `docker_prune`
A boolean input to trigger docker prune command.
### `pre_deployment_command_args`
The args for the pre deploument command. Applicable only for docker-compose.
### `pull_images_first`
Pull docker images before deploying. Applicable only for docker-compose.
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.