google.cloud.gcp_containeranalysis_note module – Manages a ContainerAnalysis.Note resource

Note

This module is part of the google.cloud collection (version 1.15.0).

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_containeranalysis_note.

Synopsis

• A Container Analysis note is a high-level piece of metadata that

• describes a type of analysis that can be done for a resource.

Requirements

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

• python >= 3.8

• requests >= 2.18.4

• google-auth >= 2.25.1

Parameters

Parameter	Comments
access_token string	The access token used to authenticate.
attestation_authority dictionary / required	Note kind that represents a logical attestation “role” or “authority”. For example, an organization might have one AttestationAuthority for “QA” and one for “build”. This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don’t all live in the same project.
hint dictionary / required	This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from “readable” names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify.
human_readable_name string / required	The human readable name of this Attestation Authority, for example “qa”.
auth_kind string / required	The type of credential used. Choices: "accesstoken" "application" "machineaccount" "serviceaccount"
env_type string	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.
expiration_time string	Time of expiration for this note. Leave empty if note does not expire.
long_description string	A detailed description of the note.
name string / required	The name of the note. This property is immutable, to change it, you must delete and recreate the resource.
project string	The Google Cloud Platform project to use.
related_note_names list / elements=string	Names of other notes related to this note.
related_url list / elements=dictionary	URLs associated with this note and related metadata.
label string	Label to describe usage of the URL.
url string / required	Specific URL associated with the resource.
scopes list / elements=string	Array of scopes to be used.
service_account_contents jsonarg	The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
service_account_email string	An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file path	The path of a Service Account JSON file if serviceaccount is selected as type.
short_description string	A one sentence description of the note.
state string	Whether the resource should exist. Choices: "present" ← (default) "absent"

Notes

Note

• API Reference: https://cloud.google.com/container-analysis/api/reference/rest/

• Creating Attestations (Occurrences) Guide: https://cloud.google.com/binary-authorization/docs/making-attestations

• Official Documentation Guide: https://cloud.google.com/container-analysis/

• For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

• 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 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, service_account_file, service_account_file and access_token options are mutually exclusive.

Examples

- name: Create Container Analysis Note
  google.cloud.gcp_containeranalysis_note:
    name: my-note
    state: present
    attestation_authority:
      hint:
        human_readable_name: "qa@example.com"
    short_description: "QA team attestation"

################################################################################

- name: Delete Container Analysis Note
  google.cloud.gcp_containeranalysis_note:
    name: my-note
    state: absent
    attestation_authority:
      hint:
        human_readable_name: "qa@example.com"

Return Values

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

Key	Description
attestationAuthority dictionary	Note kind that represents a logical attestation “role” or “authority”. For example, an organization might have one AttestationAuthority for “QA” and one for “build”. This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don’t all live in the same project. Returned: always
hint dictionary	This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from “readable” names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. Returned: always
humanReadableName string	The human readable name of this Attestation Authority, for example “qa”. Returned: always
changed boolean	Whether the resource was changed. Returned: always
createTime string	The time this note was created. Returned: success
expirationTime string	Time of expiration for this note. Leave empty if note does not expire. Returned: when set
kind string	The type of analysis this note describes. Returned: success
longDescription string	A detailed description of the note. Returned: when set
name string	The name of the note. This property is immutable, to change it, you must delete and recreate the resource. Returned: always
relatedNoteNames list / elements=string	Names of other notes related to this note. Returned: when set
relatedUrl list / elements=dictionary	URLs associated with this note and related metadata. Returned: when set
label string	Label to describe usage of the URL. Returned: when set
url string	Specific URL associated with the resource. Returned: always
shortDescription string	A one sentence description of the note. Returned: when set
state string	The current state of the resource. Returned: always
updateTime string	The time this note was last updated. Returned: success

Authors

• Google Inc. (@googlecloudplatform)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)