Documentation
¶
Overview ¶
Package api manages the capabilities and features that are exposed to clients by the etcd cluster.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EnableCapability ¶
func EnableCapability(c Capability)
func IsCapabilityEnabled ¶
func IsCapabilityEnabled(c Capability) bool
Types ¶
type Capability ¶
type Capability string
const ( AuthCapability Capability = "auth" V3rpcCapability Capability = "v3rpc" )
type Cluster ¶
type Cluster interface {
// ID returns the cluster ID
ID() types.ID
// ClientURLs returns an aggregate set of all URLs on which this
// cluster is listening for client requests
ClientURLs() []string
// Members returns a slice of members sorted by their ID
Members() []*membership.Member
// Member retrieves a particular member based on ID, or nil if the
// member does not exist in the cluster
Member(id types.ID) *membership.Member
// Version is the cluster-wide minimum major.minor version.
Version() *semver.Version
}
Cluster is an interface representing a collection of members in one etcd cluster.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package etcdhttp implements HTTP transportation layer for etcdserver.
|
Package etcdhttp implements HTTP transportation layer for etcdserver. |
|
Package membership describes individual etcd members and clusters of members.
|
Package membership describes individual etcd members and clusters of members. |
|
membershippb
Package membershippb is a generated protocol buffer package.
|
Package membershippb is a generated protocol buffer package. |
|
Package rafthttp implements HTTP transportation layer for etcd/raft pkg.
|
Package rafthttp implements HTTP transportation layer for etcd/raft pkg. |
|
Package snap handles Raft nodes' states with snapshots.
|
Package snap handles Raft nodes' states with snapshots. |
|
snappb
Package snappb is a generated protocol buffer package.
|
Package snappb is a generated protocol buffer package. |
|
Package v2auth implements etcd authentication.
|
Package v2auth implements etcd authentication. |
|
Package v2discovery provides an implementation of the cluster discovery that is used by etcd with v2 client.
|
Package v2discovery provides an implementation of the cluster discovery that is used by etcd with v2 client. |
|
Package v2error describes errors in etcd project.
|
Package v2error describes errors in etcd project. |
|
Package v2http provides etcd client and server implementations.
|
Package v2http provides etcd client and server implementations. |
|
httptypes
Package httptypes defines how etcd's HTTP API entities are serialized to and deserialized from JSON.
|
Package httptypes defines how etcd's HTTP API entities are serialized to and deserialized from JSON. |
|
Package v2stats defines a standard interface for etcd cluster statistics.
|
Package v2stats defines a standard interface for etcd cluster statistics. |
|
Package v2store defines etcd's in-memory key/value store in v2 API.
|
Package v2store defines etcd's in-memory key/value store in v2 API. |
|
Package v2v3 provides a ServerV2 implementation backed by clientv3.Client.
|
Package v2v3 provides a ServerV2 implementation backed by clientv3.Client. |
|
Package v3alarm manages health status alarms in etcd.
|
Package v3alarm manages health status alarms in etcd. |
|
Package v3client provides clientv3 interfaces from an etcdserver.
|
Package v3client provides clientv3 interfaces from an etcdserver. |
|
Package v3compactor implements automated policies for compacting etcd's mvcc storage.
|
Package v3compactor implements automated policies for compacting etcd's mvcc storage. |
|
Package v3election provides a v3 election service from an etcdserver.
|
Package v3election provides a v3 election service from an etcdserver. |
|
v3electionpb
Package v3electionpb is a generated protocol buffer package.
|
Package v3electionpb is a generated protocol buffer package. |
|
v3electionpb/gw
Package v3electionpb is a reverse proxy.
|
Package v3electionpb is a reverse proxy. |
|
Package v3lock provides a v3 locking service from an etcdserver.
|
Package v3lock provides a v3 locking service from an etcdserver. |
|
v3lockpb
Package v3lockpb is a generated protocol buffer package.
|
Package v3lockpb is a generated protocol buffer package. |
|
v3lockpb/gw
Package v3lockpb is a reverse proxy.
|
Package v3lockpb is a reverse proxy. |
|
Package v3rpc implements etcd v3 RPC system based on gRPC.
|
Package v3rpc implements etcd v3 RPC system based on gRPC. |
|
rpctypes
Package rpctypes has types and values shared by the etcd server and client for v3 RPC interaction.
|
Package rpctypes has types and values shared by the etcd server and client for v3 RPC interaction. |
Click to show internal directories.
Click to hide internal directories.