Documentation
¶
Overview ¶
Package checkpoint provides libraries that are used by the pod-checkpointer utility to checkpoint pods on a node. See cmd/checkpoint/README.md in this repository for more information.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrorConflictingSecurityContexts = errors.New("pod and/or container(s) have conflicting SecurityContext.RunAsUser values")
ErrorConflictingSecurityContexts is returned when a pod has a PodSecurityContext and/or SecurityContext(s) that have conflicting RunAsUser values.
Functions ¶
Types ¶
type CheckpointerPod ¶
type CheckpointerPod struct {
// The name of the node this checkpointer is running on.
NodeName string
// The name of the pod that is running this checkpointer.
PodName string
// The namespace of the pod that is running this checkpointer.
PodNamespace string
}
CheckpointerPod holds information about this checkpointer pod.
type Options ¶
type Options struct {
// CheckpointerPod holds information about this checkpointer pod.
CheckpointerPod CheckpointerPod
// KubeConfig is a valid kubeconfig for communicating with the APIServer.
KubeConfig *restclient.Config
// RemoteRuntimeEndpoint is the location of the CRI GRPC endpoint.
RemoteRuntimeEndpoint string
// RuntimeRequestTimeout is the timeout that is used for requests to the RemoteRuntimeEndpoint.
RuntimeRequestTimeout time.Duration
// CheckpointGracePeriod is the timeout that is used for cleaning up checkpoints when the parent
// pod is deleted.
CheckpointGracePeriod time.Duration
}
Options defines the parameters that are required to start the checkpointer.
Source Files
Click to show internal directories.
Click to hide internal directories.