thalesgroup.ciphertrust.cte_csi_storage_group module – Manage CTE CSI Storage Group

Note

This module is part of the thalesgroup.ciphertrust collection (version 1.0.0).

To install it, use: ansible-galaxy collection install thalesgroup.ciphertrust.

To use it in a playbook, specify: thalesgroup.ciphertrust.cte_csi_storage_group.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

  • Define and manage CipherTrust Transparent Encryption (CTE) Container Storage Interface (CSI) and also add guard policies and clients to the same.

  • This will allow administrator to apply data protection/reveal based on the client or the guard points.

Parameters

Parameter

Comments

client_id

string

Identifier of the client added added to the CSI Group

client_list

list / elements=string

List of identifiers of clients to be associated with the client group. This identifier can be the name or UUID.

client_profile

string

Optional Client Profile for the storage group. If not provided, the default profile will be used

description

string

Optional description for the storage group

gp_id

string

Identifier of the guard point added to the CSI Group

guard_enabled

boolean

Enable or disable the GuardPolicy. Set to true to enable, false to disable.

Choices:

  • false

  • true

id

string

Identifier of the CTE CSI Storage Group to be patched

k8s_namespace

string

Name of the K8s namespace

k8s_storage_class

string

Name of the K8s StorageClass

localNode

dictionary / required

this holds the connection parameters required to communicate with an instance of CipherTrust Manager (CM)

holds IP/FQDN of the server, username, password, and port

password

string / required

admin password of CM

server_ip

string / required

CM Server IP or FQDN

server_port

integer / required

Port on which CM server is listening

Default: 5432

server_private_ip

string / required

internal or private IP of the CM Server, if different from the server_ip

user

string / required

admin username of CM

verify

boolean / required

if SSL verification is required

Choices:

  • false ← (default)

  • true

name

string

Name to uniquely identify the CSI storage group. This name will be visible on the CipherTrust Manager

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

  • "add_client"

  • "remove_client"

  • "add_guard_point"

  • "patch_guard_point"

  • "remove_guard_point"

policy_list

list / elements=string

List of CSI policy identifiers to be associated with the storage group. This identifier can be the name or UUID.

Examples

- name: "Create CSI Storage Group"
  thalesgroup.ciphertrust.cte_csi_storage_group:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: create
    name: AnsibleCSI_SG_1
    k8s_namespace: AnsibleK8s_NS_1
    k8s_storage_class: AnsibleK8s_SC_1
    description: "Test CSIStorageGroup"
    client_profile: DefaultClientProfile
  register: csi_sg

- name: "Edit CSI Storage Group"
  thalesgroup.ciphertrust.cte_csi_storage_group:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: create
    id: "{{ csi_sg['response']['id'] }}"
    description: "Test CSIStorageGroup Updated"
    client_profile: DefaultClientProfile

- name: "Add clients to the CSI Storage Group"
  thalesgroup.ciphertrust.cte_csi_storage_group:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: add_client
    id: "{{ csi_sg['response']['id'] }}"
    client_list:
      - Client1
      - Client2

- name: "Add guarpolicy to the CSI Storage Group"
  thalesgroup.ciphertrust.cte_csi_storage_group:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: add_guard_point
    id: "{{ csi_sg['response']['id'] }}"
    policy_list:
      - CSI_Policy_1
      - CSI_Policy_2

Authors

  • Anurag Jain, Developer Advocate Thales Group