ansible-role-thales-hsm/README.rst
Ade Lee e82db3b3fc Add support for configuring load_sharing mode
Change-Id: Ia5fedaf5b1dbe7d8958c04a3e8534098d4bbd548
2021-02-17 11:04:23 -05:00

77 lines
2.2 KiB
ReStructuredText

thales-hsm
==========
This is a role to manage the client software for Entrust nShield Connect
Hardware Security Modules (HSMs).
This repo uses the "Thales" name for historical reasons:
At the time when this repository was created nShield HSMs were owned by Thales.
Since then, the nShield line of HSMs have gone through some ownership changes,
including nCipher for some time, and currently Entrust.
If you are looking for the ansible role to manage client software for
Thales Luna Network HSMs you can find it here:
https://opendev.org/openstack/ansible-role-lunasa-hsm
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 to 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_rfs_ip_address
- None
- IPv4 address for the Thales RFS host.
* - 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.
* - nshield_hsms
- None
- List of one or more HSM devices
Requirements
------------
- ansible >= 2.4