https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/Recent content in Developer guide on etcdHugoen-ushttps://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/discovery_protocol/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/discovery_protocol/<p>Discovery service protocol helps new etcd member to discover all other members in cluster bootstrap phase using a shared discovery URL.</p> <p>Discovery service protocol is <em>only</em> used in cluster bootstrap phase, and cannot be used for runtime reconfiguration or cluster monitoring.</p> <p>The protocol uses a new discovery token to bootstrap one <em>unique</em> etcd cluster. Remember that one discovery token can represent only one etcd cluster. As long as discovery protocol on this token starts, even if it fails halfway, it must not be used to bootstrap another etcd cluster.</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/local_cluster/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/local_cluster/<p>For testing and development deployments, the quickest and easiest way is to configure a local cluster. For a production deployment, refer to the <a href="../../op-guide/clustering/">clustering</a> section.</p> <h2 id="local-standalone-cluster">Local standalone cluster</h2> <h3 id="starting-a-cluster">Starting a cluster</h3> <p>Run the following to deploy an etcd cluster as a standalone cluster:</p> <pre tabindex="0"><code>$ ./etcd ... </code></pre><p>If the <code>etcd</code> binary is not present in the current working directory, it might be located either at <code>$GOPATH/bin/etcd</code> or at <code>/usr/local/bin/etcd</code>. Run the command appropriately.</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/interacting_v3/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/interacting_v3/<p>Users mostly interact with etcd by putting or getting the value of a key. This section describes how to do that by using etcdctl, a command line tool for interacting with etcd server. The concepts described here should apply to the gRPC APIs or client library APIs.</p> <p>The API version used by etcdctl to speak to etcd may be set to version <code>2</code> or <code>3</code> via the <code>ETCDCTL_API</code> environment variable. By default, etcdctl on master (3.4) uses the v3 API and earlier versions (3.3 and earlier) default to the v2 API.</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/api_grpc_gateway/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/api_grpc_gateway/<p>etcd v3 uses <a href="https://www.grpc.io/" target="_blank" rel="noopener">gRPC</a> for its messaging protocol. The etcd project includes a gRPC-based <a href="https://github.com/etcd-io/etcd/tree/main/client/v3" target="_blank" rel="noopener">Go client</a> and a command line utility, <a href="https://github.com/etcd-io/etcd/tree/main/etcdctl" target="_blank" rel="noopener">etcdctl</a>, for communicating with an etcd cluster through gRPC. For languages with no gRPC support, etcd provides a JSON <a href="https://github.com/grpc-ecosystem/grpc-gateway" target="_blank" rel="noopener">gRPC gateway</a>. This gateway serves a RESTful proxy that translates HTTP/JSON requests into gRPC messages.</p> <h2 id="using-grpc-gateway">Using gRPC gateway</h2> <p>The gateway accepts a <a href="https://developers.google.com/protocol-buffers/docs/proto3#json" target="_blank" rel="noopener">JSON mapping</a> for etcd&rsquo;s <a href="../api_reference_v3/">protocol buffer</a> message definitions. Note that <code>key</code> and <code>value</code> fields are defined as byte arrays and therefore must be base64 encoded in JSON. The following examples use <code>curl</code>, but any HTTP/JSON client should work all the same.</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/grpc_naming/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/grpc_naming/<p>etcd provides a gRPC resolver to support an alternative name system that fetches endpoints from etcd for discovering gRPC services. The underlying mechanism is based on watching updates to keys prefixed with the service name.</p> <p>Note that this feature is experimental because it depends on the <a href="https://github.com/grpc/grpc-go/tree/4cedec40eb2ccfbe3f56bb15e894903111ada2d2/resolver" target="_blank" rel="noopener">google.golang.org/grpc/resolver</a> package, which is still experimental in grpc-go.</p> <h2 id="using-etcd-discovery-with-go-grpc">Using etcd discovery with go-grpc</h2> <p>The etcd client provides a gRPC resolver for resolving gRPC endpoints with an etcd backend. The resolver is initialized with an etcd client:</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/golang_embed_pkg/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/golang_embed_pkg/<p>The etcd <code>embed</code> go package provides a simple way to embed an etcd server directly into your application.</p> <p>For more details, see the <a href="https://pkg.go.dev/go.etcd.io/etcd/server/v3/embed" target="_blank" rel="noopener">embed package documentation</a>.</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/limit/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/limit/<h2 id="request-size-limit">Request size limit</h2> <p>etcd is designed to handle small key value pairs typical for metadata. Larger requests will work, but may increase the latency of other requests. By default, the maximum size of any request is 1.5 MiB. This limit is configurable through <code>--max-request-bytes</code> flag for etcd server.</p> <h2 id="storage-size-limit">Storage size limit</h2> <p>The default storage size limit is 2 GiB, configurable with <code>--quota-backend-bytes</code> flag. 8 GiB is a suggested maximum size for normal environments and etcd warns at startup if the configured value exceeds it.</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/features/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/features/<p>This document provides an overview of etcd features to help users better understand the features and related deprecation process. If you are interested in knowing about how features are developed in the etcd, please see these <a href="https://github.com/etcd-io/etcd/blob/main/Documentation/contributor-guide/features.md" target="_blank" rel="noopener">development guidelines</a>.</p> <p>The etcd features fall into three stages, experimental, stable, and unsafe. You can get the list of features by running <code>etcd --help</code>.</p> <h2 id="experimental">Experimental</h2> <p>In order to get early feedback, any new feature is usually added as an experimental feature. The experimental feature can be identified by looking at the flag name, which should have <code>--experimental</code> as a prefix. Please consider the following points while using an experimental feature:</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/api_reference_v3/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/api_reference_v3/<p>This API reference is autogenerated from the named <code>.proto</code> files.</p> <h5 id="service-auth-apietcdserverpbrpcproto">service <code>Auth</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Method</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>AuthEnable</td> <td>AuthEnableRequest</td> <td>AuthEnableResponse</td> <td>AuthEnable enables authentication.</td> </tr> <tr> <td>AuthDisable</td> <td>AuthDisableRequest</td> <td>AuthDisableResponse</td> <td>AuthDisable disables authentication.</td> </tr> <tr> <td>AuthStatus</td> <td>AuthStatusRequest</td> <td>AuthStatusResponse</td> <td>AuthStatus displays authentication status.</td> </tr> <tr> <td>Authenticate</td> <td>AuthenticateRequest</td> <td>AuthenticateResponse</td> <td>Authenticate processes an authenticate request.</td> </tr> <tr> <td>UserAdd</td> <td>AuthUserAddRequest</td> <td>AuthUserAddResponse</td> <td>UserAdd adds a new user. User name cannot be empty.</td> </tr> <tr> <td>UserGet</td> <td>AuthUserGetRequest</td> <td>AuthUserGetResponse</td> <td>UserGet gets detailed user information.</td> </tr> <tr> <td>UserList</td> <td>AuthUserListRequest</td> <td>AuthUserListResponse</td> <td>UserList gets a list of all users.</td> </tr> <tr> <td>UserDelete</td> <td>AuthUserDeleteRequest</td> <td>AuthUserDeleteResponse</td> <td>UserDelete deletes a specified user.</td> </tr> <tr> <td>UserChangePassword</td> <td>AuthUserChangePasswordRequest</td> <td>AuthUserChangePasswordResponse</td> <td>UserChangePassword changes the password of a specified user.</td> </tr> <tr> <td>UserGrantRole</td> <td>AuthUserGrantRoleRequest</td> <td>AuthUserGrantRoleResponse</td> <td>UserGrant grants a role to a specified user.</td> </tr> <tr> <td>UserRevokeRole</td> <td>AuthUserRevokeRoleRequest</td> <td>AuthUserRevokeRoleResponse</td> <td>UserRevokeRole revokes a role of specified user.</td> </tr> <tr> <td>RoleAdd</td> <td>AuthRoleAddRequest</td> <td>AuthRoleAddResponse</td> <td>RoleAdd adds a new role. Role name cannot be empty.</td> </tr> <tr> <td>RoleGet</td> <td>AuthRoleGetRequest</td> <td>AuthRoleGetResponse</td> <td>RoleGet gets detailed role information.</td> </tr> <tr> <td>RoleList</td> <td>AuthRoleListRequest</td> <td>AuthRoleListResponse</td> <td>RoleList gets lists of all roles.</td> </tr> <tr> <td>RoleDelete</td> <td>AuthRoleDeleteRequest</td> <td>AuthRoleDeleteResponse</td> <td>RoleDelete deletes a specified role.</td> </tr> <tr> <td>RoleGrantPermission</td> <td>AuthRoleGrantPermissionRequest</td> <td>AuthRoleGrantPermissionResponse</td> <td>RoleGrantPermission grants a permission of a specified key or range to a specified role.</td> </tr> <tr> <td>RoleRevokePermission</td> <td>AuthRoleRevokePermissionRequest</td> <td>AuthRoleRevokePermissionResponse</td> <td>RoleRevokePermission revokes a key or range permission of a specified role.</td> </tr> </tbody> </table> <h5 id="service-cluster-apietcdserverpbrpcproto">service <code>Cluster</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Method</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>MemberAdd</td> <td>MemberAddRequest</td> <td>MemberAddResponse</td> <td>MemberAdd adds a member into the cluster.</td> </tr> <tr> <td>MemberRemove</td> <td>MemberRemoveRequest</td> <td>MemberRemoveResponse</td> <td>MemberRemove removes an existing member from the cluster.</td> </tr> <tr> <td>MemberUpdate</td> <td>MemberUpdateRequest</td> <td>MemberUpdateResponse</td> <td>MemberUpdate updates the member configuration.</td> </tr> <tr> <td>MemberList</td> <td>MemberListRequest</td> <td>MemberListResponse</td> <td>MemberList lists all the members in the cluster.</td> </tr> <tr> <td>MemberPromote</td> <td>MemberPromoteRequest</td> <td>MemberPromoteResponse</td> <td>MemberPromote promotes a member from raft learner (non-voting) to raft voting member.</td> </tr> </tbody> </table> <h5 id="service-kv-apietcdserverpbrpcproto">service <code>KV</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Method</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Range</td> <td>RangeRequest</td> <td>RangeResponse</td> <td>Range gets the keys in the range from the key-value store.</td> </tr> <tr> <td>Put</td> <td>PutRequest</td> <td>PutResponse</td> <td>Put puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.</td> </tr> <tr> <td>DeleteRange</td> <td>DeleteRangeRequest</td> <td>DeleteRangeResponse</td> <td>DeleteRange deletes the given range from the key-value store. A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.</td> </tr> <tr> <td>Txn</td> <td>TxnRequest</td> <td>TxnResponse</td> <td>Txn processes multiple requests in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.</td> </tr> <tr> <td>Compact</td> <td>CompactionRequest</td> <td>CompactionResponse</td> <td>Compact compacts the event history in the etcd key-value store. The key-value store should be periodically compacted or the event history will continue to grow indefinitely.</td> </tr> </tbody> </table> <h5 id="service-lease-apietcdserverpbrpcproto">service <code>Lease</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Method</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>LeaseGrant</td> <td>LeaseGrantRequest</td> <td>LeaseGrantResponse</td> <td>LeaseGrant creates a lease which expires if the server does not receive a keepAlive within a given time to live period. All keys attached to the lease will be expired and deleted if the lease expires. Each expired key generates a delete event in the event history.</td> </tr> <tr> <td>LeaseRevoke</td> <td>LeaseRevokeRequest</td> <td>LeaseRevokeResponse</td> <td>LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.</td> </tr> <tr> <td>LeaseKeepAlive</td> <td>LeaseKeepAliveRequest</td> <td>LeaseKeepAliveResponse</td> <td>LeaseKeepAlive keeps the lease alive by streaming keep alive requests from the client to the server and streaming keep alive responses from the server to the client.</td> </tr> <tr> <td>LeaseTimeToLive</td> <td>LeaseTimeToLiveRequest</td> <td>LeaseTimeToLiveResponse</td> <td>LeaseTimeToLive retrieves lease information.</td> </tr> <tr> <td>LeaseLeases</td> <td>LeaseLeasesRequest</td> <td>LeaseLeasesResponse</td> <td>LeaseLeases lists all existing leases.</td> </tr> </tbody> </table> <h5 id="service-maintenance-apietcdserverpbrpcproto">service <code>Maintenance</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Method</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Alarm</td> <td>AlarmRequest</td> <td>AlarmResponse</td> <td>Alarm activates, deactivates, and queries alarms regarding cluster health.</td> </tr> <tr> <td>Status</td> <td>StatusRequest</td> <td>StatusResponse</td> <td>Status gets the status of the member.</td> </tr> <tr> <td>Defragment</td> <td>DefragmentRequest</td> <td>DefragmentResponse</td> <td>Defragment defragments a member&rsquo;s backend database to recover storage space.</td> </tr> <tr> <td>Hash</td> <td>HashRequest</td> <td>HashResponse</td> <td>Hash computes the hash of whole backend keyspace, including key, lease, and other buckets in storage. This is designed for testing ONLY! Do not rely on this in production with ongoing transactions, since Hash operation does not hold MVCC locks. Use &ldquo;HashKV&rdquo; API instead for &ldquo;key&rdquo; bucket consistency checks.</td> </tr> <tr> <td>HashKV</td> <td>HashKVRequest</td> <td>HashKVResponse</td> <td>HashKV computes the hash of all MVCC keys up to a given revision. It only iterates &ldquo;key&rdquo; bucket in backend storage.</td> </tr> <tr> <td>Snapshot</td> <td>SnapshotRequest</td> <td>SnapshotResponse</td> <td>Snapshot sends a snapshot of the entire backend from a member over a stream to a client.</td> </tr> <tr> <td>MoveLeader</td> <td>MoveLeaderRequest</td> <td>MoveLeaderResponse</td> <td>MoveLeader requests current leader node to transfer its leadership to transferee.</td> </tr> <tr> <td>Downgrade</td> <td>DowngradeRequest</td> <td>DowngradeResponse</td> <td>Downgrade requests downgrades, verifies feasibility or cancels downgrade on the cluster version. Supported since etcd 3.5.</td> </tr> </tbody> </table> <h5 id="service-watch-apietcdserverpbrpcproto">service <code>Watch</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Method</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Watch</td> <td>WatchRequest</td> <td>WatchResponse</td> <td>Watch watches for events happening or that have happened. Both input and output are streams; the input stream is for creating and canceling watchers and the output stream sends events. One watch RPC can watch on multiple key ranges, streaming events for several watches at once. The entire event history can be watched starting from the last compaction revision.</td> </tr> </tbody> </table> <h5 id="message-alarmmember-apietcdserverpbrpcproto">message <code>AlarmMember</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>memberID</td> <td>memberID is the ID of the member associated with the raised alarm.</td> <td>uint64</td> </tr> <tr> <td>alarm</td> <td>alarm is the type of alarm which has been raised.</td> <td>AlarmType</td> </tr> </tbody> </table> <h5 id="message-alarmrequest-apietcdserverpbrpcproto">message <code>AlarmRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>action</td> <td>action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm.</td> <td>AlarmAction</td> </tr> <tr> <td>memberID</td> <td>memberID is the ID of the member associated with the alarm. If memberID is 0, the alarm request covers all members.</td> <td>uint64</td> </tr> <tr> <td>alarm</td> <td>alarm is the type of alarm to consider for this request.</td> <td>AlarmType</td> </tr> </tbody> </table> <h5 id="message-alarmresponse-apietcdserverpbrpcproto">message <code>AlarmResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>alarms</td> <td>alarms is a list of alarms associated with the alarm request.</td> <td>(slice of) AlarmMember</td> </tr> </tbody> </table> <h5 id="message-authdisablerequest-apietcdserverpbrpcproto">message <code>AuthDisableRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> <h5 id="message-authdisableresponse-apietcdserverpbrpcproto">message <code>AuthDisableResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authenablerequest-apietcdserverpbrpcproto">message <code>AuthEnableRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> <h5 id="message-authenableresponse-apietcdserverpbrpcproto">message <code>AuthEnableResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authroleaddrequest-apietcdserverpbrpcproto">message <code>AuthRoleAddRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name is the name of the role to add to the authentication system.</td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authroleaddresponse-apietcdserverpbrpcproto">message <code>AuthRoleAddResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authroledeleterequest-apietcdserverpbrpcproto">message <code>AuthRoleDeleteRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authroledeleteresponse-apietcdserverpbrpcproto">message <code>AuthRoleDeleteResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authrolegetrequest-apietcdserverpbrpcproto">message <code>AuthRoleGetRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authrolegetresponse-apietcdserverpbrpcproto">message <code>AuthRoleGetResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>perm</td> <td></td> <td>(slice of) authpb.Permission</td> </tr> </tbody> </table> <h5 id="message-authrolegrantpermissionrequest-apietcdserverpbrpcproto">message <code>AuthRoleGrantPermissionRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name is the name of the role which will be granted the permission.</td> <td>string</td> </tr> <tr> <td>perm</td> <td>perm is the permission to grant to the role.</td> <td>authpb.Permission</td> </tr> </tbody> </table> <h5 id="message-authrolegrantpermissionresponse-apietcdserverpbrpcproto">message <code>AuthRoleGrantPermissionResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authrolelistrequest-apietcdserverpbrpcproto">message <code>AuthRoleListRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> <h5 id="message-authrolelistresponse-apietcdserverpbrpcproto">message <code>AuthRoleListResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>roles</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> <h5 id="message-authrolerevokepermissionrequest-apietcdserverpbrpcproto">message <code>AuthRoleRevokePermissionRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> <tr> <td>key</td> <td></td> <td>bytes</td> </tr> <tr> <td>range_end</td> <td></td> <td>bytes</td> </tr> </tbody> </table> <h5 id="message-authrolerevokepermissionresponse-apietcdserverpbrpcproto">message <code>AuthRoleRevokePermissionResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authstatusrequest-apietcdserverpbrpcproto">message <code>AuthStatusRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> <h5 id="message-authstatusresponse-apietcdserverpbrpcproto">message <code>AuthStatusResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>enabled</td> <td></td> <td>bool</td> </tr> <tr> <td>authRevision</td> <td>authRevision is the current revision of auth store</td> <td>uint64</td> </tr> </tbody> </table> <h5 id="message-authuseraddrequest-apietcdserverpbrpcproto">message <code>AuthUserAddRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>password</td> <td></td> <td>string</td> </tr> <tr> <td>options</td> <td></td> <td>authpb.UserAddOptions</td> </tr> <tr> <td>hashedPassword</td> <td></td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authuseraddresponse-apietcdserverpbrpcproto">message <code>AuthUserAddResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authuserchangepasswordrequest-apietcdserverpbrpcproto">message <code>AuthUserChangePasswordRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name is the name of the user whose password is being changed.</td> <td>string</td> </tr> <tr> <td>password</td> <td>password is the new password for the user. Note that this field will be removed in the API layer.</td> <td>string</td> </tr> <tr> <td>hashedPassword</td> <td>hashedPassword is the new password for the user. Note that this field will be initialized in the API layer.</td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authuserchangepasswordresponse-apietcdserverpbrpcproto">message <code>AuthUserChangePasswordResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authuserdeleterequest-apietcdserverpbrpcproto">message <code>AuthUserDeleteRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name is the name of the user to delete.</td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authuserdeleteresponse-apietcdserverpbrpcproto">message <code>AuthUserDeleteResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authusergetrequest-apietcdserverpbrpcproto">message <code>AuthUserGetRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authusergetresponse-apietcdserverpbrpcproto">message <code>AuthUserGetResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>roles</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> <h5 id="message-authusergrantrolerequest-apietcdserverpbrpcproto">message <code>AuthUserGrantRoleRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>user</td> <td>user is the name of the user which should be granted a given role.</td> <td>string</td> </tr> <tr> <td>role</td> <td>role is the name of the role to grant to the user.</td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authusergrantroleresponse-apietcdserverpbrpcproto">message <code>AuthUserGrantRoleResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authuserlistrequest-apietcdserverpbrpcproto">message <code>AuthUserListRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> <h5 id="message-authuserlistresponse-apietcdserverpbrpcproto">message <code>AuthUserListResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>users</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> <h5 id="message-authuserrevokerolerequest-apietcdserverpbrpcproto">message <code>AuthUserRevokeRoleRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authuserrevokeroleresponse-apietcdserverpbrpcproto">message <code>AuthUserRevokeRoleResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> <h5 id="message-authenticaterequest-apietcdserverpbrpcproto">message <code>AuthenticateRequest</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>password</td> <td></td> <td>string</td> </tr> </tbody> </table> <h5 id="message-authenticateresponse-apietcdserverpbrpcproto">message <code>AuthenticateResponse</code> (api/etcdserverpb/rpc.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>token</td> <td>token is an authorized token that can be used in succeeding RPCs</td> <td>string</td> </tr> </tbody> </table> <h5 id="message-compactionrequest-apietcdserverpbrpcproto">message <code>CompactionRequest</code> (api/etcdserverpb/rpc.proto)</h5> <p>CompactionRequest compacts the key-value store up to a given revision. All superseded keys with a revision less than the compaction revision will be removed.</p>https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/api_concurrency_reference_v3/Mon, 01 Jan 0001 00:00:00 +0000https://deploy-preview-1113--etcd.netlify.app/docs/v3.6/dev-guide/api_concurrency_reference_v3/<p>This API reference is autogenerated from the named <code>.proto</code> files.</p> <h5 id="service-lock-serveretcdserverapiv3lockv3lockpbv3lockproto">service <code>Lock</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)</h5> <p>The lock service exposes client-side locking facilities as a gRPC interface.</p> <table> <thead> <tr> <th>Method</th> <th>Request Type</th> <th>Response Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Lock</td> <td>LockRequest</td> <td>LockResponse</td> <td>Lock acquires a distributed shared lock on a given named lock. On success, it will return a unique key that exists so long as the lock is held by the caller. This key can be used in conjunction with transactions to safely ensure updates to etcd only occur while holding lock ownership. The lock is held until Unlock is called on the key or the lease associate with the owner expires.</td> </tr> <tr> <td>Unlock</td> <td>UnlockRequest</td> <td>UnlockResponse</td> <td>Unlock takes a key returned by Lock and releases the hold on lock. The next Lock caller waiting for the lock will then be woken up and given ownership of the lock.</td> </tr> </tbody> </table> <h5 id="message-lockrequest-serveretcdserverapiv3lockv3lockpbv3lockproto">message <code>LockRequest</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>name is the identifier for the distributed shared lock to be acquired.</td> <td>bytes</td> </tr> <tr> <td>lease</td> <td>lease is the ID of the lease that will be attached to ownership of the lock. If the lease expires or is revoked and currently holds the lock, the lock is automatically released. Calls to Lock with the same lease will be treated as a single acquisition; locking twice with the same lease is a no-op.</td> <td>int64</td> </tr> </tbody> </table> <h5 id="message-lockresponse-serveretcdserverapiv3lockv3lockpbv3lockproto">message <code>LockResponse</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>etcdserverpb.ResponseHeader</td> </tr> <tr> <td>key</td> <td>key is a key that will exist on etcd for the duration that the Lock caller owns the lock. Users should not modify this key or the lock may exhibit undefined behavior.</td> <td>bytes</td> </tr> </tbody> </table> <h5 id="message-unlockrequest-serveretcdserverapiv3lockv3lockpbv3lockproto">message <code>UnlockRequest</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>key is the lock ownership key granted by Lock.</td> <td>bytes</td> </tr> </tbody> </table> <h5 id="message-unlockresponse-serveretcdserverapiv3lockv3lockpbv3lockproto">message <code>UnlockResponse</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto)</h5> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>etcdserverpb.ResponseHeader</td> </tr> </tbody> </table> <h5 id="service-election-serveretcdserverapiv3electionv3electionpbv3electionproto">service <code>Election</code> (server/etcdserver/api/v3election/v3electionpb/v3election.proto)</h5> <p>The election service exposes client-side election facilities as a gRPC interface.</p>