Cloud Functions V1 API - Class Google::Cloud::Functions::V1::SecretVolume (v0.10.0)

Reference documentation and code samples for the Cloud Functions V1 API class Google::Cloud::Functions::V1::SecretVolume.

Configuration for a secret volume. It has the information necessary to fetch the secret value from Secret Manager and make it available as files mounted at the requested paths within the application container. Secret value is not a part of the configuration. Every file system read operation performs a lookup in Secret Manager to retrieve the secret value.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#mount_path

def mount_path() -> ::String
Returns
  • (::String) — The path within the container to mount the secret volume. For example, setting the mount_path as /etc/secrets mounts the secret value files under the /etc/secrets directory. This directory is also completely shadowed and unavailable to mount any other secrets.

    Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log

#mount_path=

def mount_path=(value) -> ::String
Parameter
  • value (::String) — The path within the container to mount the secret volume. For example, setting the mount_path as /etc/secrets mounts the secret value files under the /etc/secrets directory. This directory is also completely shadowed and unavailable to mount any other secrets.

    Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log

Returns
  • (::String) — The path within the container to mount the secret volume. For example, setting the mount_path as /etc/secrets mounts the secret value files under the /etc/secrets directory. This directory is also completely shadowed and unavailable to mount any other secrets.

    Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log

#project_id

def project_id() -> ::String
Returns
  • (::String) — Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it is populated with the function's project, assuming that the secret exists in the same project as the function.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it is populated with the function's project, assuming that the secret exists in the same project as the function.
Returns
  • (::String) — Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it is populated with the function's project, assuming that the secret exists in the same project as the function.

#secret

def secret() -> ::String
Returns
  • (::String) — Name of the secret in Secret Manager (not the full resource name).

#secret=

def secret=(value) -> ::String
Parameter
  • value (::String) — Name of the secret in Secret Manager (not the full resource name).
Returns
  • (::String) — Name of the secret in Secret Manager (not the full resource name).

#versions

def versions() -> ::Array<::Google::Cloud::Functions::V1::SecretVolume::SecretVersion>
Returns

#versions=

def versions=(value) -> ::Array<::Google::Cloud::Functions::V1::SecretVolume::SecretVersion>
Parameter
Returns