Browse Source

Document role variables and defaults

changes/95/641095/1
Douglas Mendizábal 3 years ago
parent
commit
369ac53a5a
  1. 59
      README.rst
  2. 4
      defaults/main.yaml

59
README.rst

@ -3,6 +3,65 @@ thales-hsm
A role to manage Thales Hardware Security Module (HSM) client software.
Role Variables
--------------
.. list-table::
:widths: auto
:header-rows: 1
* - Name
- Default Value
- Description
* - thales_install_client
- false
- Whether the role should install the client software on the target host.
* - thales_configure_rfs
- false
- Whether the role should execute the RFS configuration tasks.
* - thales_client_working_dir
- /tmp/thales_client_install
- Working directory in the target host.
* - thales_client_gid
- 42481
- Group ID for the thales group.
* - thales_client_uid
- 42481
- User ID for the thales user.
* - thales_client_tarball_name
- None
- Filename for the Thales client software tarball.
* - thales_client_tarball_location
- None
- Full URL where a copy of the client software tarball can be downloaded.
* - thales_client_path
- linux/libc6_11/amd64/nfast
- Path tho the client software directory inside the tarball
* - thales_km_data_tarball_name
- None
- Filename for the KM Data tarball
* - thales_km_data_location
- None
- Full URL where a copy of the KM Data tarball can be downloaded.
* - thales_hsm_ip_address
- None
- IPv4 address for the Thales HSM.
* - thales_rfs_ip_address
- None
- IPv4 address for the Thales RFS host.
* - thales_hsm_config_location
- None
- Unique hsm diretory name where the RFS configuration is stored.
(e.g. hsm-XXX-XXX-XXX)
* - thales_client_ips
- None
- Whitespace separated list of IP addresses to be added to RFS config.
* - thales_bootstrap_client_ip
- None
- Bootstrap client IP address. This IP will be allowed to update RFS
server.
Requirements
------------

4
defaults/main.yaml

@ -1,3 +1,7 @@
---
thales_install_client: false
thales_configure_rfs: false
thales_client_working_dir: /tmp/thales_client_install
thales_client_gid: 42481
thales_client_uid: 42481
thales_client_path: linux/libc6_11/amd64/nfast
Loading…
Cancel
Save