mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-26 05:50:36 -07:00
1ccfc3b821s[a-c]*: normalize docs (#9353)
* s[a-c]*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 70b62ed745)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
140 lines
4 KiB
Python
140 lines
4 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Scaleway Serverless container registry info module
|
|
#
|
|
# Copyright (c) 2022, Guillaume MARTINEZ <lunik@tiwabbit.fr>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = r"""
|
|
module: scaleway_container_registry_info
|
|
short_description: Scaleway Container registry info module
|
|
version_added: 5.8.0
|
|
author: Guillaume MARTINEZ (@Lunik)
|
|
description:
|
|
- This module return information about a container registry on Scaleway account.
|
|
extends_documentation_fragment:
|
|
- community.general.scaleway
|
|
- community.general.attributes
|
|
- community.general.attributes.info_module
|
|
|
|
options:
|
|
project_id:
|
|
type: str
|
|
description:
|
|
- Project identifier.
|
|
required: true
|
|
|
|
region:
|
|
type: str
|
|
description:
|
|
- Scaleway region to use (for example C(fr-par)).
|
|
required: true
|
|
choices:
|
|
- fr-par
|
|
- nl-ams
|
|
- pl-waw
|
|
|
|
name:
|
|
type: str
|
|
description:
|
|
- Name of the container registry.
|
|
required: true
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: Get a container registry info
|
|
community.general.scaleway_container_registry_info:
|
|
project_id: '{{ scw_project }}'
|
|
region: fr-par
|
|
name: my-awesome-container-registry
|
|
register: container_registry_info_task
|
|
"""
|
|
|
|
RETURN = r"""
|
|
container_registry:
|
|
description: The container registry information.
|
|
returned: always
|
|
type: dict
|
|
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"
|
|
"""
|
|
|
|
from ansible_collections.community.general.plugins.module_utils.scaleway import (
|
|
SCALEWAY_REGIONS, scaleway_argument_spec, Scaleway,
|
|
)
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
def info_strategy(api, wished_cn):
|
|
cn_list = api.fetch_all_resources("namespaces")
|
|
cn_lookup = {cn["name"]: cn for cn in cn_list}
|
|
|
|
if wished_cn["name"] not in cn_lookup:
|
|
msg = "Error during container registries lookup: Unable to find container registry named '%s' in project '%s'" % (wished_cn["name"],
|
|
wished_cn["project_id"])
|
|
|
|
api.module.fail_json(msg=msg)
|
|
|
|
target_cn = cn_lookup[wished_cn["name"]]
|
|
|
|
response = api.get(path=api.api_path + "/%s" % target_cn["id"])
|
|
if not response.ok:
|
|
msg = "Error during container registry lookup: %s: '%s' (%s)" % (response.info['msg'],
|
|
response.json['message'],
|
|
response.json)
|
|
api.module.fail_json(msg=msg)
|
|
|
|
return response.json
|
|
|
|
|
|
def core(module):
|
|
region = module.params["region"]
|
|
wished_container_namespace = {
|
|
"project_id": module.params["project_id"],
|
|
"name": module.params["name"]
|
|
}
|
|
|
|
api = Scaleway(module=module)
|
|
api.api_path = "registry/v1/regions/%s/namespaces" % region
|
|
|
|
summary = info_strategy(api=api, wished_cn=wished_container_namespace)
|
|
|
|
module.exit_json(changed=False, container_registry=summary)
|
|
|
|
|
|
def main():
|
|
argument_spec = scaleway_argument_spec()
|
|
argument_spec.update(dict(
|
|
project_id=dict(type='str', required=True),
|
|
region=dict(type='str', required=True, choices=SCALEWAY_REGIONS),
|
|
name=dict(type='str', required=True)
|
|
))
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec,
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
core(module)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|