intellium.rancher.rancher_cloud_credential (0.0.7) — module

Manage Rancher Cloud Credentials

| "added in version" 0.0.2 of intellium.rancher"

Authors: Wouter Moeken (@intellium), Cees Moerkerken (@ceesios)

Install collection

Install with ansible-galaxy collection install intellium.rancher:==0.0.7


Add to requirements.yml

  collections:
    - name: intellium.rancher
      version: 0.0.7

Description

This module allows you to manage the lifecycle of Cluster Repositories.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Add repository
- name: Test create cc
  intellium.rancher.rancher_cloud_credential:
    host: rancher.example.com
    token: "{{ login['token'] }}"
    name: "mycred"
    type: vsphere
    vsphereconfig:
        vcenter: "vcenter.example.com"
        username: "myuser"
        password: "mysecretpass"
        vcenterPort: "443"
    validate_certs: true
    full_response: true
    register: cc

Inputs

    
host:
    aliases:
    - rancher_host
    description: Hostname of rancher system
    required: true
    type: str

name:
    description: Name of the credential
    required: true
    type: str

type:
    choices:
    - vsphere
    - ec2
    - azure
    - digitalocean
    - google
    - harvester
    - linode
    - s3
    description: Type of credential
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: absent or present
    type: str

token:
    aliases:
    - rancher_token
    description: Token used for authentication
    required: false
    type: str

labels:
    description: labels
    required: false
    type: dict

password:
    aliases:
    - rancher_password
    description: Password for user/pass login instead of token
    required: false
    type: str

s3config:
    description: s3 Cloud Credential to create in Rancher
    required: false
    suboptions:
      accessKey:
        description:
        - S3 EC2 Access Key
        - Required when type=ec2 or s3
        type: str
      defaultBucket:
        description:
        - S3 bucket
        - Required when type=s3
        type: str
      defaultEndpoint:
        description:
        - S3 endpoint
        type: str
      defaultEndpointCA:
        description:
        - S3 endpointca
        type: str
      defaultFolder:
        description:
        - S3 folder
        type: str
      defaultRegion:
        default: ''
        description:
        - S3 EC2 Region
        required: false
        type: str
      defaultSkipSSLVerify:
        description:
        - S3 skipsslverify
        type: str
      secretKey:
        description:
        - S3 EC2 Secret Key
        - Required when type=ec2 or s3
        type: str
    type: dict

username:
    aliases:
    - rancher_username
    description: Username for user/pass login instead of token
    required: false
    type: str

annotations:
    description: annotations
    required: false
    type: dict

azureconfig:
    description: azure Cloud Credential to create in Rancher
    required: false
    suboptions:
      clientId:
        description: clientId
        type: str
      clientSecret:
        description: clientSecret
        type: str
      environment:
        description: environment
        type: str
      subscriptionId:
        description: subscriptionId
        type: str
      tenantId:
        description: tenantId
        type: str
    type: dict

googleconfig:
    description: google Cloud Credential to create in Rancher
    required: false
    suboptions:
      authEncodedJson:
        description:
        - File contents for authEncodedJson
        - Required when type=google
        type: str
    type: dict

linodeconfig:
    description: linode Cloud Credential to create in Rancher
    required: false
    suboptions:
      token:
        description:
        - Linode API access token
        - Required when type=linode
        type: str
    type: dict

full_response:
    description: Whether to return full api response
    required: false
    type: bool

vsphereconfig:
    description: vsphere Cloud Credential to create in Rancher
    required: false
    suboptions:
      password:
        description:
        - vSphere Password
        - Required when type=vsphere
        type: str
      username:
        description:
        - vSphere username
        - Required when type=vsphere
        type: str
      vcenter:
        description:
        - vSphere IP/hostname for vCenter
        - Required when type=vsphere
        type: str
      vcenterPort:
        default: '443'
        description:
        - vSphere Port number for vCenter
        type: str
    type: dict

validate_certs:
    default: true
    description: Verify SSL certificates
    required: false
    type: bool

amazonec2config:
    description: amazon ec2 Cloud Credential to create in Rancher
    required: false
    suboptions:
      accessKey:
        description:
        - AWS EC2 Access Key
        - Required when type=ec2 or s3
        type: str
      defaultRegion:
        default: ''
        description:
        - AWS EC2 Region
        required: false
        type: str
      secretKey:
        description:
        - AWS EC2 Secret Key
        - Required when type=ec2 or s3
        type: str
    type: dict

harvesterconfig:
    description: harvester Cloud Credential to create in Rancher
    required: false
    suboptions:
      clusterId:
        description:
        - harvester cluster id
        - Required when type=harvester
        type: str
      clusterType:
        description:
        - harvester cluster type
        - Required when type=harvester
        type: str
      kubeconfigContent:
        description:
        - contents of kubeconfig file for harvester cluster, base64
        - Required when type=harvester
        type: str
    type: dict

digitaloceanconfig:
    description: Digital Ocean Cloud Credential to create in Rancher
    required: false
    suboptions:
      accessToken:
        description:
        - Digital Ocean API access token
        - Required when type=digitalocean
        type: str
    type: dict

Outputs

full_response:
  description: The full API response of the last request
  returned: optional
  type: dict
id:
  description: The ID of the cloud credential
  returned: always
  type: dict
idcol:
  description: The ID of the cloud credential separated by colon
  returned: always
  type: dict
output:
  description: The cloud credential object
  returned: always
  type: dict