Skip to content

secrets.v1beta1.vaultAuthGlobal

"VaultAuthGlobal is the Schema for the vaultauthglobals API"

Index

Fields

fn new

new(name)

new returns an instance of VaultAuthGlobal

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"VaultAuthGlobalSpec defines the desired state of VaultAuthGlobal"

fn spec.withAllowedNamespaces

withAllowedNamespaces(allowedNamespaces)

"AllowedNamespaces Kubernetes Namespaces which are allow-listed for use with\nthis VaultAuthGlobal. This field allows administrators to customize which\nKubernetes namespaces are authorized to reference this resource. While Vault\nwill still enforce its own rules, this has the added configurability of\nrestricting which VaultAuthMethods can be used by which namespaces. Accepted\nvalues: []{\"*\"} - wildcard, all namespaces. []{\"a\", \"b\"} - list of namespaces.\nunset - disallow all namespaces except the Operator's and the referring\nVaultAuthMethod's namespace, this is the default behavior."

fn spec.withAllowedNamespacesMixin

withAllowedNamespacesMixin(allowedNamespaces)

"AllowedNamespaces Kubernetes Namespaces which are allow-listed for use with\nthis VaultAuthGlobal. This field allows administrators to customize which\nKubernetes namespaces are authorized to reference this resource. While Vault\nwill still enforce its own rules, this has the added configurability of\nrestricting which VaultAuthMethods can be used by which namespaces. Accepted\nvalues: []{\"*\"} - wildcard, all namespaces. []{\"a\", \"b\"} - list of namespaces.\nunset - disallow all namespaces except the Operator's and the referring\nVaultAuthMethod's namespace, this is the default behavior."

Note: This function appends passed data to existing values

fn spec.withDefaultAuthMethod

withDefaultAuthMethod(defaultAuthMethod)

"DefaultAuthMethod to use when authenticating to Vault."

fn spec.withDefaultMount

withDefaultMount(defaultMount)

"DefaultMount to use when authenticating to auth method. If not specified the mount of\nthe auth method configured in Vault will be used."

fn spec.withDefaultVaultNamespace

withDefaultVaultNamespace(defaultVaultNamespace)

"DefaultVaultNamespace to auth to in Vault, if not specified the namespace of the auth\nmethod will be used. This can be used as a default Vault namespace for all\nauth methods."

fn spec.withHeaders

withHeaders(headers)

"DefaultHeaders to be included in all Vault requests."

fn spec.withHeadersMixin

withHeadersMixin(headers)

"DefaultHeaders to be included in all Vault requests."

Note: This function appends passed data to existing values

fn spec.withParams

withParams(params)

"DefaultParams to use when authenticating to Vault"

fn spec.withParamsMixin

withParamsMixin(params)

"DefaultParams to use when authenticating to Vault"

Note: This function appends passed data to existing values

fn spec.withVaultConnectionRef

withVaultConnectionRef(vaultConnectionRef)

"VaultConnectionRef to the VaultConnection resource, can be prefixed with a namespace,\neg: namespaceA/vaultConnectionRefB. If no namespace prefix is provided it will default to\nthe namespace of the VaultConnection CR. If no value is specified for VaultConnectionRef the\nOperator will default to the default VaultConnection, configured in the operator's namespace."

obj spec.appRole

"AppRole specific auth configuration, requires that the Method be set to appRole."

fn spec.appRole.withHeaders

withHeaders(headers)

"Headers to be included in all Vault requests."

fn spec.appRole.withHeadersMixin

withHeadersMixin(headers)

"Headers to be included in all Vault requests."

Note: This function appends passed data to existing values

fn spec.appRole.withMount

withMount(mount)

"Mount to use when authenticating to auth method."

fn spec.appRole.withNamespace

withNamespace(namespace)

"Namespace to auth to in Vault"

fn spec.appRole.withParams

withParams(params)

"Params to use when authenticating to Vault"

fn spec.appRole.withParamsMixin

withParamsMixin(params)

"Params to use when authenticating to Vault"

Note: This function appends passed data to existing values

fn spec.appRole.withRoleId

withRoleId(roleId)

"RoleID of the AppRole Role to use for authenticating to Vault."

fn spec.appRole.withSecretRef

withSecretRef(secretRef)

"SecretRef is the name of a Kubernetes secret in the consumer's (VDS/VSS/PKI) namespace which\nprovides the AppRole Role's SecretID. The secret must have a key named id which holds the\nAppRole Role's secretID."

obj spec.aws

"AWS specific auth configuration, requires that Method be set to aws."

fn spec.aws.withHeaderValue

withHeaderValue(headerValue)

"The Vault header value to include in the STS signing request"

fn spec.aws.withHeaders

withHeaders(headers)

"Headers to be included in all Vault requests."

fn spec.aws.withHeadersMixin

withHeadersMixin(headers)

"Headers to be included in all Vault requests."

Note: This function appends passed data to existing values

fn spec.aws.withIamEndpoint

withIamEndpoint(iamEndpoint)

"The IAM endpoint to use; if not set will use the default"

fn spec.aws.withIrsaServiceAccount

withIrsaServiceAccount(irsaServiceAccount)

"IRSAServiceAccount name to use with IAM Roles for Service Accounts\n(IRSA), and should be annotated with \"eks.amazonaws.com/role-arn\". This\nServiceAccount will be checked for other EKS annotations:\neks.amazonaws.com/audience and eks.amazonaws.com/token-expiration"

fn spec.aws.withMount

withMount(mount)

"Mount to use when authenticating to auth method."

fn spec.aws.withNamespace

withNamespace(namespace)

"Namespace to auth to in Vault"

fn spec.aws.withParams

withParams(params)

"Params to use when authenticating to Vault"

fn spec.aws.withParamsMixin

withParamsMixin(params)

"Params to use when authenticating to Vault"

Note: This function appends passed data to existing values

fn spec.aws.withRegion

withRegion(region)

"AWS Region to use for signing the authentication request"

fn spec.aws.withRole

withRole(role)

"Vault role to use for authenticating"

fn spec.aws.withSecretRef

withSecretRef(secretRef)

"SecretRef is the name of a Kubernetes Secret in the consumer's (VDS/VSS/PKI) namespace\nwhich holds credentials for AWS. Expected keys include access_key_id, secret_access_key,\nsession_token"

fn spec.aws.withSessionName

withSessionName(sessionName)

"The role session name to use when creating a webidentity provider"

fn spec.aws.withStsEndpoint

withStsEndpoint(stsEndpoint)

"The STS endpoint to use; if not set will use the default"

obj spec.gcp

"GCP specific auth configuration, requires that Method be set to gcp."

fn spec.gcp.withClusterName

withClusterName(clusterName)

"GKE cluster name. Defaults to the cluster-name returned from the operator\npod's local metadata server."

fn spec.gcp.withHeaders

withHeaders(headers)

"Headers to be included in all Vault requests."

fn spec.gcp.withHeadersMixin

withHeadersMixin(headers)

"Headers to be included in all Vault requests."

Note: This function appends passed data to existing values

fn spec.gcp.withMount

withMount(mount)

"Mount to use when authenticating to auth method."

fn spec.gcp.withNamespace

withNamespace(namespace)

"Namespace to auth to in Vault"

fn spec.gcp.withParams

withParams(params)

"Params to use when authenticating to Vault"

fn spec.gcp.withParamsMixin

withParamsMixin(params)

"Params to use when authenticating to Vault"

Note: This function appends passed data to existing values

fn spec.gcp.withProjectID

withProjectID(projectID)

"GCP project ID. Defaults to the project-id returned from the operator\npod's local metadata server."

fn spec.gcp.withRegion

withRegion(region)

"GCP Region of the GKE cluster's identity provider. Defaults to the region\nreturned from the operator pod's local metadata server."

fn spec.gcp.withRole

withRole(role)

"Vault role to use for authenticating"

fn spec.gcp.withWorkloadIdentityServiceAccount

withWorkloadIdentityServiceAccount(workloadIdentityServiceAccount)

"WorkloadIdentityServiceAccount is the name of a Kubernetes service\naccount (in the same Kubernetes namespace as the Vault*Secret referencing\nthis resource) which has been configured for workload identity in GKE.\nShould be annotated with \"iam.gke.io/gcp-service-account\"."

obj spec.jwt

"JWT specific auth configuration, requires that the Method be set to jwt."

fn spec.jwt.withAudiences

withAudiences(audiences)

"TokenAudiences to include in the ServiceAccount token."

fn spec.jwt.withAudiencesMixin

withAudiencesMixin(audiences)

"TokenAudiences to include in the ServiceAccount token."

Note: This function appends passed data to existing values

fn spec.jwt.withHeaders

withHeaders(headers)

"Headers to be included in all Vault requests."

fn spec.jwt.withHeadersMixin

withHeadersMixin(headers)

"Headers to be included in all Vault requests."

Note: This function appends passed data to existing values

fn spec.jwt.withMount

withMount(mount)

"Mount to use when authenticating to auth method."

fn spec.jwt.withNamespace

withNamespace(namespace)

"Namespace to auth to in Vault"

fn spec.jwt.withParams

withParams(params)

"Params to use when authenticating to Vault"

fn spec.jwt.withParamsMixin

withParamsMixin(params)

"Params to use when authenticating to Vault"

Note: This function appends passed data to existing values

fn spec.jwt.withRole

withRole(role)

"Role to use for authenticating to Vault."

fn spec.jwt.withSecretRef

withSecretRef(secretRef)

"SecretRef is the name of a Kubernetes secret in the consumer's (VDS/VSS/PKI) namespace which\nprovides the JWT token to authenticate to Vault's JWT authentication backend. The secret must\nhave a key named jwt which holds the JWT token."

fn spec.jwt.withServiceAccount

withServiceAccount(serviceAccount)

"ServiceAccount to use when creating a ServiceAccount token to authenticate to Vault's\nJWT authentication backend."

fn spec.jwt.withTokenExpirationSeconds

withTokenExpirationSeconds(tokenExpirationSeconds)

"TokenExpirationSeconds to set the ServiceAccount token."

obj spec.kubernetes

"Kubernetes specific auth configuration, requires that the Method be set to kubernetes."

fn spec.kubernetes.withAudiences

withAudiences(audiences)

"TokenAudiences to include in the ServiceAccount token."

fn spec.kubernetes.withAudiencesMixin

withAudiencesMixin(audiences)

"TokenAudiences to include in the ServiceAccount token."

Note: This function appends passed data to existing values

fn spec.kubernetes.withHeaders

withHeaders(headers)

"Headers to be included in all Vault requests."

fn spec.kubernetes.withHeadersMixin

withHeadersMixin(headers)

"Headers to be included in all Vault requests."

Note: This function appends passed data to existing values

fn spec.kubernetes.withMount

withMount(mount)

"Mount to use when authenticating to auth method."

fn spec.kubernetes.withNamespace

withNamespace(namespace)

"Namespace to auth to in Vault"

fn spec.kubernetes.withParams

withParams(params)

"Params to use when authenticating to Vault"

fn spec.kubernetes.withParamsMixin

withParamsMixin(params)

"Params to use when authenticating to Vault"

Note: This function appends passed data to existing values

fn spec.kubernetes.withRole

withRole(role)

"Role to use for authenticating to Vault."

fn spec.kubernetes.withServiceAccount

withServiceAccount(serviceAccount)

"ServiceAccount to use when authenticating to Vault's\nauthentication backend. This must reside in the consuming secret's (VDS/VSS/PKI) namespace."

fn spec.kubernetes.withTokenExpirationSeconds

withTokenExpirationSeconds(tokenExpirationSeconds)

"TokenExpirationSeconds to set the ServiceAccount token."