google.cloud.gcp_compute_reservation module – Creates a GCP Reservation
Note
This module is part of the google.cloud collection (version 1.4.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install google.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: google.cloud.gcp_compute_reservation
.
Synopsis
Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running.
Reservations apply only to Compute Engine, Cloud Dataproc, and Google Kubernetes Engine VM usage.Reservations do not apply to `f1-micro` or `g1-small` machine types, preemptible VMs, sole tenant nodes, or other services not listed above like Cloud SQL and Dataflow.
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 |
Comments |
---|---|
An OAuth2 access token if credential type is accesstoken. |
|
The type of credential used. Choices:
|
|
An optional description of this resource. |
|
Specifies which Ansible environment you’re running this module within. This should not be set unless you know what you’re doing. This only alters the User Agent string for any API requests. |
|
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. |
|
The Google Cloud Platform project to use. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
Reservation for instances with specific machine shapes. |
|
The number of resources that are allocated. |
|
The instance properties for the reservation. |
|
Guest accelerator type and count. |
|
The number of the guest accelerator cards exposed to this instance. |
|
The full or partial URL of the accelerator type to attach to this instance. For example: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100` If you are creating an instance template, specify only the accelerator name. |
|
The amount of local ssd to reserve with each instance. This reserves disks of type `local-ssd`. |
|
The size of the disk in base-2 GB. |
|
The disk interface to use for attaching this disk. Some valid choices include: “SCSI”, “NVME” Default: |
|
The name of the machine type to reserve. |
|
The minimum CPU platform for the reservation. For example, `”Intel Skylake”`. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones for information on available CPU platforms. |
|
When set to true, only VMs that target this reservation by name can consume this reservation. Otherwise, it can be consumed by VMs with affinity for any reservation. Defaults to false. Choices:
|
|
Whether the given object should exist in GCP Choices:
|
|
The zone where the reservation is made. |
Notes
Note
API Reference: https://cloud.google.com/compute/docs/reference/rest/v1/reservations
Reserving zonal resources: https://cloud.google.com/compute/docs/instances/reserving-zonal-resources
for authentication, you can set service_account_file using the
GCP_SERVICE_ACCOUNT_FILE
env variable.for authentication, you can set service_account_contents using the
GCP_SERVICE_ACCOUNT_CONTENTS
env variable.For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAIL
env variable.For authentication, you can set access_token using the
GCP_ACCESS_TOKEN
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 reservation
google.cloud.gcp_compute_reservation:
name: test_object
zone: us-central1-a
specific_reservation:
count: 1
instance_properties:
min_cpu_platform: Intel Cascade Lake
machine_type: n2-standard-2
project: test_project
auth_kind: serviceaccount
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 |
Description |
---|---|
Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. Returned: success |
|
Creation timestamp in RFC3339 text format. Returned: success |
|
An optional description of this resource. Returned: success |
|
The unique identifier for the resource. Returned: 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. Returned: success |
|
Reservation for instances with specific machine shapes. Returned: success |
|
The number of resources that are allocated. Returned: success |
|
The instance properties for the reservation. Returned: success |
|
Guest accelerator type and count. Returned: success |
|
The number of the guest accelerator cards exposed to this instance. Returned: success |
|
The full or partial URL of the accelerator type to attach to this instance. For example: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100` If you are creating an instance template, specify only the accelerator name. Returned: success |
|
The amount of local ssd to reserve with each instance. This reserves disks of type `local-ssd`. Returned: success |
|
The size of the disk in base-2 GB. Returned: success |
|
The disk interface to use for attaching this disk. Returned: success |
|
The name of the machine type to reserve. Returned: success |
|
The minimum CPU platform for the reservation. For example, `”Intel Skylake”`. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones for information on available CPU platforms. Returned: success |
|
How many instances are in use. Returned: success |
|
When set to true, only VMs that target this reservation by name can consume this reservation. Otherwise, it can be consumed by VMs with affinity for any reservation. Defaults to false. Returned: success |
|
The status of the reservation. Returned: success |
|
The zone where the reservation is made. Returned: success |