gcp_compute_target_http_proxy – Creates a GCP TargetHttpProxy

New in version 2.6.

Synopsis

• Represents a TargetHttpProxy resource, which is used by one or more global forwarding rule to route incoming HTTP requests to a URL map.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.6
• requests >= 2.18.4
• google-auth >= 1.3.0

Parameters

Parameter	Choices/Defaults	Comments
auth_kind - / required	Choices: machineaccount serviceaccount application	The type of credential used.
description -		An optional description of this resource.
name - / required		Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
project -	Default: null	The Google Cloud Platform project to use.
scopes -		Array of scopes to be used.
service_account_email -		An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file -		The path of a Service Account JSON file if serviceaccount is selected as type.
state -	Choices: present ← absent	Whether the given object should exist in GCP
url_map - / required		A reference to the UrlMap resource that defines the mapping from URL to the BackendService.

Notes

Note

• API Reference: https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies
• Official Documentation: https://cloud.google.com/compute/docs/load-balancing/http/target-proxies
• For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
• For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
• For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
• For authentication, you can set scopes using the GCP_SCOPES env variable.
• Environment variables values will only be used if the playbook values are not set.
• The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: create a instance group
  gcp_compute_instance_group:
      name: "instancegroup-targethttpproxy"
      zone: us-central1-a
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: instancegroup

- name: create a http health check
  gcp_compute_http_health_check:
      name: "httphealthcheck-targethttpproxy"
      healthy_threshold: 10
      port: 8080
      timeout_sec: 2
      unhealthy_threshold: 5
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: healthcheck

- name: create a backend service
  gcp_compute_backend_service:
      name: "backendservice-targethttpproxy"
      backends:
      - group: "{{ instancegroup }}"
      health_checks:
      - "{{ healthcheck.selfLink }}"
      enable_cdn: true
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: backendservice

- name: create a url map
  gcp_compute_url_map:
      name: "urlmap-targethttpproxy"
      default_service: "{{ backendservice }}"
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: urlmap

- name: create a target http proxy
  gcp_compute_target_http_proxy:
      name: "test_object"
      url_map: "{{ urlmap }}"
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
creation_timestamp string	success	Creation timestamp in RFC3339 text format.
description string	success	An optional description of this resource.
id integer	success	The unique identifier for the resource.
name string	success	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
url_map dictionary	success	A reference to the UrlMap resource that defines the mapping from URL to the BackendService.

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.