-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
288 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # See the OWNERS docs at https://go.k8s.io/owners | ||
|
|
||
| reviewers: | ||
| - sig-etcd-leads | ||
| approvers: | ||
| - sig-etcd-leads | ||
| labels: | ||
| - sig/etcd |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| <!--- | ||
| This is an autogenerated file! | ||
| Please do not edit this file directly, but instead make changes to the | ||
| sigs.yaml file in the project root. | ||
| To understand how this file is generated, see https://git.k8s.io/community/generator/README.md | ||
| ---> | ||
| # etcd Special Interest Group | ||
|
|
||
| TBD | ||
|
|
||
| The [charter](charter.md) defines the scope and governance of the etcd Special Interest Group. | ||
|
|
||
| ## Meetings | ||
| *Joining the [mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-etcd) for the group will typically add invites for the following meetings to your calendar.* | ||
| * Regular SIG Meeting: [Thursdays at 9:30 PT (Pacific Time)](TBD) (biweekly). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=9:30&tz=PT%20%28Pacific%20Time%29). | ||
| * [Meeting notes and Agenda](TBD). | ||
|
|
||
| ## Leadership | ||
|
|
||
| ### Chairs | ||
| The Chairs of the SIG run operations and processes governing the SIG. | ||
|
|
||
| * Benjamin Wang (**[@ahrtr](https://github.com/ahrtr)**), VMWare | ||
| * Marek Siarkowicz (**[@serathius](https://github.com/serathius)**), Google | ||
|
|
||
| ### Technical Leads | ||
| The Technical Leads of the SIG establish new subprojects, decommission existing | ||
| subprojects, and resolve cross-subproject technical issues and decisions. | ||
|
|
||
| * Benjamin Wang (**[@ahrtr](https://github.com/ahrtr)**), VMWare | ||
| * Marek Siarkowicz (**[@serathius](https://github.com/serathius)**), Google | ||
|
|
||
| ## Contact | ||
| - Slack: [#sig-etcd](https://kubernetes.slack.com/messages/sig-etcd) | ||
| - [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-etcd) | ||
| - [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/sig%2Fetcd) | ||
| - GitHub Teams: | ||
| - [@kubernetes/sig-etcd-approvers](https://github.com/orgs/kubernetes/teams/sig-etcd-approvers) - SIG Top-level Approvers | ||
| - [@kubernetes/sig-etcd-leads](https://github.com/orgs/kubernetes/teams/sig-etcd-leads) - SIG Chairs and Tech Leads | ||
| - [@kubernetes/sig-etcd-members](https://github.com/orgs/kubernetes/teams/sig-etcd-members) - SIG Membership Roster | ||
| - Steering Committee Liaison: TBD (**[@TBD](https://github.com/TBD)**) | ||
|
|
||
| ## Subprojects | ||
|
|
||
| The following [subprojects][subproject-definition] are owned by sig-etcd: | ||
| ### etcd | ||
| - **Owners:** | ||
| - [kubernetes-sigs/TBD](https://github.com/kubernetes-sigs/TBD/blob/master/OWNERS) | ||
|
|
||
| [subproject-definition]: https://github.com/kubernetes/community/blob/master/governance.md#subprojects | ||
| [working-group-definition]: https://github.com/kubernetes/community/blob/master/governance.md#working-groups | ||
| <!-- BEGIN CUSTOM CONTENT --> | ||
|
|
||
| <!-- END CUSTOM CONTENT --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # SIG etcd Charter | ||
|
|
||
| This charter adheres to the conventions described in the [Kubernetes Charter README] and uses | ||
| the Roles and Organization Management outlined in [sig-governance]. | ||
|
|
||
| [Kubernetes Charter README]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/README.md | ||
| [sig-governance]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance.md | ||
|
|
||
| ## Scope | ||
|
|
||
| Owns the etcd project and how it is used by Kubernetes. | ||
|
|
||
| ### In scope | ||
|
|
||
| #### Code, Binaries and Services | ||
|
|
||
| - Development of [etcd] and other repositories under [etcd-io organization] | ||
| - Maintenance of [etcd image] packaged with Kubernetes | ||
|
|
||
| [etcd]: https://github.com/etcd-io/etcd | ||
| [etcd-io organization]: https://github.com/etcd-io | ||
| [etcd image]: https://github.com/kubernetes/kubernetes/tree/master/cluster/images/etcd | ||
|
|
||
| #### Cross-cutting and Externally Facing Processes | ||
|
|
||
| - Specifying, testing and improving [The Implicit Kubernetes-ETCD Contract] | ||
| - Release process of etcd and other binaries belonging to [etcd-io organization] | ||
|
|
||
| [The Implicit Kubernetes-ETCD Contract]: https://docs.google.com/document/d/1NUZDiJeiIH5vo_FMaTWf0JtrQKCx0kpEaIIuPoj9P6A/edit?usp=sharing | ||
|
|
||
| ### Out of scope | ||
|
|
||
| - Structure of data stored in etcd is owned by SIG API Machinery | ||
|
|
||
| ## Roles and Organization Management | ||
|
|
||
| This SIG follows adheres to the Roles and Organization Management outlined in [sig-governance] | ||
| and opts-in to updates and modifications to [sig-governance]. | ||
|
|
||
| ### Additional responsibilities of Tech Leads | ||
|
|
||
| - Release of etcd and other binaries belonging to [etcd-io organization] | ||
|
|
||
| ### Deviations from [sig-governance] | ||
|
|
||
| - SIG etcd does not participate in release planning meetings, | ||
| retrospectives and burn-down meetings as etcd release process is independent of Kubernetes. | ||
| - SIG etcd communication utilizes pre-existing forums for communication: | ||
| - Email: [etcd-dev](https://groups.google.com/forum/?hl=en#!forum/etcd-dev). | ||
| - Slack: [#etcd](https://kubernetes.slack.com/messages/C3HD8ARJ5/details/) channel on Kubernetes. | ||
| - SIG etcd contributing instructions ([CONTRIBUTING.md]) be defined in etcd project. | ||
| - KEPs created by SIG etcd will not follow Kubernetes release cycle and freezes due. | ||
|
|
||
| Tech Leads must also fulfill all of the responsibilities of the Chair role as outlined in [sig-governance]. | ||
|
|
||
| [CONTRIBUTING.md]: https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md | ||
|
|
||
| ### Deviations from [kubernetes-repositories] | ||
|
|
||
| - SIG etcd repositories live in github.com/etcd-io | ||
| - SIG etcd repositories should (but not must) adopt merge bot, Kubernetes PR commands/bot, OWNERS file. | ||
| - SIG etcd repositories will follow [rules for donated repositories]. | ||
|
|
||
| [kubernetes-repositories]: https://github.com/kubernetes/community/blob/master/github-management/kubernetes-repositories.md#sig-repositories | ||
| [rules for donated repositories]: https://github.com/kubernetes/community/blob/master/github-management/kubernetes-repositories.md#sig-repositories | ||
|
|
||
| ### Subproject Creation | ||
|
|
||
| By SIG Technical Leads |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| # SIG etcd Vision | ||
|
|
||
| The long-term success of the etcd project depends on the following: | ||
| - Etcd the most reliable key-value storage | ||
| - Etcd is simple to operate | ||
| - Etcd is a standalone solution for managing infrastructure | ||
| - Etcd scales beyond Kubernetes dimensions | ||
|
|
||
| The goals and milestones listed here are for future releases. | ||
| The scope of release v3.6 has already been defined and is unlikely to change. | ||
|
|
||
| ## Etcd the most reliable key-value storage | ||
|
|
||
| Reliability remains the most important property of etcd. | ||
| The project cannot allow for another [data inconsistency incident]. | ||
| If we could only pick one thing from the list of goals above, this would be it. | ||
| No matter what features we add in the future, | ||
| they must not diminish etcd's reliability. | ||
| We must establish processes and safeguards to prevent future incidents. | ||
|
|
||
| How? | ||
| - Etcd API guarantees are well understood, documented and tested. | ||
| - Etcd adopts a production readiness review process for new features, similar to Kubernetes one. | ||
| - Robustness tests should cover most of the API and most common failures. | ||
| - New features must have accompanying e2e tests and be covered by robustness tests. | ||
| - Etcd must be able to immediately detect corruption. | ||
| - Etcd must be able to automatically recover from data corruption. | ||
|
|
||
| [data inconsistency incident]: https://github.com/etcd-io/etcd/blob/main/Documentation/postmortems/v3.5-data-inconsistency.md | ||
|
|
||
| ## Etcd is simple to operate | ||
|
|
||
| Etcd should be easy to operate. | ||
| Currently, there are many steps involved in operating etcd, | ||
| and some of these steps require external tools. | ||
| For example, Kubernetes provides tools to [downgrade/upgrade etcd]. | ||
| These tools are not part of the etcd, | ||
| but they are available as part of the Kubernetes distribution of etcd. | ||
|
|
||
| How? | ||
| - Etcd should not require users to run periodic defrag | ||
| - Etcd officially supports live upgrades and downgrades | ||
| - Disaster recovery for Etcd & Kubernetes | ||
| - Reliable cluster membership changes via learners with automated promotion | ||
| - Two node etcd clusters | ||
|
|
||
| ## Etcd is a standalone solution for managing infrastructure | ||
|
|
||
| Kubernetes is not the only way to manage infrastructure. | ||
| It was the first to introduce many concepts that have now become the standard, | ||
| but they are not unique to Kubernetes. | ||
| The most important design principle of Kubernetes, | ||
| the reconciliation protocol, is not something unique to it. | ||
|
|
||
| Reconciliation can be implemented solely on etcd, | ||
| as has been shown by projects like Cillium, | ||
| Calico Typha that support etcd-based control planes. | ||
| The reason why this idea has not propagated further is | ||
| the amount of work that was put into making | ||
| the reconciliation protocol scale in Kubernetes. | ||
| The watch cache is a key part of this scaling, | ||
| and it is not part of the etcd project. | ||
|
|
||
| If etcd provided a Kubernetes-like storage interface | ||
| and primitives for the reconciliation protocol, | ||
| it would be a more viable solution for managing infrastructure. | ||
| This would allow users to build etcd-based control planes that | ||
| could scale to meet the needs of large and complex deployments. | ||
|
|
||
| How? | ||
| - Introduce Kubernetes like storage interface into etcd-client | ||
| - Provide etcd primitives for reconciliation protocol | ||
| - Strip out the Kubernetes watch cache and make it part of the etcd client. | ||
| - Use the watch cache in the client to build an eventually consistent etcd proxy. | ||
|
|
||
| [downgrade/upgrade etcd]: https://github.com/kubernetes/kubernetes/tree/master/cluster/images/etcd | ||
|
|
||
| ## Etcd scales beyond Kubernetes dimensions | ||
|
|
||
| Etcd has proven its scalability by enabling Kubernetes clusters of up to 5,000 nodes. | ||
| However, as the cloud native ecosystem has evolved, new projects have been built on top of Kubernetes. | ||
| These projects, such as [KCP] (a multi-cluster control plane) and [Kueue] (a batch job queuing system), | ||
| have different scalability requirements than pure Kubernetes. | ||
| For example, they need support for larger storage sizes and higher throughput. | ||
|
|
||
| Etcd's strong points are its reliable raft and efficient watch implementation. | ||
| However, its storage capabilities are not as strong. | ||
| To address this, we should look into growing out storage capabilities and making them more flexible depending on the use case. | ||
|
|
||
| How? | ||
| - Well-defined and tested scalability dimensions | ||
| - Increase raft throughput (async and batch proposal handling) | ||
| - Increasing bbolt supported storage size | ||
| - Pluggable storage layer | ||
| - Hybrid clusters with write and read optimized members | ||
|
|
||
|
|
||
| [KCP]: https://cloud.redhat.com/blog/an-introduction-to-kcp | ||
| [Kueue]: https://github.com/kubernetes-sigs/kueue | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.