Skip to content

plugin-ansible: Added adhoc and vault features to the plugin #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ompragash merged 5 commits into from
Jan 10, 2025
Merged

plugin-ansible: Added adhoc and vault features to the plugin #59

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f2a2d64
plugin-ansible: Added adhoc and vault features to the plugin
vanisrikanithi Dec 22, 2024
4a1ca24
vault issue fix
vanisrikanithi Dec 22, 2024
af42771
change mode default to playbook
vanisrikanithi Jan 4, 2025
4b3afa6
go version update
vanisrikanithi Jan 9, 2025
9ae4cc2
updated the lint error
vanisrikanithi Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 30 additions & 6 deletions docker/Dockerfile.linux.amd64
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,34 @@ LABEL maintainer="Drone.IO Community <[email protected]>" \
org.label-schema.vendor="Drone.IO Community" \
org.label-schema.schema-version="1.0"

RUN apk add --no-cache bash git curl rsync openssh-client sshpass py3-pip py3-requests py3-paramiko python3-dev libffi-dev libressl-dev libressl build-base && \
pip3 install -U pip && \
pip3 install ansible-core==2.14 boto3==1.13.10 && \
apk del --no-cache python3-dev libffi-dev libressl-dev build-base
# Install dependencies and create a virtual environment
RUN apk add --no-cache \
bash \
git \
curl \
rsync \
openssh-client \
sshpass \
py3-pip \
py3-requests \
py3-paramiko \
python3-dev \
libffi-dev \
libressl-dev \
libressl \
build-base && \
python3 -m venv /opt/venv && \
. /opt/venv/bin/activate && \
pip install --no-cache-dir -U pip && \
pip install --no-cache-dir ansible-core==2.14 boto3==1.13.10 && \
deactivate && \
apk del python3-dev libffi-dev libressl-dev build-base

ADD release/linux/amd64/drone-ansible /bin/
ENTRYPOINT ["/bin/drone-ansible"]
# Set the PATH to include the virtual environment
ENV PATH="/opt/venv/bin:$PATH"

# Add the built binary to the image
COPY release/linux/amd64/drone-ansible /bin/

# Define the entrypoint
ENTRYPOINT ["/bin/drone-ansible"]
213 changes: 173 additions & 40 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ func main() {
app.Action = run
app.Version = version
app.Flags = []cli.Flag{
cli.StringFlag{
Name: "mode",
Usage: "Mode of the functionality",
EnvVar: "PLUGIN_MODE",
},
Comment on lines +22 to +26
Copy link
Member

@Ompragash Ompragash Jan 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

set a default value to "playbook" here

Copy link
Contributor Author

@vanisrikanithi vanisrikanithi Jan 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Ompragash Addressed the above comment, please check and confirm.

Tested Pipeline Link

cli.StringFlag{
Name: "requirements",
Usage: "path to python requirements",
Expand Down Expand Up @@ -190,6 +195,98 @@ func main() {
Usage: "run operations as this user",
EnvVar: "PLUGIN_BECOME_USER,ANSIBLE_BECOME_USER",
},
cli.BoolFlag{
Name: "disable-host-key-checking",
Usage: "Disable validation of the host's SSH server keys",
EnvVar: "PLUGIN_DISABLE_HOST_KEY_CHECKING",
},
cli.BoolFlag{
Name: "host-key-checking",
Usage: "Enable validation of the host's SSH server keys",
EnvVar: "PLUGIN_HOST_KEY_CHECKING",
},
cli.StringFlag{
Name: "installation",
Usage: "Specify the path to Ansible installation",
EnvVar: "PLUGIN_INSTALLATION",
},
cli.StringFlag{
Name: "inventory-content",
Usage: "Inline inventory content as a string",
EnvVar: "PLUGIN_INVENTORY_CONTENT",
},
cli.BoolFlag{
Name: "sudo",
Usage: "Use sudo for operations",
EnvVar: "PLUGIN_SUDO",
},
cli.StringFlag{
Name: "sudo-user",
Usage: "Specify the sudo user (default: root)",
EnvVar: "PLUGIN_SUDO_USER",
},
cli.StringFlag{
Name: "vault-tmp-path",
Usage: "Temporary path for generated vault files",
EnvVar: "PLUGIN_VAULT_TMP_PATH",
},
// Ad-Hoc Specific Flags
cli.StringFlag{
Name: "hosts",
Usage: "Target hosts for ad-hoc command",
EnvVar: "PLUGIN_HOSTS",
},
cli.StringFlag{
Name: "module",
Usage: "Module name for ad-hoc execution",
EnvVar: "PLUGIN_MODULE",
},
cli.StringFlag{
Name: "module-arguments",
Usage: "Arguments for the specified module",
EnvVar: "PLUGIN_MODULE_ARGUMENTS",
},
cli.BoolFlag{
Name: "dynamic-inventory",
Usage: "Enable dynamic inventory",
EnvVar: "PLUGIN_DYNAMIC_INVENTORY",
},
cli.StringFlag{
Name: "extras",
Usage: "Additional options for ad-hoc execution",
EnvVar: "PLUGIN_EXTRAS",
},
cli.StringFlag{
Name: "vault-credentials-key",
Usage: "Vault credentials ID for encrypted files",
EnvVar: "PLUGIN_VAULT_CREDENTIALS_KEY",
},
// Vault Specific Flags
cli.StringFlag{
Name: "action",
Usage: "Action for ansible-vault (e.g., encrypt, decrypt, view)",
EnvVar: "PLUGIN_ACTION",
},
cli.StringFlag{
Name: "content",
Usage: "Content to encrypt or decrypt",
EnvVar: "PLUGIN_CONTENT",
},
cli.StringFlag{
Name: "input",
Usage: "Input file for the vault operation",
EnvVar: "PLUGIN_INPUT",
},
cli.StringFlag{
Name: "output",
Usage: "Output file for the vault operation",
EnvVar: "PLUGIN_OUTPUT",
},
cli.StringFlag{
Name: "new-vault-credentials-key",
Usage: "New Vault Credentials Key for rekeying",
EnvVar: "PLUGIN_NEW_VAULT_CREDENTIALS_KEY",
},
}

if err := app.Run(os.Args); err != nil {
Expand All @@ -200,49 +297,85 @@ func main() {
func run(c *cli.Context) error {
plugin := Plugin{
Config: Config{
Requirements: c.String("requirements"),
Galaxy: c.String("galaxy"),
Inventories: c.StringSlice("inventory"),
Playbooks: c.StringSlice("playbook"),
Limit: c.String("limit"),
SkipTags: c.String("skip-tags"),
StartAtTask: c.String("start-at-task"),
Tags: c.String("tags"),
ExtraVars: c.StringSlice("extra-vars"),
ModulePath: c.StringSlice("module-path"),
GalaxyForce: c.Bool("galaxy-force"),
Check: c.Bool("check"),
Diff: c.Bool("diff"),
FlushCache: c.Bool("flush-cache"),
ForceHandlers: c.Bool("force-handlers"),
ListHosts: c.Bool("list-hosts"),
ListTags: c.Bool("list-tags"),
ListTasks: c.Bool("list-tasks"),
SyntaxCheck: c.Bool("syntax-check"),
Forks: c.Int("forks"),
VaultID: c.String("vailt-id"),
VaultPassword: c.String("vault-password"),
Verbose: c.Int("verbose"),
PrivateKey: c.String("private-key"),
User: c.String("user"),
Connection: c.String("connection"),
Timeout: c.Int("timeout"),
SSHCommonArgs: c.String("ssh-common-args"),
SFTPExtraArgs: c.String("sftp-extra-args"),
SCPExtraArgs: c.String("scp-extra-args"),
SSHExtraArgs: c.String("ssh-extra-args"),
Become: c.Bool("become"),
BecomeMethod: c.String("become-method"),
BecomeUser: c.String("become-user"),
Mode: c.String("mode"),
Requirements: c.String("requirements"),
Galaxy: c.String("galaxy"),
Inventories: c.StringSlice("inventory"),
Playbooks: c.StringSlice("playbook"),
Limit: c.String("limit"),
SkipTags: c.String("skip-tags"),
StartAtTask: c.String("start-at-task"),
Tags: c.String("tags"),
ExtraVars: c.StringSlice("extra-vars"),
ModulePath: c.StringSlice("module-path"),
GalaxyForce: c.Bool("galaxy-force"),
Check: c.Bool("check"),
Diff: c.Bool("diff"),
FlushCache: c.Bool("flush-cache"),
ForceHandlers: c.Bool("force-handlers"),
ListHosts: c.Bool("list-hosts"),
ListTags: c.Bool("list-tags"),
ListTasks: c.Bool("list-tasks"),
SyntaxCheck: c.Bool("syntax-check"),
Forks: c.Int("forks"),
VaultID: c.String("vailt-id"),
VaultPassword: c.String("vault-password"),
Verbose: c.Int("verbose"),
PrivateKey: c.String("private-key"),
User: c.String("user"),
Connection: c.String("connection"),
Timeout: c.Int("timeout"),
SSHCommonArgs: c.String("ssh-common-args"),
SFTPExtraArgs: c.String("sftp-extra-args"),
SCPExtraArgs: c.String("scp-extra-args"),
SSHExtraArgs: c.String("ssh-extra-args"),
Become: c.Bool("become"),
BecomeMethod: c.String("become-method"),
BecomeUser: c.String("become-user"),
DisableHostKeyChecking: c.Bool("disable-host-key-checking"), // Disable SSH host key checking
HostKeyChecking: c.Bool("host-key-checking"), // Enable SSH host key validation
Installation: c.String("installation"), // Path to the Ansible executable or installation
InventoryContent: c.String("inventory-content"), // Inline inventory content
Sudo: c.Bool("sudo"), // Use sudo for operations
SudoUser: c.String("sudo-user"), // Sudo user for operations
VaultTmpPath: c.String("vault-tmp-path"), // Temporary path for vault password files and others
// Ad-Hoc Parameters
Hosts: c.String("hosts"), // Target hosts for ad-hoc command
Module: c.String("module"), // Module name for ad-hoc command
ModuleArguments: c.String("module-arguments"), // Module arguments for ad-hoc command
DynamicInventory: c.Bool("dynamic-inventory"), // Enable dynamic inventory
Extras: c.String("extras"), // Additional options for ad-hoc execution
VaultCredentialsKey: c.String("vault-credentials-key"), // Vault credentials ID for encrypted files
// Vault Parameters
Action: c.String("action"),
Content: c.String("content"),
Input: c.String("input"),
Output: c.String("output"),
NewVaultCredentialsKey: c.String("new-vault-credentials-key"),
},
}

if len(plugin.Config.Playbooks) == 0 {
return errors.New("you must provide a playbook")
}

if len(plugin.Config.Inventories) == 0 {
return errors.New("you must provide an inventory")
// Validate mode and required parameters based on the mode
switch plugin.Config.Mode {
case "playbook":
if len(plugin.Config.Playbooks) == 0 {
return errors.New("you must provide a playbook in playbook mode")
}
if len(plugin.Config.Inventories) == 0 && plugin.Config.InventoryContent == "" {
return errors.New("you must provide an inventory or inventory content in playbook mode")
}
case "adhoc":
if plugin.Config.Hosts == "" {
return errors.New("you must provide hosts for adhoc mode")
}
// Module is optional; defaults to "command" if not provided
case "vault":
if plugin.Config.VaultCredentialsKey == "" {
return errors.New("VaultCredentialsKey is mandatory for vault mode")
}
// Action, Content, Input, and Output are optional
default:
return errors.New("invalid mode: specify 'playbook', 'adhoc', or 'vault'")
}

return plugin.Exec()
Expand Down
Loading