mirror of
https://github.com/ansible-collections/hetzner.hcloud.git
synced 2026-02-04 16:11:49 +00:00
263 lines
8.2 KiB
Python
263 lines
8.2 KiB
Python
#!/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)
|
|
|
|
|
|
from __future__ import annotations
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: load_balancer_network
|
|
|
|
short_description: Manage the relationship between Hetzner Cloud Networks and Load Balancers
|
|
|
|
|
|
description:
|
|
- Create and delete the relationship Hetzner Cloud Networks and Load Balancers
|
|
|
|
author:
|
|
- Lukas Kaemmerling (@lkaemmerling)
|
|
version_added: 0.1.0
|
|
options:
|
|
network:
|
|
description:
|
|
- Name or ID of the Hetzner Cloud Networks.
|
|
type: str
|
|
required: true
|
|
load_balancer:
|
|
description:
|
|
- Name or ID of the Hetzner Cloud Load Balancer.
|
|
type: str
|
|
required: true
|
|
ip_range:
|
|
description:
|
|
- IP range in CIDR block notation of the subnet to attach to.
|
|
type: str
|
|
ip:
|
|
description:
|
|
- The IP the Load Balancer should have.
|
|
type: str
|
|
state:
|
|
description:
|
|
- State of the load_balancer_network.
|
|
default: present
|
|
choices: [ absent, present ]
|
|
type: str
|
|
|
|
extends_documentation_fragment:
|
|
- hetzner.hcloud.hcloud
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
- name: Create a basic Load Balancer network
|
|
hetzner.hcloud.load_balancer_network:
|
|
load_balancer: my-LoadBalancer
|
|
network: my-network
|
|
state: present
|
|
|
|
- name: Create a Load Balancer network and specify the subnet
|
|
hetzner.hcloud.load_balancer_network:
|
|
load_balancer: my-LoadBalancer
|
|
network: my-network
|
|
ip_range: 10.1.0.0/24
|
|
state: present
|
|
|
|
- name: Create a Load Balancer network and specify the ip address
|
|
hetzner.hcloud.load_balancer_network:
|
|
load_balancer: my-LoadBalancer
|
|
network: my-network
|
|
ip: 10.0.0.1
|
|
state: present
|
|
|
|
- name: Ensure the Load Balancer network is absent (remove if needed)
|
|
hetzner.hcloud.load_balancer_network:
|
|
load_balancer: my-LoadBalancer
|
|
network: my-network
|
|
state: absent
|
|
"""
|
|
|
|
RETURN = """
|
|
hcloud_load_balancer_network:
|
|
description: The relationship between a Load Balancer and a network
|
|
returned: always
|
|
type: complex
|
|
contains:
|
|
network:
|
|
description: Name of the Network
|
|
type: str
|
|
returned: always
|
|
sample: my-network
|
|
load_balancer:
|
|
description: Name of the Load Balancer
|
|
type: str
|
|
returned: always
|
|
sample: my-LoadBalancer
|
|
ip:
|
|
description: IP of the Load Balancer within the Network ip range
|
|
type: str
|
|
returned: always
|
|
sample: 10.0.0.8
|
|
"""
|
|
|
|
from ipaddress import ip_address, ip_network
|
|
from time import sleep
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
from ..module_utils.hcloud import AnsibleHCloud
|
|
from ..module_utils.vendor.hcloud import HCloudException
|
|
from ..module_utils.vendor.hcloud.load_balancers import BoundLoadBalancer, PrivateNet
|
|
from ..module_utils.vendor.hcloud.networks import BoundNetwork
|
|
|
|
|
|
class AnsibleHCloudLoadBalancerNetwork(AnsibleHCloud):
|
|
represent = "hcloud_load_balancer_network"
|
|
|
|
hcloud_network: BoundNetwork | None = None
|
|
hcloud_load_balancer: BoundLoadBalancer | None = None
|
|
hcloud_load_balancer_network: PrivateNet | None = None
|
|
|
|
def _prepare_result(self):
|
|
return {
|
|
"network": self.hcloud_network.name,
|
|
"load_balancer": self.hcloud_load_balancer.name,
|
|
"ip": self.hcloud_load_balancer_network.ip,
|
|
}
|
|
|
|
def _get_load_balancer_and_network(self):
|
|
try:
|
|
self.hcloud_load_balancer_network = None
|
|
|
|
self.hcloud_network = self._client_get_by_name_or_id(
|
|
"networks",
|
|
self.module.params.get("network"),
|
|
)
|
|
self.hcloud_load_balancer = self._client_get_by_name_or_id(
|
|
"load_balancers",
|
|
self.module.params.get("load_balancer"),
|
|
)
|
|
self.hcloud_load_balancer_network = self.hcloud_load_balancer.private_net_for(self.hcloud_network)
|
|
except HCloudException as exception:
|
|
self.fail_json_hcloud(exception)
|
|
|
|
def _attach(self):
|
|
params = {
|
|
"network": self.hcloud_network,
|
|
}
|
|
|
|
if self.module.params.get("ip_range") is not None:
|
|
params["ip_range"] = self.module.params.get("ip_range")
|
|
if self.module.params.get("ip") is not None:
|
|
params["ip"] = self.module.params.get("ip")
|
|
|
|
if not self.module.check_mode:
|
|
try:
|
|
action = self.hcloud_load_balancer.attach_to_network(**params)
|
|
action.wait_until_finished()
|
|
|
|
# Workaround to handle flakiness from the API
|
|
self._wait_for_attachment(True)
|
|
except HCloudException as exception:
|
|
self.fail_json_hcloud(exception)
|
|
|
|
self._mark_as_changed()
|
|
|
|
def _detach(self):
|
|
if not self.module.check_mode:
|
|
try:
|
|
action = self.hcloud_load_balancer.detach_from_network(self.hcloud_load_balancer_network.network)
|
|
action.wait_until_finished()
|
|
|
|
# Workaround to handle flakiness from the API
|
|
self._wait_for_attachment(False)
|
|
except HCloudException as exception:
|
|
self.fail_json_hcloud(exception)
|
|
|
|
self._mark_as_changed()
|
|
|
|
def _create_load_balancer_network(self):
|
|
self._attach()
|
|
|
|
self._get_load_balancer_and_network()
|
|
|
|
def _update_load_balancer_network(self):
|
|
ip_range = self.module.params.get("ip_range")
|
|
if ip_range is not None:
|
|
ip_range_network = ip_network(ip_range)
|
|
if ip_range_network not in [ip_network(o.ip_range) for o in self.hcloud_network.subnets]:
|
|
# Validate before "detach" instead of relying on the "attach" API
|
|
# validation, leaving the resource in a half applied state.
|
|
self.module.fail_json(msg=f"ip_range '{ip_range}' was not found in the network subnets")
|
|
|
|
if ip_address(self.hcloud_load_balancer_network.ip) not in ip_range_network:
|
|
self._detach()
|
|
self._attach()
|
|
|
|
# No further updates needed, exit
|
|
self._get_load_balancer_and_network()
|
|
return
|
|
|
|
def present_load_balancer_network(self):
|
|
self._get_load_balancer_and_network()
|
|
if self.hcloud_load_balancer_network is None:
|
|
self._create_load_balancer_network()
|
|
else:
|
|
self._update_load_balancer_network()
|
|
|
|
def delete_load_balancer_network(self):
|
|
self._get_load_balancer_and_network()
|
|
if self.hcloud_load_balancer_network is not None and self.hcloud_load_balancer is not None:
|
|
self._detach()
|
|
self.hcloud_load_balancer_network = None
|
|
|
|
# Workaround to handle flakiness from the API
|
|
def _wait_for_attachment(self, present: bool):
|
|
def done(x: PrivateNet | None):
|
|
if present:
|
|
return x is not None
|
|
return x is None
|
|
|
|
# pylint: disable=disallowed-name
|
|
for _ in range(10):
|
|
self.hcloud_load_balancer.reload()
|
|
self.hcloud_load_balancer_network = self.hcloud_load_balancer.private_net_for(self.hcloud_network)
|
|
|
|
if done(self.hcloud_load_balancer_network):
|
|
break
|
|
|
|
sleep(2)
|
|
|
|
@classmethod
|
|
def define_module(cls):
|
|
return AnsibleModule(
|
|
argument_spec=dict(
|
|
load_balancer={"type": "str", "required": True},
|
|
network={"type": "str", "required": True},
|
|
ip_range={"type": "str"},
|
|
ip={"type": "str"},
|
|
state={
|
|
"choices": ["absent", "present"],
|
|
"default": "present",
|
|
},
|
|
**super().base_module_arguments(),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
|
|
def main():
|
|
module = AnsibleHCloudLoadBalancerNetwork.define_module()
|
|
|
|
hcloud = AnsibleHCloudLoadBalancerNetwork(module)
|
|
state = module.params["state"]
|
|
if state == "absent":
|
|
hcloud.delete_load_balancer_network()
|
|
elif state == "present":
|
|
hcloud.present_load_balancer_network()
|
|
|
|
module.exit_json(**hcloud.get_result())
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|