ETCDSnapshotFile
k3s.cattle.io / v1
apiVersion: k3s.cattle.io/v1
kind: ETCDSnapshotFile
metadata:
name: example
apiVersion
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
kind
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
metadata
object
spec object
Spec defines properties of an etcd snapshot file
location
string required
Location is the absolute file:// or s3:// URI address of the snapshot.
metadata
object
Metadata contains point-in-time snapshot of the contents of the
k3s-etcd-snapshot-extra-metadata ConfigMap's data field, at the time the
snapshot was taken. This is intended to contain data about cluster state
that may be important for an external system to have available when restoring
the snapshot.
nodeName
string required
NodeName contains the name of the node that took the snapshot.
s3 object
S3 contains extra metadata about the S3 storage system holding the
snapshot. This is guaranteed to be set for all snapshots uploaded to S3.
If not specified, the snapshot was not uploaded to S3.
bucket
string
Bucket is the bucket holding the snapshot
bucketLookup
string
BucketLookup is the bucket lookup type, one of 'auto', 'dns', 'path'. Default if empty is 'auto'.
endpoint
string
Endpoint is the host or host:port of the S3 service
endpointCA
string
EndpointCA is the path on disk to the S3 service's trusted CA list. Leave empty to use the OS CA bundle.
insecure
boolean
Insecure is true if the S3 service uses HTTP instead of HTTPS
prefix
string
Prefix is the prefix in which the snapshot file is stored.
region
string
Region is the region of the S3 service
skipSSLVerify
boolean
SkipSSLVerify is true if TLS certificate verification is disabled
snapshotName
string required
SnapshotName contains the base name of the snapshot file. CLI actions that act
on snapshots stored locally or within a pre-configured S3 bucket and
prefix usually take the snapshot name as their argument.
status object
Status represents current information about a snapshot.
creationTime
string
CreationTime is the timestamp when the snapshot was taken by etcd.
format:
date-timeerror object
Error is the last observed error during snapshot creation, if any.
If the snapshot is retried, this field will be cleared on success.
message
string
Message is a string detailing the encountered error during snapshot creation if specified.
NOTE: message may be logged, and it should not contain sensitive information.
time
string
Time is the timestamp when the error was encountered.
format:
date-time
readyToUse
boolean
ReadyToUse indicates that the snapshot is available to be restored.
size
string | integer
Size is the size of the snapshot file, in bytes. If not specified, the snapshot failed.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$No matches. Try .spec.location for an exact path