theforeman.foreman.katello_repository (0.8.1) — module

Create and manage Katello repository

Authors: Eric D Helms (@ehelms)

preview | supported by community

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==0.8.1


Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 0.8.1

Description

Crate and manage a Katello repository


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Create repository"
  katello_repository:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My repository"
    state: present
    content_type: "yum"
    product: "My Product"
    organization: "Default Organization"
    url: "http://yum.theforeman.org/plugins/latest/el7/x86_64/"
    mirror_on_sync: true
    download_policy: background
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Create repository with content credentials"
  katello_repository:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My repository 2"
    state: present
    content_type: "yum"
    product: "My Product"
    organization: "Default Organization"
    url: "http://yum.theforeman.org/releases/latest/el7/x86_64/"
    download_policy: background
    mirror_on_sync: true
    gpg_key: RPM-GPG-KEY-my-product2

Inputs

    
url:
    description:
    - Repository URL to sync from
    required: false
    type: str

name:
    description:
    - Name of the repository
    required: true
    type: str

label:
    description:
    - label of the repository
    type: str

state:
    choices:
    - present
    - present_with_defaults
    - absent
    default: present
    description:
    - State of the entity in Foreman
    - C(present_with_defaults) will ensure the entity exists, but won't update existing
      ones
    type: str

gpg_key:
    description:
    - Repository GPG key
    required: false
    type: str

product:
    description:
    - Product to which the repository lives in
    required: true
    type: str

password:
    description: Password of the user accessing the Foreman server
    required: true
    type: str

username:
    description: Username accessing the Foreman server
    required: true
    type: str

http_proxy:
    description:
    - Name of the http proxy to use for content synching
    - Should be combined with I(http_proxy_policy='use_selected_http_proxy')
    required: false
    type: str

server_url:
    description: URL of the Foreman server
    required: true
    type: str

ssl_ca_cert:
    description:
    - Repository SSL CA certificate
    required: false
    type: str

content_type:
    choices:
    - deb
    - docker
    - file
    - ostree
    - puppet
    - yum
    description:
    - The content type of the repository (e.g. yum)
    required: true
    type: str

deb_releases:
    description:
    - comma separated list of releases to be synced from deb-archive
    - only available for I(content_type=deb)
    type: str

organization:
    description:
    - Organization that the entity is in
    required: true
    type: str

deb_components:
    description:
    - comma separated list of repo components to be synced from deb-archive
    - only available for I(content_type=deb)
    type: str

deb_errata_url:
    description:
    - URL to sync Debian or Ubuntu errata information from
    - only available on Orcharhino
    - only available for I(content_type=deb)
    required: false
    type: str

mirror_on_sync:
    default: true
    description:
    - toggle "mirror on sync" where the state of the repository mirrors that of the upstream
      repository at sync time
    required: false
    type: bool

ssl_client_key:
    description:
    - Repository SSL client private key
    required: false
    type: str

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description: Whether or not to verify the TLS certificates of the Foreman server
    type: bool

download_policy:
    choices:
    - background
    - immediate
    - on_demand
    description:
    - download policy for sync from upstream
    required: false
    type: str

ssl_client_cert:
    description:
    - Repository SSL client certificate
    required: false
    type: str

deb_architectures:
    description:
    - comma separated list of architectures to be synced from deb-archive
    - only available for I(content_type=deb)
    type: str

http_proxy_policy:
    choices:
    - global_default_http_proxy
    - none
    - use_selected_http_proxy
    description:
    - Which proxy to use for content synching
    required: false
    type: str

upstream_password:
    description:
    - password to access upstream repository
    type: str

upstream_username:
    description:
    - username to access upstream repository
    type: str

ignore_global_proxy:
    description:
    - Whether content sync should use or ignore the global http proxy setting
    - This is deprecated with Katello 3.13
    - It has been superseeded by I(http_proxy_policy)
    required: false
    type: bool

docker_upstream_name:
    description:
    - name of the upstream docker repository
    - only available for I(content_type=docker)
    type: str

docker_tags_whitelist:
    description:
    - list of tags to sync for Container Image repository
    - only available for I(content_type=docker)
    elements: str
    type: list