gce_lb - create/destroy GCE load-balancer resources

Author:Eric Johnson <erjohnso@google.com>

Synopsis

New in version 1.5.

This module can create and destroy Google Compute Engine loadbalancer and httphealthcheck resources. The primary LB resource is the load_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.

Options

parameter required default choices comments
external_ip no
    the external static IPv4 (or auto-assigned) address for the LB
    httphealthcheck_healthy_count no 2
      number of consecutive successful checks before marking a node healthy
      httphealthcheck_host no
        host header to pass through on HTTP check requests
        httphealthcheck_interval no 5
          the duration in seconds between each health check request
          httphealthcheck_name no
            the name identifier for the HTTP health check
            httphealthcheck_path no /
              the url path to use for HTTP health checking
              httphealthcheck_port no 80
                the TCP port to use for HTTP health checking
                httphealthcheck_timeout no 5
                  the timeout in seconds before a request is considered a failed check
                  httphealthcheck_unhealthy_count no 2
                    number of consecutive failed checks before marking a node unhealthy
                    members no
                      a list of zone/nodename pairs, e.g ['us-central1-a/www-a', ...]
                      name no
                        name of the load-balancer resource
                        port_range no
                          the port (range) to forward, e.g. 80 or 8000-8888 defaults to all ports
                          protocol no tcp
                          • tcp
                          • udp
                          the protocol used for the load-balancer packet forwarding, tcp or udp
                          region no
                          • us-central1
                          • us-central2
                          • europe-west1
                          the GCE region where the load-balancer is defined
                          state no present
                          • active
                          • present
                          • absent
                          • deleted
                          desired state of the LB

                          Note

                          Requires libcloud

                          Examples


                          # 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"
                          

                          Table Of Contents

                          Previous topic

                          gce - create or terminate GCE instances

                          Next topic

                          gce_net - create/destroy GCE networks and firewall rules