community.general.rax_clb_ssl (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Set up, reconfigure, or remove SSL termination for an existing load balancer.

Requirements

• pyrax

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Enable SSL termination on a load balancer
  community.general.rax_clb_ssl:
    loadbalancer: the_loadbalancer
    state: present
    private_key: "{{ lookup('file', 'credentials/server.key' ) }}"
    certificate: "{{ lookup('file', 'credentials/server.crt' ) }}"
    intermediate_certificate: "{{ lookup('file', 'credentials/trust-chain.crt') }}"
    secure_traffic_only: true
    wait: true

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Disable SSL termination
  community.general.rax_clb_ssl:
    loadbalancer: "{{ registered_lb.balancer.id }}"
    state: absent
    wait: true

Inputs

    
env:
    description:
    - Environment as configured in C(~/.pyrax.cfg), see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
    type: str

wait:
    default: false
    description:
    - Wait for the balancer to be in state "running" before turning.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - If set to "present", SSL termination will be added to this load balancer.
    - If "absent", SSL termination will be removed instead.
    type: str

region:
    description:
    - Region to create an instance in.
    type: str

api_key:
    aliases:
    - password
    description:
    - Rackspace API key, overrides O(credentials).
    type: str

enabled:
    default: true
    description:
    - If set to "false", temporarily disable SSL termination without discarding
    - existing credentials.
    type: bool

username:
    description:
    - Rackspace username, overrides O(credentials).
    type: str

tenant_id:
    description:
    - The tenant ID used for authentication.
    type: str

certificate:
    description:
    - The public SSL certificates as a string in PEM format.
    type: str

credentials:
    aliases:
    - creds_file
    description:
    - File to find the Rackspace credentials in. Ignored if O(api_key) and O(username)
      are provided.
    type: path

private_key:
    description:
    - The private SSL key as a string in PEM format.
    type: str

secure_port:
    default: 443
    description:
    - The port to listen for secure traffic.
    type: int

tenant_name:
    description:
    - The tenant name used for authentication.
    type: str

loadbalancer:
    description:
    - Name or ID of the load balancer on which to manage SSL termination.
    required: true
    type: str

wait_timeout:
    default: 300
    description:
    - How long before "wait" gives up, in seconds.
    type: int

auth_endpoint:
    description:
    - The URI of the authentication service.
    - If not specified will be set to U(https://identity.api.rackspacecloud.com/v2.0/).
    type: str

identity_type:
    default: rackspace
    description:
    - Authentication mechanism to use, such as rackspace or keystone.
    type: str

https_redirect:
    description:
    - If "true", the load balancer will redirect HTTP traffic to HTTPS.
    - Requires "secure_traffic_only" to be true. Incurs an implicit wait if SSL
    - termination is also applied or removed.
    type: bool

validate_certs:
    aliases:
    - verify_ssl
    description:
    - Whether or not to require SSL validation of API endpoints.
    type: bool

secure_traffic_only:
    default: false
    description:
    - If "true", the load balancer will *only* accept secure traffic.
    type: bool

intermediate_certificate:
    description:
    - One or more intermediate certificate authorities as a string in PEM
    - format, concatenated into a single string.
    type: str