Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cssnr/stack-deploy-action
Docker Stack Deploy GitHub Action
https://github.com/cssnr/stack-deploy-action
actions
Last synced: 6 days ago
JSON representation
Docker Stack Deploy GitHub Action
- Host: GitHub
- URL: https://github.com/cssnr/stack-deploy-action
- Owner: cssnr
- License: gpl-3.0
- Created: 2023-08-28T00:24:34.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-27T01:15:39.000Z (4 months ago)
- Last Synced: 2024-07-28T01:35:11.595Z (4 months ago)
- Topics: actions
- Language: Shell
- Homepage: https://cssnr.github.io
- Size: 43.9 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/cssnr/stack-deploy-action/actions/workflows/tags.yaml)
[](https://github.com/cssnr/stack-deploy-action/actions/workflows/test.yaml)
[](https://github.com/cssnr/stack-deploy-action/releases/latest)
[](https://github.com/cssnr/parse-issue-form-action/graphs/commit-activity)
[](https://codeberg.org/cssnr/parse-issue-form-action)
[](https://github.com/cssnr/stack-deploy-action)
[](https://cssnr.github.io/)
[](https://discord.gg/wXy6m2X8wY)
# Docker Stack Deploy Action
This action deploys a docker stack from a compose file to a remote docker host using SSH Password or Key File Authentication.
For more details see [action.yaml](action.yaml) and [src/main.sh](src/main.sh).
- [Inputs](#Inputs)
- [Examples](#Examples)
- [Support](#Support)
- [Contributing](#Contributing)
## Inputs
| input | required | default | description |
| -------- | -------- | --------------------- | ------------------------- |
| host | **Yes** | - | Remote Docker hostname |
| port | No | `22` | Remote Docker port |
| user | **Yes** | - | Remote Docker username |
| pass | No | - | Remote Docker password \* |
| ssh_key | No | - | Remote SSH Key file \* |
| file | No | `docker-compose.yaml` | Docker Compose file |
| name | **Yes** | - | Docker Stack name |
| env_file | No | - | Docker Environment file |
**pass/ssh_key** - You must provide either a `pass` or `ssh_key`
```yaml
- name: 'Docker Stack Deploy'
uses: cssnr/stack-deploy-action@v1
with:
host: ${{ secrets.DOCKER_HOST }}
port: ${{ secrets.DOCKER_PORT }}
user: ${{ secrets.DOCKER_USER }}
pass: ${{ secrets.DOCKER_PASS }}
file: 'docker-compose-swarm.yaml'
name: 'stack-name'
```
## Examples
Simple Example
```yaml
name: 'Test Docker Stack Deploy'
on:
push:
jobs:
deploy:
name: 'Deploy'
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: 'Checkout'
uses: actions/checkout@v4
- name: 'Docker Stack Deploy'
uses: cssnr/stack-deploy-action@v1
with:
host: ${{ secrets.DOCKER_HOST }}
port: ${{ secrets.DOCKER_PORT }}
user: ${{ secrets.DOCKER_USER }}
pass: ${{ secrets.DOCKER_PASS }}
file: 'docker-compose-swarm.yaml'
name: 'stack-name'
```
Full Example
```yaml
name: 'Test Docker Stack Deploy'
on:
workflow_dispatch:
inputs:
tags:
description: 'Tags: comma,separated'
required: true
default: 'latest'
env:
REGISTRY: 'ghcr.io'
jobs:
deploy:
name: 'Deploy'
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: 'Checkout'
uses: actions/checkout@v4
- name: 'Generate Tags'
id: tags
uses: smashedr/docker-tags-action@master
with:
images: '$${{ env.REGISTRY }}/${{ github.repository }}'
extra: ${{ inputs.tags }}
- name: 'Setup Buildx'
uses: docker/setup-buildx-action@v2
with:
platforms: linux/amd64,linux/arm64
- name: 'Docker Login'
uses: docker/login-action@v2
with:
registry: $${{ env.REGISTRY }}
username: ${{ secrets.GHCR_USER }}
password: ${{ secrets.GHCR_PASS }}
- name: 'Build and Push'
uses: docker/build-push-action@v4
with:
context: .
platforms: linux/amd64,linux/arm64
push: true
tags: ${{ steps.tags.outputs.tags }}
- name: 'Docker Stack Deploy'
uses: cssnr/stack-deploy-action@v1
with:
host: ${{ secrets.DOCKER_HOST }}
port: ${{ secrets.DOCKER_PORT }}
user: ${{ secrets.DOCKER_USER }}
ssh_key: '${{ secrets.DOCKER_SSH_KEY }}'
file: 'docker-compose-swarm.yaml'
name: 'stack-name'
```
# Support
For general help or to request a feature see:
- Q&A Discussion: https://github.com/cssnr/stack-deploy-action/discussions/categories/q-a
- Request a Feature: https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests
If you are experiencing an issue/bug or getting unexpected results you can:
- Report an Issue: https://github.com/cssnr/stack-deploy-action/issues
- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
- Provide General
Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Stack%20Deploy)
# Contributing
Currently, the best way to contribute to this project is to star this project on GitHub.
Additionally, you can support other GitHub Actions I have published:
- [VirusTotal Action](https://github.com/cssnr/virustotal-action)
- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action)
- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action)
- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action)
- [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action)
- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action)
- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action)
For a full list of current projects to support visit: [https://cssnr.github.io/](https://cssnr.github.io/)