opentelekomcloud.cloud.swr_repository_info module – Get SWR repositories info

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.2).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install opentelekomcloud.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: opentelekomcloud.cloud.swr_repository_info.

New in opentelekomcloud.cloud 0.14.2

Synopsis

  • Get repositories info from Software Repository for Containers

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk

  • openstacksdk >= 0.36.0

  • otcextensions

  • python >= 3.6

Parameters

Parameter

Comments

api_timeout

integer

How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.

auth

dictionary

Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.

auth_type

string

Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

category

string

Repository type.

Choices:

  • "app_server"

  • "linux"

  • "framework_app"

  • "database"

  • "lang"

  • "other"

  • "windows"

  • "arm"

center

string

Use only if you need self-owned images

Choices:

  • "self"

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

any

Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

limit

string

number of returned records. Can be used only with offset

namespace

string

Optional name of an organisation

offset

string

start index. Can be used only with limit

order_column

string

Sorting criteria. Can be used only with order_type

Choices:

  • "name"

  • "updated_time"

  • "tag_count"

order_type

string

Sorting type. Can be used only with order_column

Choices:

  • "desc"

  • "asc"

region_name

string

Name of the region.

repository

string

Optional name of a repository

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "ERROR"

  • "WARN" ← (default)

  • "INFO"

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Get SWR repositories information
- opentelekomcloud.cloud.swr_repository_info:
    namespace: org_name
    name: repo_name
  register: swr_repository_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

repositories

complex

Dictionary describing repositories

Returned: On Success.

category

string

Image repository type

Returned: success

Sample: "app_server"

created

string

Time when an image repository is created

Returned: success

Sample: "2024-02-19T10:20:36.285975Z"

creator_id

string

Image repository creator ID

Returned: success

Sample: "8b17f8573e8c4a7a8a04e0fe8e60dfa3"

creator_name

string

Image repository creator

Returned: success

Sample: "username"

description

string

Brief description of the image repository

Returned: success

Sample: "this is example test repository"

domain_id

string

Account ID

Returned: success

Sample: "859d69666ff44ba6a20855edb43f311e"

id

integer

Repository ID

Returned: success

Sample: 1343008

internal_path

string

Internal image pull address

Returned: success

Sample: "100.125.7.20:20202/org_name/swr_repo"

is_public

boolean

Repository is public or not

Returned: success

Sample: true

name

string

Image repository name

Returned: success

Sample: "repo_name"

ns_id

integer

Organization ID

Returned: success

Sample: 1343

num_download

integer

Download times of an image repository.

Returned: success

Sample: 0

num_images

integer

Number of images in repository

Returned: success

Sample: 1

path

string

External image pull address

Returned: success

Sample: "swr.eu-de.otc.t-systems.com/org_name/swr_repo"

priority

integer

Image sorting priority.

Returned: success

Sample: 0

size

integer

Image repository size

Returned: success

Sample: 0

status

boolean

(Reserved field) Status.

Returned: success

Sample: false

tags

list / elements=string

Image tag list.

Returned: success

Sample: []

total_range

integer

Total number of records.

Returned: success

Sample: 1

updated

string

Time when an image repository is updated

Returned: success

Sample: "2024-02-19T10:20:36.285976Z"

url

string

URL of the image repository logo image. Empty by default

Returned: success

Sample: ""

Authors

  • Ziukina Valeriia (@RusselSand)

last updated: 2024-04-26 16:19