maxhoesel.smallstep.step_cli role – Install the step-cli tool on a host.

Note

This role is part of the maxhoesel.smallstep collection (version 0.24.5).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install maxhoesel.smallstep.

To use it in a playbook, specify: maxhoesel.smallstep.step_cli.

Entry point main – Install the step-cli tool on a host.

Synopsis

  • This role is used by step_bootstrap_host and step_ca, but can also be used standalone to install the cli tool and then do nothing else.

  • Requirements:

    • Root access using become: yes or equivalent

  • Supported distributions:

    • Ubuntu 18.04 LTS or newer

    • Debian 10 or newer

    • Fedora 36 or newer

    • A CentOS-compatible distribution like RockyLinux/AlmaLinux 8 or newer. RockyLinux is used for testing

  • Supported architectures: amd64, arm64

Parameters

Parameter

Comments

step_cli_executable

path

What to name and where to put the step-cli executable that will be installed by this role

Can be an absolute path (make sure that the parent directory is in $PATH) or a filename

If this executable is not found and step_cli_executable is a path, the executable will be installed there

If this executable is not found and step_cli_executable is a name, the executable will be installed at step_cli_install_dir with the given name

Default: "step-cli"

step_cli_install_dir

path

Used if the binary defined by step_cli_executable is not found on the system and step_cli_executable contains a executable name

Sets the directory to install step_cli_executable into

The directory must already exist

Ignored if step_cli_executable contains a directory already

Default: "/usr/bin"

step_cli_version

string

Set the version of step to install

Can be a version tag (e.g. 0.15.3), or latest to always install the most recent version

It is highly recommended that your cli version matches the collection version (e.g. if you are using the collection version 0.20.x you should be installing step-cli version 0.20.x as well)

Note that the role will query the GitHub API if this value is set to latest. Try setting a specific version if you are running into rate limiting issues

Default: "latest"