maxhoesel.smallstep.step_ca_bootstrap module – Initialize step-cli to trust a step-ca server

Note

This module 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. You need further requirements to be able to use this module, see Requirements for details.

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

New in maxhoesel.smallstep 0.3.0

Synopsis

  • Downloads the root certificate from the given cert authority and sets up the local environment to use it. This allows running other step-cli ca commands without having to specify ca_url or ca_config every time.

Requirements

The below requirements are needed on the host that executes this module.

  • step-cli must be installed on the remote host. You can set the executable name/path with step_cli_executable.

Parameters

Parameter

Comments

ca_url

string / required

URI of the targeted Step Certificate Authority

fingerprint

string / required

The fingerprint of the targeted root certificate

force

boolean

Force the overwrite of files without asking.

Choices:

  • false ← (default)

  • true

install

boolean

Install the root certificate into the system truststore. Make sure that the user has the required privileges.

Choices:

  • false ← (default)

  • true

redirect_url

string

Terminal OAuth redirect url.

step_cli_executable

path

Name (or absolute path) of the step-cli executable to use

Default: "step-cli"

Notes

Note

  • Check mode is supported.

Examples

- name: Bootstrap using the CA url and a fingerprint
  maxhoesel.smallstep.step_ca_bootstrap:
    ca_url: https://ca.example.org
    fingerprint: d9d0978692f1c7cc791f5c343ce98771900721405e834cd27b9502cc719f5097

- name: Bootstrap and install the root certificate
  maxhoesel.smallstep.step_ca_bootstrap:
    ca_url: https://ca.example.org
    fingerprint: d9d0978692f1c7cc791f5c343ce98771900721405e834cd27b9502cc719f5097
    install: yes

Authors

  • Max Hösel (@maxhoesel)