DatabaseV3 is the Schema for the databasesv3 API
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
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
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
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: stringCreationTimestamp 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
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.
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
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.
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
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
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: stringManagedFields 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 ItemsManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
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.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
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.
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 creationTimestampName 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
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
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 ItemsOwnerReference 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.
API version of the referent.
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.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
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
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
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
Database resource definition v3 from Teleport
AD is the Active Directory configuration for the database.
Domain is the Active Directory domain the database resides in.
KDCHostName is the host name for a KDC for x509 Authentication.
KeytabFile is the path to the Kerberos keytab file.
Krb5File is the path to the Kerberos configuration file. Defaults to /etc/krb5.conf.
LDAPCert is a certificate from Windows LDAP/AD, optional; only for x509 Authentication.
LDAPServiceAccountName is the name of service account for performing LDAP queries. Required for x509 Auth / PKINIT.
LDAPServiceAccountSID is the SID of service account for performing LDAP queries. Required for x509 Auth / PKINIT.
SPN is the service principal name for the database.
AdminUser is the database admin user for automatic user provisioning.
AWS contains AWS specific settings for RDS/Aurora/Redshift databases.
AccountID is the AWS account ID this database belongs to.
AssumeRoleARN is an optional AWS role ARN to assume when accessing a database. Set this field and ExternalID to enable access across AWS accounts.
DocumentDB contains Amazon DocumentDB-specific metadata.
ClusterID is the cluster identifier.
EndpointType is the type of the endpoint.
InstanceID is the instance identifier.
ElastiCache contains Amazon ElastiCache Redis-specific metadata.
EndpointType is the type of the endpoint.
ReplicationGroupID is the Redis replication group ID.
TransitEncryptionEnabled indicates whether in-transit encryption (TLS) is enabled.
UserGroupIDs is a list of user group IDs.
ElastiCacheServerless contains Amazon ElastiCache Serverless metadata.
CacheName is an ElastiCache Serverless cache name.
ExternalID is an optional AWS external ID used to enable assuming an AWS role across accounts.
IAMPolicyStatus indicates whether the IAM Policy is configured properly for database access. If not, the user must update the AWS profile identity to allow access to the Database. Eg for an RDS Database: the underlying AWS profile allows for rds-db:connect for the Database.
MemoryDB contains AWS MemoryDB specific metadata.
ACLName is the name of the ACL associated with the cluster.
ClusterName is the name of the MemoryDB cluster.
EndpointType is the type of the endpoint.
TLSEnabled indicates whether in-transit encryption (TLS) is enabled.
OpenSearch contains AWS OpenSearch specific metadata.
DomainID is the ID of the domain.
DomainName is the name of the domain.
EndpointType is the type of the endpoint.
RDS contains RDS specific metadata.
ClusterID is the RDS cluster (Aurora) identifier.
IAMAuth indicates whether database IAM authentication is enabled.
InstanceID is the RDS instance identifier.
ResourceID is the RDS instance resource identifier (db-xxx).
SecurityGroups is a list of attached security groups for the RDS instance.
Subnets is a list of subnets for the RDS instance.
VPCID is the VPC where the RDS is running.
RDSProxy contains AWS Proxy specific metadata.
CustomEndpointName is the identifier of an RDS Proxy custom endpoint.
Name is the identifier of an RDS Proxy.
ResourceID is the RDS instance resource identifier (prx-xxx).
Redshift contains Redshift specific metadata.
ClusterID is the Redshift cluster identifier.
RedshiftServerless contains metatada specific to Amazon Redshift Serverless.
EndpointName is the VPC endpoint name.
WorkgroupID is the workgroup ID.
WorkgroupName is the workgroup name.
Region is a AWS cloud region.
SecretStore contains secret store configurations.
KeyPrefix specifies the secret key prefix.
KMSKeyID specifies the AWS KMS key for encryption.
Azure contains Azure specific database metadata.
IsFlexiServer is true if the database is an Azure Flexible server.
Name is the Azure database server name.
Redis contains Azure Cache for Redis specific database metadata.
ClusteringPolicy is the clustering policy for Redis Enterprise.
ResourceID is the Azure fully qualified ID for the resource.
CACert is the PEM-encoded database CA certificate. DEPRECATED: Moved to TLS.CACert. DELETE IN 10.0.
DynamicLabels is the database dynamic labels.
Each additional property must conform to the following schema
Type: objectGCP contains parameters specific to GCP Cloud SQL databases.
AlloyDB contains AlloyDB specific configuration elements.
EndpointOverride is an override of endpoint address to use.
EndpointType is the database endpoint type to use. Should be one of: "private", "public", "psc".
InstanceID is the Cloud SQL instance ID.
ProjectID is the GCP project ID the Cloud SQL instance resides in.
MongoAtlas contains Atlas metadata about the database.
Name is the Atlas database instance name.
MySQL is an additional section with MySQL database options.
ServerVersion is the server version reported by DB proxy if the runtime information is not available.
Oracle is an additional Oracle configuration options.
AuditUser is the name of the Oracle database user that should be used to access the internal audit trail.
RetryCount is the maximum number of times to retry connecting to a host upon failure. If not specified it defaults to 2, for a total of 3 connection attempts.
ShuffleHostnames, when true, randomizes the order of hosts to connect to from the provided list.
Protocol is the database protocol: postgres, mysql, mongodb, etc.
TLS is the TLS configuration used when establishing connection to target database. Allows to provide custom CA cert or override server name.
CACert is an optional user provided CA certificate used for verifying database TLS connection.
Mode is a TLS connection mode. 0 is "verify-full"; 1 is "verify-ca", 2 is "insecure".
ServerName allows to provide custom hostname. This value will override the servername/hostname on a certificate during validation.
TrustSystemCertPool allows Teleport to trust certificate authorities available on the host system. If not set (by default), Teleport only trusts self-signed databases with TLS certificates signed by Teleport's Database Server CA or the ca_cert specified in this TLS setting. For cloud-hosted databases, Teleport downloads the corresponding required CAs for validation.
URI is the database connection endpoint.
Status defines the observed state of the Teleport resource
Conditions represent the latest available observations of an object's state
No Additional ItemsCondition contains details for one aspect of the current state of this API Resource.
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message is a human readable message indicating details about the transition.
This may be an empty string.
Must be at most 32768 characters long
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
Value must be greater or equal to 0
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
Must be at least 1 characters long
Must be at most 1024 characters long
status of the condition, one of True, False, Unknown.
type of condition in CamelCase or in foo.example.com/CamelCase.
Must match regular expression:^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
Must be at most 316 characters long