Vultr with YAML

Vultr [Password]

YAML parameters for Vultr [Password]

NameTypeDescription
authentication_mode
Required
StringThe authentication mode for SSH. Should be set to PASS.
host
Required
StringThe host for the connection.
login
Required
StringThe username required to connect to the server.
name
Required
StringThe name of the action.
port
Required
StringThe port for the connection.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to VULTR.
input_typeStringDefines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathStringThe path in the repository.
passwordStringThe password required to connect to the server.
remote_pathStringThe absolute or relative path on the remote server.
deployment_excludesString[]The paths and/or files that will be left our during the deployment.
deployment_includesString[]The exceptions from the ignore patterns set in deployment_excludes.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.

YAML example for Vultr [Password]

actions:
- action: "Upload files to Vultr"
type: "VULTR"
input_type: "SCM_REPOSITORY"
local_path: "/"
remote_path: "Home/www/"
login: "root"
password: "${vultr_password}"
host: "123.45.67.89"
port: "22"
authentication_mode: "PASS"
deployment_excludes:
- "/assets/"
- "file.txt"
deployment_includes:
- "/assets/assets-new/"
- "/assets/file.txt"

Vultr [Private Key & Password]

YAML parameters for Vultr [Private Key & Password]

NameTypeDescription
authentication_mode
Required
StringThe authentication mode for SSH. Should be set to PRIVATE_KEY_AND_PASS.
host
Required
StringThe host for the connection.
login
Required
StringThe username required to connect to the server.
name
Required
StringThe name of the action.
password
Required
StringThe password required to connect to the server.
port
Required
StringThe port for the connection.
server_key
Required
StringThe private SSH key.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to VULTR.
input_typeStringDefines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathStringThe path in the repository.
passphraseStringThe passphrase for the private SSH key.
remote_pathStringThe absolute or relative path on the remote server.
deployment_excludesString[]The paths and/or files that will be left out during the deployment.
deployment_includesString[]The exceptions from the ignore patterns set in deployment_excludes.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.

YAML example for Vultr [Private Key & Password]

actions:
- action: "Upload files to Vultr"
type: "VULTR"
input_type: "SCM_REPOSITORY"
local_path: "/"
remote_path: "Home/www/"
login: "root"
password: "${vultr_password}"
passphrase: "${vultr_key_passphrase}"
host: "123.45.67.89"
port: "22"
authentication_mode: "PRIVATE_KEY_AND_PASS"
deployment_excludes:
- "/assets/"
- "file.txt"
deployment_includes:
- "/assets/assets-new/"
- "/assets/file.txt"

Vultr [Private Key]

YAML parameters for Vultr [Private Key]

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to VULTR.
authentication_mode
Required
StringThe authentication mode for SSH. Should be set to PRIVATE_KEY or ENV_KEY.
host
Required
StringThe host for the connection.
login
Required
StringThe username required to connect to the server.
port
Required
StringThe port for the connection.
server_key
Required
StringThe private SSH key. Required if authentication_mode is set to PRIVATE_KEY.
env_key
Required
StringThe private SSH key name defined in environment variables. Required if authentication_mode is set to ENV_KEY.
trigger_timeStringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
input_typeStringDefines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathStringThe path in the repository.
passphraseStringThe passphrase for the private SSH key.
remote_pathStringThe absolute or relative path on the remote server.
deployment_excludesString[]The paths and/or files that will be left out during the deployment.
deployment_includesString[]The exceptions from the ignore patterns set in deployment_excludes.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.

YAML example for Vultr [Private Key]

actions:
- action: "Upload files to Vultr"
type: "VULTR"
input_type: "SCM_REPOSITORY"
local_path: "/"
remote_path: "Home/www/"
login: "root"
host: "123.45.67.89"
port: "22"
server_key: "-----BEGIN RSA PRIVATE KEY-----\\r\\nProc-Type: 4,ENCRYPTED\\r\\nDEK-Info: DES-EDE3-CBC,688DBB59CFC83D58\\r\\n\\r\\n1m3qZGEqXEfLPIm9KZacr17/iMVOIJcvSLoMJueM8+QbcK4JStzbre2AN99TkCN/\\r\\nr1V12deiq/lJUPX07K30tnsTS+7z4Pq/D2WhirD+WQcREgdQU1A8dlx2NMRDi7d0\\r\\n32w8ZPlciz3bc5rpF0vy5Ll2q9TWye4fpgQwPUnEkam0SaRRwAMpnT/46/AeWgmn\\r\\n9nu8CNZp7QcOIR2WH6RNRhQTOD/hC+kVCxbEQUL5MOHV7iZX6BeUwd8bBNmci+o0\\r\\nz/I7ZLQo596Ih+0KPgA+vwS9c4c1TrUYhupU7tyIL6PwpAzhlq/UwxeE032AypiI\\r\\nkpm7z8I7MBYZs0bsS5UOa3FdHF8p38KrxozwQfsOmBxEHpAWM3slvqJpauuJLlyx\\r\\ncFfzgOTFSsLJ5J59ZdVRpeFr/W5+/9wpc+AJUP80i4pMEWsnamwdK9rU6QwpFiPf\\r\\nARzk6VdIiDlZRWeyoYcEfOGEJt+J0aSlXkt6BHgvkmDGq0YA9CNqb6GdB9t073yX\\r\\nCAqsQ/XEvDuZw14KHxErr5aL6uuZiioDhUmoGz9S3HstFR4T0nRmfCSrLyxTFQf1\\r\\nF0Sn9Dv4LrSGrzM/0svdlqUc5TDxPBVoW2Q56dNkAQwJg0k25x5YLdTUcd4GjbJW\\r\\n0qLJaO+bxfTDk5rCMHflYNCW18fEdeEvpBwL0ey93+Qya4xqjTOy2fgoz9U0QLUD\\r\\nfbgWSiFWnurC8I/SYcQUAEOKiYCDRzud92WzyjwRr2yPlcqf/Qi8+VNDyvoGYZgi\\r\\nD3vgqA9KPKnYkODYKIFTMW0bbRkgnLOsc1v5mkPTerUpeOGWPysOu3WV9if9e2lG\\r\\npG1gVfRJQei0k5Mex6CCV0gSQbf2MjswiyDvrPQ1yhpCsFeDAGKcLx+GU1/AhLRP\\r\\np32mqF5XJrMSTvifCGNOHkBMVUXmTjF7KCYZvcsERi1i2xNcwtcsLRm+QJKQsYQf\\r\\nhJ17/lOOcC8cqVLGmik3adOcOMCWq2b+NjgoJT55Hc0N07ikuQqazhFpZKkMFZEr\\r\\nFqbDZ2zGMwODjcDancXaghSS7ciIEdoAPGor1rftJ+l2oQVzBPk4pNfBKHJC7UmS\\r\\nUOGW3rGLSlRQcVEBFHbrsGP/JKXd06Cbrc3kDrdXbO430qRZh9LQQKbjvxHonU8Z\\r\\nXFeRpwG32YLSCSQunJtoEWQRJpVefc7rEmBAdLfNyA7xyqH2JLtlflaH9QApl7vE\\r\\nGNJJ5iuHCHPJwfhlaSMBF/Cb9Ofp4BM5fnNKrwaI9twv//U6XhVfYRcaKhCFEoMb\\r\\nYo4k7cKTQzL95xT1aYnwqSqtaDfoXASoA9j/mD0aMU+9zQEa0tVbJ/6Zjn3vMSTx\\r\\npvCYkXy9kZzEJZ2r7BiaQX0HX5Ki/Opt4eTWL5NbokDsE1bQu+D2BskJz30pRRRK\\r\\nvRargCRNl26158HNRLPkbo/gkwfJbfIBFgJ8YEQkcNap110oEaW6l3lnktZ0Ct3P\\r\\nEjkrppoV6UU1HCVmcoljOldTXQZuKmpz7aIuSwmUqoU4vWNvYteIZ3BhaVwCu/p8\\r\\nVaFL8Sapda0WYXPWXHuV+Dj295bedJxeqraWrQB87vKP4NVyzWv1WA==\\r\\n-----END RSA PRIVATE KEY-----\\r\\n"
passphrase: "${vultr_key_passphrase}"
authentication_mode: "PRIVATE_KEY"
deployment_excludes:
- "/assets/"
- "file.txt"
deployment_includes:
- "/assets/assets-new/"
- "/assets/file.txt"
actions:
- action: "Upload files to Vultr"
type: "VULTR"
input_type: "SCM_REPOSITORY"
local_path: "/"
remote_path: "Home/www/"
login: "root"
host: "123.45.67.89"
port: "22"
env_key: "MyKey"
passphrase: "${vultr_key_passphrase}"
authentication_mode: "ENV_KEY"
deployment_excludes:
- "/assets/"
- "file.txt"
deployment_includes:
- "/assets/assets-new/"
- "/assets/file.txt"