intellium.rancher.rancher_cluster_repo (0.0.7) — module

Manage Rancher Cluster Repositories

| "added in version" 0.0.1 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 repo
  intellium.rancher.rancher_cluster_repo:
    state: present
    host: rancher.example.com
    token: "{{ login['token'] }}"
    cluster_name: downstream_cluster
    repo_name: "test-repo"
    repo_url: "https://test-repo.example.com"
    full_response: true
    validate_certs: false

Inputs

    
host:
    aliases:
    - rancher_host
    description: Hostname of rancher system
    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

git_url:
    description: URL of the git type repository
    required: false
    type: str

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

repo_url:
    description: URL of the http type repository
    required: false
    type: str

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

repo_name:
    description: Name of repository to operate on
    required: true
    type: str

git_branch:
    default: master
    description: Git branch
    type: str

git_secret:
    description:
    - Secret name to access repository
    - can be an ssh keypair or user/password secret
    required: false
    type: str

cluster_name:
    aliases:
    - rancher_cluster
    description: Name of the cluster in rancher to operate on
    required: true
    type: str

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

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

git_secret_namespace:
    default: cattle-system
    description: Namespace containing the secret
    type: str

Outputs

full_response:
  description: The full API response of the last request
  returned: optional
  type: dict
id:
  description: The ID of the cluster
  returned: always
  type: dict
output:
  description: The complete json object
  returned: always
  type: dict