certificate_authority – Manage a Hyperledger Fabric certificate authority

Synopsis 

Create, update, or delete a Hyperledger Fabric certificate authority.

This module works with the IBM Support for Hyperledger Fabric software or the Hyperledger Fabric Open Source Stack running in a Red Hat OpenShift or Kubernetes cluster.

Parameters 

api_endpoint (required)
The URL for the Fabric operations console.

Type: str

api_authtype (required)
basic - Authenticate to the Fabric operations console using basic authentication. You must provide both a valid API key using api_key and API secret using api_secret.

Type: str

api_key (required)
The API key for the Fabric operations console.

Type: str

api_secret
The API secret for the Fabric operations console.

Only required when api_authtype is basic.

Type: str

api_timeout
The timeout, in seconds, to use when interacting with the Fabric operations console.

Type: int

Default value: 60

state
absent - A certificate authority matching the specified name will be stopped and removed.

present - Asserts that a certificate authority matching the specified name and configuration exists. If no certificate authority matches the specified name, a certificate authority will be created. If a certificate authority matches the specified name but the configuration does not match, then the certificate authority will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the specified configuration.

Type: str

Default value: present

name (required)
The name of the certificate authority.

Type: str

config_override
The configuration overrides for the root certificate authority and the TLS certificate authority.

If configuration overrides are provided for the root certificate authority, but not the TLS certificate authority, then the configuration overrides for the root certificate authority will be copied for the TLS certificate authority.

Type: dict

ca
The configuration overrides for the root certificate authority.

See the Hyperledger Fabric documentation for available options: https://hyperledger-fabric-ca.readthedocs.io/en/release-1.4/serverconfig.html

Type: dict

tlsca
The configuration overrides for the TLS certificate authority.

See the Hyperledger Fabric documentation for available options: https://hyperledger-fabric-ca.readthedocs.io/en/release-1.4/serverconfig.html

Type: dict

resources
The Kubernetes resource configuration for the certificate authority.

Type: dict

ca
The Kubernetes resource configuration for the certificate authority container.

Type: dict

requests
The Kubernetes resource requests for the certificate authority container.

Type: str

cpu
The Kubernetes CPU resource request for the certificate authority container.

Type: str

Default value: 100m

memory
The Kubernetes memory resource request for the certificate authority container.

Type: str

Default value: 200M

storage
The Kubernetes storage configuration for the certificate authority.

Type: dict

ca
The Kubernetes storage configuration for the certificate authority container.

Type: dict

size
The size of the Kubernetes persistent volume claim for the certificate authority container.

Type: str

Default value: 20Gi

class
The Kubernetes storage class for the the Kubernetes persistent volume claim for the certificate authority container.

By default, the Kubernetes storage class for the Fabric operations console is used.

Type: str

hsm
The PKCS #11 compliant HSM configuration to use for the certificate authority.

Type: dict

pkcs11endpoint
The HSM proxy endpoint that the certificate authority should use.

Type: str

label
The HSM label that the certificate authority should use.

Type: str

pin
The HSM pin that the certificate authority should use.

Type: str

zone
The Kubernetes zone for this certificate authority.

If you do not specify a Kubernetes zone, and multiple Kubernetes zones are available, then a random Kubernetes zone will be selected for you.

See the Kubernetes documentation for more information: https://kubernetes.io/docs/setup/best-practices/multiple-zones/

Type: str

replicas
The number of replicas that the Kubernetes deployment should have for this certificate authority.

If you want to use more than one replica, you must also use PostgreSQL as the database for this certificate authority.

Type: int

version
The version of Hyperledger Fabric to use for this certificate authority.

If you do not specify a version, the default Hyperledger Fabric version will be used for a new certificate authority.

If you do not specify a version, an existing certificate authority will not be upgraded.

If you specify a new version, an existing certificate authority will be automatically upgraded.

The version can also be specified as a version range specification, for example >=2.2,<3.0, which will match Hyperledger Fabric v2.2 and greater, but not Hyperledger Fabric v3.0 and greater.

See the semantic_version Python module documentation for more information: https://python-semanticversion.readthedocs.io/en/latest/reference.html#semantic_version.SimpleSpec

Type: str

wait_timeout
The timeout, in seconds, to wait until the certificate authority is available.

Type: int

Default value: 60

Examples 

- name: Create certificate authority
  hyperledger.fabric_ansible_collection.certificate_authority:
      state: present
      api_endpoint: https://console.example.org:32000
      api_authtype: basic
      api_key: xxxxxxxx
      api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      name: Org1 CA
      config_override:
          ca:
              registry:
                  maxenrollments: -1
              identities:
                  - name: admin
                    pass: adminpw
                    type: client
                    maxenrollments: -1
                    attrs:
                        hf.Registrar.Roles: "*"
                        hf.Registrar.DelegateRoles: "*"
                        hf.Revoker: true
                        hf.IntermediateCA: true
                        hf.GenCRL: true
                        hf.Registrar.Attributes: "*"
                        hf.AffiliationMgr: true

- name: Create certificate authority with custom resources and storage
  hyperledger.fabric_ansible_collection.certificate_authority:
      state: present
      api_endpoint: https://console.example.org:32000
      api_authtype: basic
      api_key: xxxxxxxx
      api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      name: Org1 CA
      config_override:
          ca:
              registry:
                  maxenrollments: -1
                  identities:
                      - name: admin
                        pass: adminpw
                        type: client
                        maxenrollments: -1
                        attrs:
                            hf.Registrar.Roles: "*"
                            hf.Registrar.DelegateRoles: "*"
                            hf.Revoker: true
                            hf.IntermediateCA: true
                            hf.GenCRL: true
                            hf.Registrar.Attributes: "*"
                            hf.AffiliationMgr: true
          resources:
              ca:
                  requests:
                      cpu: 200m
                      memory: 400M
          storage:
              ca:
                  size: 40Gi
                  class: ibmc-file-gold

- name: Create certificate authority that uses an HSM
  hyperledger.fabric_ansible_collection.certificate_authority:
      state: present
      api_endpoint: https://console.example.org:32000
      api_authtype: basic
      api_key: xxxxxxxx
      api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      name: Org1 CA
      config_override:
          ca:
              registry:
              maxenrollments: -1
              identities:
                  - name: admin
                    pass: adminpw
                    type: client
                    maxenrollments: -1
                    attrs:
                        hf.Registrar.Roles: "*"
                        hf.Registrar.DelegateRoles: "*"
                        hf.Revoker: true
                        hf.IntermediateCA: true
                        hf.GenCRL: true
                        hf.Registrar.Attributes: "*"
                        hf.AffiliationMgr: true
      hsm:
          pkcs11endpoint: tcp://pkcs11-proxy.example.org:2345
          label: Org1 CA label
          pin: 12345678

- name: Destroy certificate authority
  hyperledger.fabric_ansible_collection.certificate_authority:
      state: absent
      api_endpoint: https://console.example.org:32000
      api_authtype: basic
      api_key: xxxxxxxx
      api_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      name: Org1 CA

Return Values 

certificate_authority
The certificate authority.

Returned: when state is present

Type: dict

name
The name of the certificate authority.

Type: str

Sample: Org1 CA

api_url
The URL for the API of the certificate authority.

Type: str

Sample: https://org1ca-api.example.org:32000

operations_url
The URL for the operations service of the certificate authority.

Type: str

Sample: https://org1ca-operations.example.org:32000

ca_url
The URL for the API of the certificate authority.

Type: str

Sample: https://org1ca-api.example.org:32000

ca_name
The certificate authority name to use for enrollment requests.

Type: str

Sample: ca

tlsca_name
The certificate authority name to use for TLS enrollment requests.

Type: str

Sample: tlsca

location
The location of the certificate authority.

Type: str

Sample: ibmcloud

pem
The TLS certificate chain for the certificate authority.

The TLS certificate chain is returned as a base64 encoded PEM.

Type: str

Sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...

tls_cert
The TLS certificate chain for the certificate authority.

The TLS certificate chain is returned as a base64 encoded PEM.

Type: str

Sample: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t...