Added environment variables to gcp_compute to align with gcp_* modules (#57776)

Added all variables that are also used by the gcp_* modules as described
in the docs
https://docs.ansible.com/ansible/latest/scenario_guides/guide_gce.html#providing-credentials-as-environment-variables
This commit is contained in:
Strahinja Kustudic 2019-06-12 23:36:57 +02:00 committed by Alex Stephen
parent ae9dd53c92
commit 64fb6d5ce0

View file

@ -48,21 +48,32 @@ DOCUMENTATION = '''
- The type of credential used. - The type of credential used.
required: True required: True
choices: ['application', 'serviceaccount', 'machineaccount'] choices: ['application', 'serviceaccount', 'machineaccount']
env:
- name: GCP_AUTH_KIND
version_added: "2.8"
scopes: scopes:
description: list of authentication scopes description: list of authentication scopes
type: list type: list
default: ['https://www.googleapis.com/auth/compute'] default: ['https://www.googleapis.com/auth/compute']
env:
- name: GCP_SCOPES
version_added: "2.8"
service_account_file: service_account_file:
description: description:
- The path of a Service Account JSON file if serviceaccount is selected as type. - The path of a Service Account JSON file if serviceaccount is selected as type.
type: path type: path
env: env:
- name: GCP_SERVICE_ACCOUNT_FILE
version_added: "2.8"
- name: GCE_CREDENTIALS_FILE_PATH - name: GCE_CREDENTIALS_FILE_PATH
version_added: "2.8" version_added: "2.8"
service_account_email: service_account_email:
description: description:
- An optional service account email address if machineaccount is selected - An optional service account email address if machineaccount is selected
and the user does not wish to use the default email. and the user does not wish to use the default email.
env:
- name: GCP_SERVICE_ACCOUNT_EMAIL
version_added: "2.8"
vars_prefix: vars_prefix:
description: prefix to apply to host variables, does not include facts nor params description: prefix to apply to host variables, does not include facts nor params
default: '' default: ''