Docker Deployment Action 使用教程
docker-deployment-actionA GitHub Action that supports docker-compose and Docker Swarm deployments项目地址:https://gitcode.com/gh_mirrors/do/docker-deployment-action
项目介绍
Docker Deployment Action
是一个 GitHub Action,支持 Docker Compose 和 Docker Swarm 部署。它允许用户在 GitHub Actions 工作流中自动化 Docker 部署过程,无论是单机还是集群环境。
项目快速启动
步骤一:克隆项目
首先,克隆项目到本地:
git clone https://github.com/wshihadeh/docker-deployment-action.git
步骤二:配置 GitHub Actions 工作流
在项目根目录下创建 .github/workflows/deploy.yml
文件,并添加以下内容:
name: Docker Deployment
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Deploy to Docker Swarm
uses: wshihadeh/docker-deployment-action@v2
with:
remote_docker_host: user@myswarm.com
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_application
步骤三:添加 Secrets
在 GitHub 仓库的 Settings
-> Secrets
中添加以下 Secrets:
DOCKER_SSH_PRIVATE_KEY
:SSH 私钥DOCKER_SSH_PUBLIC_KEY
:SSH 公钥
步骤四:推送代码
将配置好的文件推送到 GitHub 仓库:
git add .
git commit -m "Add Docker Deployment Action"
git push origin main
应用案例和最佳实践
应用案例
- CI/CD 自动化:通过 GitHub Actions 自动部署 Docker 应用,减少手动操作,提高部署效率。
- 多环境部署:支持 Docker Compose 和 Docker Swarm,适用于不同规模的部署环境。
最佳实践
- 安全管理:使用 Secrets 管理敏感信息,如 SSH 密钥,确保安全性。
- 版本控制:使用特定版本的 Action,如
@v2
,确保稳定性。 - 日志管理:配置日志级别,便于调试和监控。
典型生态项目
- Docker Compose:用于本地开发和测试的多容器应用管理工具。
- Docker Swarm:Docker 原生的集群管理和编排工具。
- GitHub Actions:GitHub 提供的自动化工作流工具,用于 CI/CD 流程。
通过以上步骤和案例,您可以快速上手并使用 Docker Deployment Action
进行自动化部署。
docker-deployment-actionA GitHub Action that supports docker-compose and Docker Swarm deployments项目地址:https://gitcode.com/gh_mirrors/do/docker-deployment-action