mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Update GCE PEM deprecation text and examples
This commit is contained in:
parent
73d47ec7a4
commit
353db36515
4 changed files with 41 additions and 10 deletions
|
@ -76,11 +76,12 @@ options:
|
||||||
pem_file:
|
pem_file:
|
||||||
version_added: 1.5.1
|
version_added: 1.5.1
|
||||||
description:
|
description:
|
||||||
- (deprecated) path to the pem file associated with the service account email
|
- path to the pem file associated with the service account email
|
||||||
|
This option is deprecated. Use 'credentials_file'.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
credentials_file:
|
credentials_file:
|
||||||
version_added: 2.1.0
|
version_added: "2.1.0"
|
||||||
description:
|
description:
|
||||||
- path to the JSON file associated with the service account email
|
- path to the JSON file associated with the service account email
|
||||||
default: null
|
default: null
|
||||||
|
@ -163,7 +164,7 @@ options:
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.6"
|
- "python >= 2.6"
|
||||||
- "apache-libcloud >= 0.17.0"
|
- "apache-libcloud >= 0.13.3, >= 0.17.0 if using JSON credentials"
|
||||||
notes:
|
notes:
|
||||||
- Either I(name) or I(instance_names) is required.
|
- Either I(name) or I(instance_names) is required.
|
||||||
author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
|
author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
|
||||||
|
@ -188,6 +189,9 @@ EXAMPLES = '''
|
||||||
|
|
||||||
# Launch instances from a control node, runs some tasks on the new instances,
|
# Launch instances from a control node, runs some tasks on the new instances,
|
||||||
# and then terminate them
|
# and then terminate them
|
||||||
|
# This example uses JSON credentials with the credentials_file parameter
|
||||||
|
# rather than the deprecated pem_file option with PEM formatted credentials.
|
||||||
|
|
||||||
- name: Create a sandbox instance
|
- name: Create a sandbox instance
|
||||||
hosts: localhost
|
hosts: localhost
|
||||||
vars:
|
vars:
|
||||||
|
@ -226,6 +230,30 @@ EXAMPLES = '''
|
||||||
state: 'absent'
|
state: 'absent'
|
||||||
instance_names: {{gce.instance_names}}
|
instance_names: {{gce.instance_names}}
|
||||||
|
|
||||||
|
# The deprecated PEM file credentials can be used as follows
|
||||||
|
- name: Create a sandbox instance with PEM credentials
|
||||||
|
hosts: localhost
|
||||||
|
vars:
|
||||||
|
names: foo,bar
|
||||||
|
machine_type: n1-standard-1
|
||||||
|
image: debian-6
|
||||||
|
zone: us-central1-a
|
||||||
|
service_account_email: unique-email@developer.gserviceaccount.com
|
||||||
|
pem_file: /path/to/pem_file
|
||||||
|
project_id: project-id
|
||||||
|
tasks:
|
||||||
|
- name: Launch instances
|
||||||
|
local_action: gce instance_names={{names}} machine_type={{machine_type}}
|
||||||
|
image={{image}} zone={{zone}}
|
||||||
|
service_account_email={{ service_account_email }}
|
||||||
|
pem_file={{ pem_file }}
|
||||||
|
project_id={{ project_id }}
|
||||||
|
register: gce
|
||||||
|
- name: Wait for SSH to come up
|
||||||
|
local_action: wait_for host={{item.public_ip}} port=22 delay=10
|
||||||
|
timeout=60 state=started
|
||||||
|
with_items: {{gce.instance_data}}
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
|
|
@ -119,12 +119,13 @@ options:
|
||||||
pem_file:
|
pem_file:
|
||||||
version_added: "1.6"
|
version_added: "1.6"
|
||||||
description:
|
description:
|
||||||
- (deprecated) path to the pem file associated with the service account email
|
- path to the pem file associated with the service account email
|
||||||
|
This option is deprecated. Use 'credentials_file'.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
aliases: []
|
||||||
credentials_file:
|
credentials_file:
|
||||||
version_added: 2.1.0
|
version_added: "2.1.0"
|
||||||
description:
|
description:
|
||||||
- path to the JSON file associated with the service account email
|
- path to the JSON file associated with the service account email
|
||||||
default: null
|
default: null
|
||||||
|
@ -139,7 +140,7 @@ options:
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.6"
|
- "python >= 2.6"
|
||||||
- "apache-libcloud >= 0.17.0"
|
- "apache-libcloud >= 0.13.3, >= 0.17.0 if using JSON credentials"
|
||||||
author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
|
author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -91,7 +91,8 @@ options:
|
||||||
pem_file:
|
pem_file:
|
||||||
version_added: "1.6"
|
version_added: "1.6"
|
||||||
description:
|
description:
|
||||||
- (deprecated) path to the pem file associated with the service account email
|
- path to the pem file associated with the service account email
|
||||||
|
This option is deprecated. Use 'credentials_file'.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
aliases: []
|
||||||
|
@ -112,7 +113,7 @@ options:
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.6"
|
- "python >= 2.6"
|
||||||
- "apache-libcloud >= 0.17.0"
|
- "apache-libcloud >= 0.13.3, >= 0.17.0 if using JSON credentials"
|
||||||
author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
|
author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -97,7 +97,8 @@ options:
|
||||||
pem_file:
|
pem_file:
|
||||||
version_added: "1.6"
|
version_added: "1.6"
|
||||||
description:
|
description:
|
||||||
- (deprecated) path to the pem file associated with the service account email
|
- path to the pem file associated with the service account email
|
||||||
|
This option is deprecated. Use 'credentials_file'.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
aliases: []
|
||||||
|
@ -126,7 +127,7 @@ options:
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.6"
|
- "python >= 2.6"
|
||||||
- "apache-libcloud >= 0.17.0"
|
- "apache-libcloud >= 0.13.3, >= 0.17.0 if using JSON credentials"
|
||||||
author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
|
author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue