community.google.gce_lb module – create/destroy GCE load-balancer resources
Note
This module is part of the community.google collection (version 1.0.0).
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.google
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.google.gce_lb
.
Synopsis
This module can create and destroy Google Compute Engine
loadbalancer
andhttphealthcheck
resources. The primary LB resource is theload_balancer
resource and the health check parameters are all prefixed with httphealthcheck. The full documentation for Google Compute Engine load balancing is at https://developers.google.com/compute/docs/load-balancing/. However, the ansible module simplifies the configuration by following the libcloud model. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
apache-libcloud >= 0.13.3, >= 0.17.0 if using JSON credentials
Parameters
Parameter |
Comments |
---|---|
path to the JSON file associated with the service account email |
|
the external static IPv4 (or auto-assigned) address for the LB |
|
number of consecutive successful checks before marking a node healthy Default: |
|
host header to pass through on HTTP check requests |
|
the duration in seconds between each health check request Default: |
|
the name identifier for the HTTP health check |
|
the url path to use for HTTP health checking Default: |
|
the TCP port to use for HTTP health checking Default: |
|
the timeout in seconds before a request is considered a failed check Default: |
|
number of consecutive failed checks before marking a node unhealthy Default: |
|
a list of zone/nodename pairs, e.g [‘us-central1-a/www-a’, …] |
|
name of the load-balancer resource |
|
path to the pem file associated with the service account email This option is deprecated. Use ‘credentials_file’. |
|
the port (range) to forward, e.g. 80 or 8000-8888 defaults to all ports |
|
your GCE project ID |
|
the protocol used for the load-balancer packet forwarding, tcp or udp the available choices are: Default: |
|
the GCE region where the load-balancer is defined |
|
service account email |
|
desired state of the LB the available choices are: Default: |
Examples
- name: Simple example of creating a new LB, adding members, and a health check
local_action:
module: gce_lb
name: testlb
region: us-central1
members: ["us-central1-a/www-a", "us-central1-b/www-b"]
httphealthcheck_name: hc
httphealthcheck_port: 80
httphealthcheck_path: "/up"