community.general.scaleway_container_registry module – Scaleway Container registry management module

Note

This module is part of the community.general collection (version 10.0.1).

You might already have this collection installed if you are using the ansible package. 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 community.general.

To use it in a playbook, specify: community.general.scaleway_container_registry.

New in community.general 5.8.0

Synopsis

  • This module manages container registries on Scaleway account.

Parameters

Parameter

Comments

api_timeout

aliases: timeout

integer

HTTP timeout to Scaleway API in seconds.

Default: 30

api_token

aliases: oauth_token

string / required

Scaleway OAuth token.

api_url

aliases: base_url

string

Scaleway API URL.

Default: "https://api.scaleway.com"

description

string

Description of the container registry.

Default: ""

name

string / required

Name of the container registry.

privacy_policy

string

Default visibility policy.

Everyone will be able to pull images from a public registry.

Choices:

  • "public"

  • "private" ← (default)

project_id

string / required

Project identifier.

query_parameters

dictionary

List of parameters passed to the query string.

Default: {}

region

string / required

Scaleway region to use (for example fr-par).

Choices:

  • "fr-par"

  • "nl-ams"

  • "pl-waw"

state

string

Indicate desired state of the container registry.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

Validate SSL certs of the Scaleway API.

Choices:

  • false

  • true ← (default)

wait

boolean

Wait for the resource to reach its desired state before returning.

Choices:

  • false

  • true ← (default)

wait_sleep_time

integer

Time to wait before every attempt to check the state of the resource.

Default: 3

wait_timeout

integer

Time to wait for the resource to reach the expected state.

Default: 300

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

Examples

- name: Create a container registry
  community.general.scaleway_container_registry:
    project_id: '{{ scw_project }}'
    state: present
    region: fr-par
    name: my-awesome-container-registry
  register: container_registry_creation_task

- name: Make sure container registry is deleted
  community.general.scaleway_container_registry:
    project_id: '{{ scw_project }}'
    state: absent
    region: fr-par
    name: my-awesome-container-registry

Return Values

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

Key

Description

container_registry

dictionary

The container registry information.

Returned: when state=present

Sample: {"created_at": "2022-10-14T09:51:07.949716Z", "description": "Managed by Ansible", "endpoint": "rg.fr-par.scw.cloud/my-awesome-registry", "id": "0d7d5270-7864-49c2-920b-9fd6731f3589", "image_count": 0, "is_public": false, "name": "my-awesome-registry", "organization_id": "10697b59-5c34-4d24-8d15-9ff2d3b89f58", "project_id": "3da4f0b2-06be-4773-8ec4-5dfa435381be", "region": "fr-par", "size": 0, "status": "ready", "status_message": "", "updated_at": "2022-10-14T09:51:07.949716Z"}

Authors

  • Guillaume MARTINEZ (@Lunik)