Skip to content

Latest commit

 

History

History
64 lines (53 loc) · 2.61 KB

README.md

File metadata and controls

64 lines (53 loc) · 2.61 KB
Raw

maxhoesel.smallstep.step_cli

Install the step-cli tool on a host.

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

  • The following distributions are currently supported and tested:
    • Ubuntu: 20.04 LTS, 22.04 LTS, 24.04 LTS
    • Debian: 11, 12
    • Fedora: 39, 40
    • RHEL(-compatible): 9 (RockyLinux is used for testing)
    • Other distributions may work as well, but are not tested
  • Supported architectures: amd64, arm64
  • This role requires root access. Make sure to run this role with become: yes or equivalent

Role Variables

step_cli_executable
  • 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 and has correct SELinux policies set, if applicable) 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_version
  • 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 (same as the upstream step-cli packages)
step_cli_install_dir
  • Used if step_cli_executable is a filename and not yet present
  • Sets the directory to install step_cli_executable into
  • The directory must already exist
  • Ignored if step_cli_executable contains a path
  • Default: /usr/bin

Example Playbook

# Install step-cli into the default path
- hosts: all
  roles:
  - role: maxhoesel.smallstep.step_cli
    become: yes

# Install a specific step-cli version to a custom path
- hosts: all
  roles:
  - role: maxhoesel.smallstep.step_cli
    become: yes
    vars:
      step_cli_version: "0.21.0"
      # This will install step-cli to `/opt/step-cli`
      # make sure that this directory is in $PATH, or the role will fail to find `step-cli`
      # alternatively, you can also set `step_cli_executable` like so:
      #step_cli_executable: /opt/step-cli
      step_cli_install_dir: /opt