2021-08-16 10:31:02 +00:00
|
|
|
#!/usr/bin/python
|
|
|
|
|
|
|
|
# Copyright: (c) 2020, Hetzner Cloud GmbH <info@hetzner-cloud.de>
|
|
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
|
|
|
|
|
|
DOCUMENTATION = """
|
|
|
|
---
|
|
|
|
module: hcloud_placement_group
|
|
|
|
|
|
|
|
short_description: Create and manage placement groups on the Hetzner Cloud.
|
|
|
|
|
|
|
|
|
|
|
|
description:
|
|
|
|
- Create, update and manage placement groups on the Hetzner Cloud.
|
|
|
|
|
|
|
|
author:
|
|
|
|
- Adrian Huber (@Adi146)
|
|
|
|
|
|
|
|
options:
|
|
|
|
id:
|
|
|
|
description:
|
|
|
|
- The ID of the Hetzner Cloud placement group to manage.
|
|
|
|
- Only required if no placement group I(name) is given
|
|
|
|
type: int
|
|
|
|
name:
|
|
|
|
description:
|
|
|
|
- The Name of the Hetzner Cloud placement group to manage.
|
2022-04-25 04:28:21 +00:00
|
|
|
- Only required if no placement group I(id) is given, or a placement group does not exist.
|
2021-08-16 10:31:02 +00:00
|
|
|
type: str
|
|
|
|
labels:
|
|
|
|
description:
|
|
|
|
- User-defined labels (key-value pairs)
|
|
|
|
type: dict
|
|
|
|
type:
|
|
|
|
description:
|
|
|
|
- The Type of the Hetzner Cloud placement group.
|
|
|
|
type: str
|
|
|
|
state:
|
|
|
|
description:
|
|
|
|
- State of the placement group.
|
|
|
|
default: present
|
|
|
|
choices: [ absent, present ]
|
|
|
|
type: str
|
|
|
|
|
|
|
|
requirements:
|
|
|
|
- hcloud-python >= 1.15.0
|
|
|
|
|
|
|
|
extends_documentation_fragment:
|
|
|
|
- hetzner.hcloud.hcloud
|
|
|
|
"""
|
|
|
|
|
|
|
|
EXAMPLES = """
|
|
|
|
- name: Create a basic placement group
|
|
|
|
hcloud_placement_group:
|
|
|
|
name: my-placement-group
|
|
|
|
state: present
|
|
|
|
type: spread
|
|
|
|
|
|
|
|
- name: Create a placement group with labels
|
|
|
|
hcloud_placement_group:
|
|
|
|
name: my-placement-group
|
|
|
|
type: spread
|
|
|
|
labels:
|
|
|
|
key: value
|
|
|
|
mylabel: 123
|
|
|
|
state: present
|
|
|
|
|
|
|
|
- name: Ensure the placement group is absent (remove if needed)
|
|
|
|
hcloud_placement_group:
|
|
|
|
name: my-placement-group
|
|
|
|
state: absent
|
|
|
|
"""
|
|
|
|
|
|
|
|
RETURN = """
|
|
|
|
hcloud_placement_group:
|
|
|
|
description: The placement group instance
|
|
|
|
returned: Always
|
|
|
|
type: complex
|
|
|
|
contains:
|
|
|
|
id:
|
|
|
|
description: Numeric identifier of the placement group
|
|
|
|
returned: always
|
|
|
|
type: int
|
|
|
|
sample: 1937415
|
|
|
|
name:
|
|
|
|
description: Name of the placement group
|
|
|
|
returned: always
|
|
|
|
type: str
|
|
|
|
sample: my placement group
|
|
|
|
labels:
|
|
|
|
description: User-defined labels (key-value pairs)
|
|
|
|
returned: always
|
|
|
|
type: dict
|
|
|
|
type:
|
|
|
|
description: Type of the placement group
|
|
|
|
returned: always
|
|
|
|
type: str
|
|
|
|
sample: spread
|
|
|
|
servers:
|
|
|
|
description: Server IDs of the placement group
|
|
|
|
returned: always
|
|
|
|
type: list
|
|
|
|
elements: int
|
|
|
|
sample:
|
|
|
|
- 4711
|
|
|
|
- 4712
|
|
|
|
"""
|
|
|
|
|
2023-06-27 09:50:13 +00:00
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
2023-06-27 11:17:21 +00:00
|
|
|
from ansible.module_utils.common.text.converters import to_native
|
2023-06-27 09:50:13 +00:00
|
|
|
from ansible_collections.hetzner.hcloud.plugins.module_utils.hcloud import Hcloud
|
2021-08-16 10:31:02 +00:00
|
|
|
|
|
|
|
|
|
|
|
class AnsibleHcloudPlacementGroup(Hcloud):
|
|
|
|
def __init__(self, module):
|
|
|
|
Hcloud.__init__(self, module, "hcloud_placement_group")
|
|
|
|
self.hcloud_placement_group = None
|
|
|
|
|
|
|
|
def _prepare_result(self):
|
|
|
|
return {
|
|
|
|
"id": to_native(self.hcloud_placement_group.id),
|
|
|
|
"name": to_native(self.hcloud_placement_group.name),
|
|
|
|
"labels": self.hcloud_placement_group.labels,
|
|
|
|
"type": to_native(self.hcloud_placement_group.type),
|
|
|
|
"servers": self.hcloud_placement_group.servers,
|
|
|
|
}
|
|
|
|
|
|
|
|
def _get_placement_group(self):
|
|
|
|
try:
|
|
|
|
if self.module.params.get("id") is not None:
|
2023-06-27 09:50:13 +00:00
|
|
|
self.hcloud_placement_group = self.client.placement_groups.get_by_id(self.module.params.get("id"))
|
2021-08-16 10:31:02 +00:00
|
|
|
elif self.module.params.get("name") is not None:
|
2023-06-27 09:50:13 +00:00
|
|
|
self.hcloud_placement_group = self.client.placement_groups.get_by_name(self.module.params.get("name"))
|
2021-08-16 10:31:02 +00:00
|
|
|
except Exception as e:
|
|
|
|
self.module.fail_json(msg=e.message)
|
|
|
|
|
|
|
|
def _create_placement_group(self):
|
2023-06-27 09:50:13 +00:00
|
|
|
self.module.fail_on_missing_params(required_params=["name"])
|
2021-08-16 10:31:02 +00:00
|
|
|
params = {
|
|
|
|
"name": self.module.params.get("name"),
|
|
|
|
"type": self.module.params.get("type"),
|
|
|
|
"labels": self.module.params.get("labels"),
|
|
|
|
}
|
|
|
|
if not self.module.check_mode:
|
|
|
|
try:
|
|
|
|
self.client.placement_groups.create(**params)
|
|
|
|
except Exception as e:
|
|
|
|
self.module.fail_json(msg=e.message, **params)
|
|
|
|
self._mark_as_changed()
|
|
|
|
self._get_placement_group()
|
|
|
|
|
|
|
|
def _update_placement_group(self):
|
|
|
|
name = self.module.params.get("name")
|
|
|
|
if name is not None and self.hcloud_placement_group.name != name:
|
2023-06-27 09:50:13 +00:00
|
|
|
self.module.fail_on_missing_params(required_params=["id"])
|
2021-08-16 10:31:02 +00:00
|
|
|
if not self.module.check_mode:
|
|
|
|
self.hcloud_placement_group.update(name=name)
|
|
|
|
self._mark_as_changed()
|
|
|
|
|
|
|
|
labels = self.module.params.get("labels")
|
|
|
|
if labels is not None and self.hcloud_placement_group.labels != labels:
|
|
|
|
if not self.module.check_mode:
|
|
|
|
self.hcloud_placement_group.update(labels=labels)
|
|
|
|
self._mark_as_changed()
|
|
|
|
|
|
|
|
self._get_placement_group()
|
|
|
|
|
|
|
|
def present_placement_group(self):
|
|
|
|
self._get_placement_group()
|
|
|
|
if self.hcloud_placement_group is None:
|
|
|
|
self._create_placement_group()
|
|
|
|
else:
|
|
|
|
self._update_placement_group()
|
|
|
|
|
|
|
|
def delete_placement_group(self):
|
|
|
|
self._get_placement_group()
|
|
|
|
if self.hcloud_placement_group is not None:
|
|
|
|
if not self.module.check_mode:
|
|
|
|
self.client.placement_groups.delete(self.hcloud_placement_group)
|
|
|
|
self._mark_as_changed()
|
|
|
|
self.hcloud_placement_group = None
|
|
|
|
|
|
|
|
@staticmethod
|
|
|
|
def define_module():
|
|
|
|
return AnsibleModule(
|
|
|
|
argument_spec=dict(
|
|
|
|
id={"type": "int"},
|
|
|
|
name={"type": "str"},
|
|
|
|
labels={"type": "dict"},
|
|
|
|
type={"type": "str"},
|
|
|
|
state={
|
|
|
|
"choices": ["absent", "present"],
|
|
|
|
"default": "present",
|
|
|
|
},
|
|
|
|
**Hcloud.base_module_arguments()
|
|
|
|
),
|
2023-06-27 09:50:13 +00:00
|
|
|
required_one_of=[["id", "name"]],
|
|
|
|
required_if=[["state", "present", ["name"]]],
|
2021-08-16 10:31:02 +00:00
|
|
|
supports_check_mode=True,
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
def main():
|
|
|
|
module = AnsibleHcloudPlacementGroup.define_module()
|
|
|
|
|
|
|
|
hcloud = AnsibleHcloudPlacementGroup(module)
|
|
|
|
state = module.params.get("state")
|
|
|
|
if state == "absent":
|
|
|
|
hcloud.delete_placement_group()
|
|
|
|
elif state == "present":
|
|
|
|
hcloud.present_placement_group()
|
|
|
|
|
|
|
|
module.exit_json(**hcloud.get_result())
|
|
|
|
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
main()
|