infrastructure/docker-remote-deployment-action
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme #3

Merged
smf merged 1 commits from readme into local 2024-03-08 18:46:41 +08:00
Conversation 0 Commits 1 Files Changed 2 +10 -18
2 changed files with 10 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -25,25 +25,23 @@ Below is a brief example on how the action can be used:
## Input Configurations ## Input Configurations
### `remote_docker_host` ### `remote_docker_host`
Remote Docker host ie (user@host). Remote Docker host.
### `remote_docker_user`
Remote Docker user.
### `remote_docker_port` ### `remote_docker_port`
Remote Docker ssh port ie (22). Remote Docker ssh port ie (22).
### `ssh_public_key`
Remote Docker SSH public key eg (~/.ssh/rsa_id.pub).
### `ssh_private_key` ### `ssh_private_key`
SSH private key used to connect to the docker host eg (~/.ssh/rsa_id). SSH private key used to connect to the docker host eg (~/.ssh/rsa_id).
### `ssh_proxy_cmd`
SSH ProxyCommand used to connect to the docker host.
### `args` ### `args`
Deployment command args. Deployment command args.
### `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` ### `deploy_path`
The path where the stack files will be copied to. Default ~/docker-deployment. The absolute path on remote docker host to deploy, default rely on repo working directory.
### `stack_file_name` ### `stack_file_name`
Docker stack file used. Default is docker-compose.yml. Compose configuration files.
### `keep_files` ### `env_file_name`
Number of the files to be kept on the server. Default is 3. Specify an alternate environment file.
### `docker_prune` ### `docker_prune`
A boolean input to trigger docker prune command. Default is false. A boolean input to trigger docker prune command. Default is false.
### `pre_deployment_command_args` ### `pre_deployment_command_args`

8
action.yml
View File

@@ -11,9 +11,6 @@ inputs:
description: Remote Docker ssh port ie (22). description: Remote Docker ssh port ie (22).
required: false required: false
default: '22' default: '22'
# ssh_public_key:
# description: Remote Docker SSH public key eg (~/.ssh/rsa_id.pub).
# required: true
ssh_private_key: ssh_private_key:
description: SSH private key used to connect to the docker host eg (~/.ssh/rsa_id). description: SSH private key used to connect to the docker host eg (~/.ssh/rsa_id).
required: true required: true
@@ -24,7 +21,7 @@ inputs:
description: Deployment command args. description: Deployment command args.
required: true required: true
deploy_path: deploy_path:
description: The absolute path on remote docker host to deploy, default rely on repo working directory . description: The absolute path on remote docker host to deploy, default rely on repo working directory.
required: false required: false
stack_file_name: stack_file_name:
description: Compose configuration files. description: Compose configuration files.
@@ -32,9 +29,6 @@ inputs:
env_file_name: env_file_name:
description: Specify an alternate environment file. description: Specify an alternate environment file.
required: false required: false
keep_files:
description: Number of the files to be kept on the server. Default is 3.
required: false
docker_prune: docker_prune:
description: A boolean input to trigger docker prune command. Default is false. description: A boolean input to trigger docker prune command. Default is false.
required: false required: false