gcp_compute_target_tcp_proxy – Creates a GCP TargetTcpProxy
New in version 2.6.
Synopsis
- Represents a TargetTcpProxy resource, which is used by one or more global forwarding rule to route incoming TCP requests to a Backend service.
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
|
|
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.
|
proxy_header
-
|
|
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
|
scopes
-
|
Array of scopes to be used.
|
|
service
- /
required
|
A reference to the BackendService resource.
|
|
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
-
|
|
Whether the given object should exist in GCP
|
Notes
Note
- API Reference: https://cloud.google.com/compute/docs/reference/latest/targetTcpProxies
- Setting Up TCP proxy for Google Cloud Load Balancing: https://cloud.google.com/compute/docs/load-balancing/tcp-ssl/tcp-proxy
- 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-targettcpproxy" 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 health check gcp_compute_health_check: name: "healthcheck-targettcpproxy" type: TCP tcp_health_check: port_name: service-health request: ping response: pong healthy_threshold: 10 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-targettcpproxy" backends: - group: "{{ instancegroup }}" health_checks: - "{{ healthcheck.selfLink }}" protocol: TCP project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: backendservice - name: create a target tcp proxy gcp_compute_target_tcp_proxy: name: "test_object" proxy_header: PROXY_V1 service: "{{ backendservice }}" 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.
|
proxy_header
string
|
success |
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
|
service
dictionary
|
success |
A reference to the BackendService resource.
|
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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/gcp_compute_target_tcp_proxy_module.html