Documentation ¶
Index ¶
- Variables
- func GetAPIServerURLsFromETCD(ctx context.Context, cfg *config.Control) ([]string, error)
- type ETCD
- func (e *ETCD) DeleteSnapshots(ctx context.Context, snapshots []string) error
- func (e *ETCD) EndpointName() string
- func (e *ETCD) GetMembersClientURLs(ctx context.Context) ([]string, error)
- func (e *ETCD) GetMembersNames(ctx context.Context) ([]string, error)
- func (e *ETCD) IsInitialized() (bool, error)
- func (e *ETCD) IsReset() (bool, error)
- func (e *ETCD) ListSnapshots(ctx context.Context) (map[string]snapshotFile, error)
- func (e *ETCD) PruneSnapshots(ctx context.Context) error
- func (e *ETCD) ReconcileSnapshotData(ctx context.Context) error
- func (e *ETCD) Register(handler http.Handler) (http.Handler, error)
- func (e *ETCD) RemovePeer(ctx context.Context, name, address string, allowSelfRemoval bool) error
- func (e *ETCD) RemoveSelf(ctx context.Context) error
- func (e *ETCD) Reset(ctx context.Context, rebootstrap func() error) error
- func (e *ETCD) ResetFile() string
- func (e *ETCD) Restore(ctx context.Context) error
- func (e *ETCD) SetControlConfig(config *config.Control) error
- func (e *ETCD) Snapshot(ctx context.Context) error
- func (e *ETCD) Start(ctx context.Context, clientAccessInfo *clientaccess.Info) error
- func (e *ETCD) StartEmbeddedTemporary(ctx context.Context) error
- func (e *ETCD) Test(ctx context.Context) error
- type MemberStatus
- type Members
- type MembershipError
- type NodeControllerGetter
- type Proxy
- type S3
Constants ¶
This section is empty.
Variables ¶
var ( // AddressKey will contain the value of api addresses list AddressKey = version.Program + "/apiaddresses" NodeNameAnnotation = "etcd." + version.Program + ".cattle.io/node-name" NodeAddressAnnotation = "etcd." + version.Program + ".cattle.io/node-address" ErrAddressNotSet = errors.New("apiserver addresses not yet set") ErrNotMember = errNotMember() )
Functions ¶
Types ¶
type ETCD ¶
type ETCD struct {
// contains filtered or unexported fields
}
func NewETCD ¶
func NewETCD() *ETCD
NewETCD creates a new value of type ETCD with an initialized cron value.
func (*ETCD) DeleteSnapshots ¶
DeleteSnapshots removes the given snapshots from local storage and S3.
func (*ETCD) EndpointName ¶
EndpointName returns the name of the endpoint.
func (*ETCD) GetMembersClientURLs ¶
GetMembersClientURLs will list through the member lists in etcd and return back a combined list of client urls for each member in the cluster
func (*ETCD) GetMembersNames ¶
GetMembersNames will list through the member lists in etcd and return back a combined list of member names
func (*ETCD) IsInitialized ¶
IsInitialized checks to see if a WAL directory exists. If so, we assume that etcd has already been brought up at least once.
func (*ETCD) IsReset ¶
IsReset checks to see if the reset file exists, indicating that a cluster-reset has been completed successfully.
func (*ETCD) ListSnapshots ¶
ListSnapshots is an exported wrapper method that wraps an unexported method of the same name.
func (*ETCD) PruneSnapshots ¶
PruneSnapshots performs a retention run with the given retention duration and removes expired snapshots.
func (*ETCD) ReconcileSnapshotData ¶
ReconcileSnapshotData reconciles snapshot data in the ETCDSnapshotFile resources. It will reconcile snapshot data from disk locally always, and if S3 is enabled, will attempt to list S3 snapshots and reconcile snapshots from S3.
func (*ETCD) Register ¶
Register adds db info routes for the http request handler, and registers cluster controller callbacks
func (*ETCD) RemovePeer ¶
RemovePeer removes a peer from the cluster. The peer name and IP address must both match.
func (*ETCD) RemoveSelf ¶
RemoveSelf will remove the member if it exists in the cluster. This should only be called on a node that may have previously run etcd, but will not currently run etcd, to ensure that it is not a member of the cluster. This is also called by tests to do cleanup between runs.
func (*ETCD) Restore ¶
Restore performs a restore of the ETCD datastore from the given snapshot path. This operation exists upon completion.
func (*ETCD) SetControlConfig ¶
SetControlConfig passes the cluster config into the etcd datastore. This is necessary because the config may not yet be fully built at the time the Driver instance is registered.
func (*ETCD) Snapshot ¶
Snapshot attempts to save a new snapshot to the configured directory, and then clean up any old and failed snapshots in excess of the retention limits. This method is used in the internal cron snapshot system as well as used to do on-demand snapshots.
func (*ETCD) StartEmbeddedTemporary ¶
func (*ETCD) Test ¶
Test ensures that the local node is a voting member of the target cluster, and that the datastore is defragmented and not in maintenance mode due to alarms. If it is still a learner or not a part of the cluster, an error is raised. If it cannot be defragmented or has any alarms that cannot be disarmed, an error is raised.
type MemberStatus ¶
type MemberStatus string
const ( StatusUnjoined MemberStatus = "unjoined" StatusUnhealthy MemberStatus = "unhealthy" StatusLearner MemberStatus = "learner" StatusVoter MemberStatus = "voter" )
type Members ¶
type Members struct {
Members []*etcdserverpb.Member `json:"members"`
}
Members contains a slice that holds all members of the cluster.
func ClientURLs ¶
func ClientURLs(ctx context.Context, clientAccessInfo *clientaccess.Info, selfIP string) ([]string, Members, error)
clientURLs returns a list of all non-learner etcd cluster member client access URLs. The list is retrieved from the remote server that is being joined.
type MembershipError ¶
func (*MembershipError) Error ¶
func (e *MembershipError) Error() string
func (*MembershipError) Is ¶
func (e *MembershipError) Is(target error) bool
type NodeControllerGetter ¶
type NodeControllerGetter func() controllerv1.NodeController