ExternalSecretList (external-secrets.io/v1beta1)

Type: object

ExternalSecretList is a list of ExternalSecret

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: array

List of externalsecrets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

No Additional Items

Each item of this array must be:

io.external-secrets.v1beta1.ExternalSecret

Type: object

ExternalSecret is the Schema for the external-secrets API.

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

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.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

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.

No Additional Items

Each item of this array must be:

Type: string

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.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

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

Type: object

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Manager is an identifier of the workflow managing these fields.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

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.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

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.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

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.

Populated 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

Type: string

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.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

ExternalSecretSpec defines the desired state of ExternalSecret.

Type: array of object

Data defines the connection between the Kubernetes Secret keys and the Provider data

No Additional Items

Each item of this array must be:

Type: object

ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.<key>) and the Provider data.

Type: object

RemoteRef points to the remote secret and defines
which secret (version/property/..) to fetch.

Type: enum (of string)

Used to define a conversion Strategy

Must be one of:

  • "Default"
  • "Unicode"

Type: enum (of string)

Used to define a decoding Strategy

Must be one of:

  • "Auto"
  • "Base64"
  • "Base64URL"
  • "None"

Type: string

Key is the key used in the Provider, mandatory

Type: enum (of string)

Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None

Must be one of:

  • "None"
  • "Fetch"

Type: string

Used to select a specific property of the Provider value (if a map), if supported

Type: string

Used to select a specific version of the Provider value, if supported

Type: string

SecretKey defines the key in which the controller stores
the value. This is the key in the Kind=Secret

Type: object

SourceRef allows you to override the source
from which the value will pulled from.

Type: object

GeneratorRef points to a generator custom resource.

Deprecated: The generatorRef is not implemented in .data[].
this will be removed with v1.

Type: string

Specify the apiVersion of the generator resource

Type: string

Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.

Type: string

Specify the name of the generator resource

Type: object

SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.

Type: string

Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
Defaults to SecretStore

Type: string

Name of the SecretStore resource

Type: array of object

DataFrom is used to fetch all properties from a specific Provider data
If multiple entries are specified, the Secret keys are merged in the specified order

No Additional Items

Each item of this array must be:

Type: object

Type: object

Used to extract multiple key/value pairs from one secret
Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.

Type: enum (of string)

Used to define a conversion Strategy

Must be one of:

  • "Default"
  • "Unicode"

Type: enum (of string)

Used to define a decoding Strategy

Must be one of:

  • "Auto"
  • "Base64"
  • "Base64URL"
  • "None"

Type: string

Key is the key used in the Provider, mandatory

Type: enum (of string)

Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None

Must be one of:

  • "None"
  • "Fetch"

Type: string

Used to select a specific property of the Provider value (if a map), if supported

Type: string

Used to select a specific version of the Provider value, if supported

Type: object

Used to find secrets based on tags or regular expressions
Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.

Type: enum (of string)

Used to define a conversion Strategy

Must be one of:

  • "Default"
  • "Unicode"

Type: enum (of string)

Used to define a decoding Strategy

Must be one of:

  • "Auto"
  • "Base64"
  • "Base64URL"
  • "None"

Type: string

A root path to start the find operations.

Type: object

Find secrets based on tags.

Each additional property must conform to the following schema

Type: string

Type: array of object

Used to rewrite secret Keys after getting them from the secret Provider
Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)

No Additional Items

Each item of this array must be:

Type: object

Type: object

Used to rewrite with regular expressions.
The resulting key will be the output of a regexp.ReplaceAll operation.

Type: string

Used to define the regular expression of a re.Compiler.

Type: string

Used to define the target pattern of a ReplaceAll operation.

Type: object

Used to apply string transformation on the secrets.
The resulting key will be the output of the template applied by the operation.

Type: string

Used to define the template to apply on the secret name.
.value will specify the secret name in the template.

Type: object

SourceRef points to a store or generator
which contains secret values ready to use.
Use this in combination with Extract or Find pull values out of
a specific SecretStore.
When sourceRef points to a generator Extract or Find is not supported.
The generator returns a static map of values

Type: object

GeneratorRef points to a generator custom resource.

Type: string

Specify the apiVersion of the generator resource

Type: string

Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.

Type: string

Specify the name of the generator resource

Type: object

SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.

Type: string

Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
Defaults to SecretStore

Type: string

RefreshInterval is the amount of time before the values are read again from the SecretStore provider
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h"
May be set to zero to fetch and create it once. Defaults to 1h.

Type: object

SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.

Type: string

Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
Defaults to SecretStore

Type: string

Name of the SecretStore resource

Type: object

ExternalSecretTarget defines the Kubernetes Secret to be created
There can be only one target per ExternalSecret.

Type: enum (of string)

CreationPolicy defines rules on how to create the resulting Secret
Defaults to 'Owner'

Must be one of:

  • "Owner"
  • "Orphan"
  • "Merge"
  • "None"

Type: enum (of string)

DeletionPolicy defines rules on how to delete the resulting Secret
Defaults to 'Retain'

Must be one of:

  • "Delete"
  • "Merge"
  • "Retain"

Type: boolean

Immutable defines if the final secret will be immutable

Type: string

Name defines the name of the Secret resource to be managed
This field is immutable
Defaults to the .metadata.name of the ExternalSecret resource

Type: object

Template defines a blueprint for the created Secret resource.

Type: object

Each additional property must conform to the following schema

Type: string

Type: enum (of string)

EngineVersion specifies the template engine version
that should be used to compile/execute the
template specified in .data and .templateFrom[].

Must be one of:

  • "v1"
  • "v2"

Type: enum (of string)

Must be one of:

  • "Replace"
  • "Merge"

Type: object

ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.

Type: object

Each additional property must conform to the following schema

Type: string

Type: object

Each additional property must conform to the following schema

Type: string

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: enum (of string)

Must be one of:

  • "Data"
  • "Annotations"
  • "Labels"

Type: object

Type: object

Binding represents a servicebinding.io Provisioned Service reference to the secret

Type: string

Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?

Type: objectFormat: date-time

refreshTime is the time and date the external secret was fetched and
the target secret updated

Type: string

SyncedResourceVersion keeps track of the last synced version

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Type: object

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

Type: integerFormat: int64

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

Type: string

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency