Skip to content

Commit

Permalink
etcd operator working group
Browse files Browse the repository at this point in the history
Signed-off-by: Benjamin Wang <benjamin.ahrtr@gmail.com>
  • Loading branch information
ahrtr committed May 27, 2024
1 parent 38918f9 commit 8d79f06
Show file tree
Hide file tree
Showing 8 changed files with 154 additions and 0 deletions.
4 changes: 4 additions & 0 deletions OWNERS_ALIASES
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@ aliases:
- johnbelamaric
- klueska
- pohly
wg-etcd-operator-leads:
- ahrtr
- hakman
- jberkus
wg-lts-leads:
- jeremyrickard
- liggitt
Expand Down
1 change: 1 addition & 0 deletions liaisons.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ members will assume one of the departing members groups.
| [WG Batch](wg-batch/README.md) | Bob Killen (**[@mrbobbytables](https://github.com/mrbobbytables)**) |
| [WG Data Protection](wg-data-protection/README.md) | Patrick Ohly (**[@pohly](https://github.com/pohly)**) |
| [WG Device Management](wg-device-management/README.md) | Patrick Ohly (**[@pohly](https://github.com/pohly)**) |
| [WG Etcd Operator](wg-etcd-operator/README.md) | to-be-finalized (**[@to-be-finalized](https://github.com/to-be-finalized)**) |
| [WG LTS](wg-lts/README.md) | Nabarun Pal (**[@palnabarun](https://github.com/palnabarun)**) |
| [WG Policy](wg-policy/README.md) | Patrick Ohly (**[@pohly](https://github.com/pohly)**) |
| [WG Serving](wg-serving/README.md) | Maciej Szulik (**[@soltysh](https://github.com/soltysh)**) |
Expand Down
1 change: 1 addition & 0 deletions sig-cluster-lifecycle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ subprojects, and resolve cross-subproject technical issues and decisions.
## Working Groups

The following [working groups][working-group-definition] are sponsored by sig-cluster-lifecycle:
* [WG Etcd Operator](/wg-etcd-operator)
* [WG LTS](/wg-lts)


Expand Down
6 changes: 6 additions & 0 deletions sig-etcd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ subprojects, and resolve cross-subproject technical issues and decisions.
- [@kubernetes/sig-etcd-leads](https://github.com/orgs/kubernetes/teams/sig-etcd-leads) - SIG Chairs and Tech Leads
- Steering Committee Liaison: Bob Killen (**[@mrbobbytables](https://github.com/mrbobbytables)**)

## Working Groups

The following [working groups][working-group-definition] are sponsored by sig-etcd:
* [WG Etcd Operator](/wg-etcd-operator)


## Subprojects

The following [subprojects][subproject-definition] are owned by sig-etcd:
Expand Down
1 change: 1 addition & 0 deletions sig-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ When the need arises, a [new SIG can be created](sig-wg-lifecycle.md)
|[Batch](wg-batch/README.md)|[batch](https://github.com/kubernetes/kubernetes/labels/wg%2Fbatch)|* Apps<br>* Autoscaling<br>* Node<br>* Scheduling<br>|* [Aldo Culquicondor](https://github.com/alculquicondor), Google<br>* [Marcin Wielgus](https://github.com/mwielgus), Google<br>* [Maciej Szulik](https://github.com/soltysh), Red Hat<br>* [Swati Sehgal](https://github.com/swatisehgal), Red Hat<br>|* [Slack](https://kubernetes.slack.com/messages/wg-batch)<br>* [Mailing List](https://groups.google.com/a/kubernetes.io/g/wg-batch)|* Regular Meeting ([Calendar](https://calendar.google.com/calendar/embed?src=8ulop9k0jfpuo0t7kp8d9ubtj4%40group.calendar.google.com)): [Thursdays (starting February 15th 2024)s at 3PM CET (Central European Time) (monthly)](https://zoom.us/j/98329676612?pwd=c0N2bVV1aTh2VzltckdXSitaZXBKQT09)<br>* Regular Meeting ([Calendar](https://calendar.google.com/calendar/embed?src=8ulop9k0jfpuo0t7kp8d9ubtj4%40group.calendar.google.com)): [Thursdays (starting February 1st 2024)s at 3PM PT (Pacific Time) (monthly)](https://zoom.us/j/98329676612?pwd=c0N2bVV1aTh2VzltckdXSitaZXBKQT09)<br>
|[Data Protection](wg-data-protection/README.md)|[data-protection](https://github.com/kubernetes/kubernetes/labels/wg%2Fdata-protection)|* Apps<br>* Storage<br>|* [Xing Yang](https://github.com/xing-yang), VMware<br>* [Xiangqian Yu](https://github.com/yuxiangqian), Google<br>|* [Slack](https://kubernetes.slack.com/messages/wg-data-protection)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-data-protection)|* Regular WG Meeting: [Wednesdays at 9:00 PT (Pacific Time) (bi-weekly)](https://zoom.us/j/6933410772)<br>
|[Device Management](wg-device-management/README.md)|[device-management](https://github.com/kubernetes/kubernetes/labels/wg%2Fdevice-management)|* Architecture<br>* Autoscaling<br>* Network<br>* Node<br>* Scheduling<br>|* [John Belamaric](https://github.com/johnbelamaric), Google<br>* [Kevin Klues](https://github.com/klueska), NVIDIA<br>* [Patrick Ohly](https://github.com/pohly), Intel<br>|* [Slack](https://kubernetes.slack.com/messages/wg-device-management)<br>* [Mailing List](https://groups.google.com/a/kubernetes.io/g/wg-device-management)|* Regular WG Meeting: [Tuesdays at 8:30 PT (Pacific Time) (biweekly)](TBD)<br>
|[Etcd Operator](wg-etcd-operator/README.md)|[etcd-operator](https://github.com/kubernetes/kubernetes/labels/wg%2Fetcd-operator)|* Cluster Lifecycle<br>* etcd<br>|* [Benjamin Wang](https://github.com/ahrtr), VMWare<br>* [Ciprian Hacman](https://github.com/hakman), Microsoft<br>* [Josh Berkus](https://github.com/jberkus), Red Hat<br>|* [Slack](https://kubernetes.slack.com/messages/wg-etcd-operator [to-be-created])<br>* [Mailing List](provide-a-mailing-list)|* Regular WG Meeting: [TBDs at TBD PT (Pacific Time) (bi-weekly)](provide-a-zoom-link)<br>
|[LTS](wg-lts/README.md)|[lts](https://github.com/kubernetes/kubernetes/labels/wg%2Flts)|* Architecture<br>* Cluster Lifecycle<br>* K8s Infra<br>* Release<br>* Security<br>* Testing<br>|* [Jeremy Rickard](https://github.com/jeremyrickard), Microsoft<br>* [Jordan Liggitt](https://github.com/liggitt), Google<br>* [Micah Hausler](https://github.com/micahhausler), Amazon<br>|* [Slack](https://kubernetes.slack.com/messages/wg-lts)<br>* [Mailing List](https://groups.google.com/a/kubernetes.io/g/wg-lts)|* Regular WG Meeting: [Tuesdays at 07:00 PT (Pacific Time) (biweekly)](https://zoom.us/j/92480197536?pwd=dmtSMGJRQmNYYTIyZkFlQ25JRngrdz09)<br>
|[Policy](wg-policy/README.md)|[policy](https://github.com/kubernetes/kubernetes/labels/wg%2Fpolicy)|* Architecture<br>* Auth<br>* Multicluster<br>* Network<br>* Node<br>* Scheduling<br>* Storage<br>|* [Jim Bugwadia](https://github.com/JimBugwadia), Kyverno/Nirmata<br>* [Poonam Lamba](https://github.com/poonam-lamba), Google<br>* [Andy Suderman](https://github.com/sudermanjr), Fairwinds<br>|* [Slack](https://kubernetes.slack.com/messages/wg-policy)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-wg-policy)|* Regular WG Meeting: [Wednesdays at 8:00 PT (Pacific Time) (semimonthly)](https://zoom.us/j/7375677271)<br>
|[Serving](wg-serving/README.md)|[serving](https://github.com/kubernetes/kubernetes/labels/wg%2Fserving)|* Apps<br>* Architecture<br>* Autoscaling<br>* Instrumentation<br>* Network<br>* Node<br>* Scheduling<br>* Storage<br>|* [Eduardo Arango](https://github.com/ArangoGutierrez), NVIDIA<br>* [Jiaxin Shan](https://github.com/Jeffwan), Bytedance<br>* [Sergey Kanzhelev](https://github.com/SergeyKanzhelev), Google<br>* [Yuan Tang](https://github.com/terrytangyuan), Red Hat<br>|* [Slack](https://kubernetes.slack.com/messages/wg-serving)<br>* [Mailing List](https://groups.google.com/a/kubernetes.io/g/wg-serving)|* WG Serving Weekly Meeting ([Calendar](https://calendar.google.com/calendar/embed?src=e896b769743f3877edfab2d4c6a14132b2aa53287021e9bbf113cab676da54ba%40group.calendar.google.com)): [Wednesdays at 9:00 PT (Pacific Time) (weekly)](https://zoom.us/j/93517402529?pwd=RnkwUUQ4L3J2QmNYYlNBcnZGbXcvQT09)<br>
Expand Down
42 changes: 42 additions & 0 deletions sigs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3375,6 +3375,48 @@ workinggroups:
liaison:
github: pohly
name: Patrick Ohly
- dir: wg-etcd-operator
name: Etcd Operator
mission_statement: >
The working group is dedicated to enabling automatic and efficient operation of
etcd clusters in Kubernetes using an etcd-operator. The working group will discuss
the requirement & use cases of such an etcd-operator. It will also try to create
a roadmap to develop such an etcd-operator.
Note the etcd clusters, to be managed by the etcd-operator, are to support applications
instead of Kubernetes itself.
charter_link: charter.md
stakeholder_sigs:
- Cluster Lifecycle
- etcd
label: etcd-operator
leadership:
chairs:
- github: ahrtr
name: Benjamin Wang
company: VMWare
- github: hakman
name: Ciprian Hacman
company: Microsoft
- github: jberkus
name: Josh Berkus
company: Red Hat
meetings:
- description: Regular WG Meeting
day: TBD
time: TBD
tz: PT (Pacific Time)
frequency: bi-weekly
url: provide-a-zoom-link
archive_url: provide-a-google-doc
recordings_url: youtube-playlist-link
contact:
slack: wg-etcd-operator [to-be-created]
mailing_list: provide-a-mailing-list
liaison:
github: to-be-finalized
name: to-be-finalized
- dir: wg-lts
name: LTS
mission_statement: >
Expand Down
39 changes: 39 additions & 0 deletions wg-etcd-operator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!---
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 Operator Working Group

The working group is dedicated to enabling automatic and efficient operation of etcd clusters in Kubernetes using an etcd-operator. The working group will discuss the requirement & use cases of such an etcd-operator. It will also try to create a roadmap to develop such an etcd-operator.
Note the etcd clusters, to be managed by the etcd-operator, are to support applications instead of Kubernetes itself.

The [charter](charter.md) defines the scope and governance of the Etcd Operator Working Group.

## Stakeholder SIGs
* [SIG Cluster Lifecycle](/sig-cluster-lifecycle)
* [SIG etcd](/sig-etcd)

## Meetings
*Joining the [mailing list](provide-a-mailing-list) for the group will typically add invites for the following meetings to your calendar.*
* Regular WG Meeting: [TBDs at TBD PT (Pacific Time)](provide-a-zoom-link) (bi-weekly). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=TBD&tz=PT%20%28Pacific%20Time%29).
* [Meeting notes and Agenda](provide-a-google-doc).
* [Meeting recordings](youtube-playlist-link).

## Organizers

* Benjamin Wang (**[@ahrtr](https://github.com/ahrtr)**), VMWare
* Ciprian Hacman (**[@hakman](https://github.com/hakman)**), Microsoft
* Josh Berkus (**[@jberkus](https://github.com/jberkus)**), Red Hat

## Contact
- Slack: [#wg-etcd-operator [to-be-created]](https://kubernetes.slack.com/messages/wg-etcd-operator [to-be-created])
- [Mailing list](provide-a-mailing-list)
- [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/wg%2Fetcd-operator)
- Steering Committee Liaison: to-be-finalized (**[@to-be-finalized](https://github.com/to-be-finalized)**)
<!-- BEGIN CUSTOM CONTENT -->

<!-- END CUSTOM CONTENT -->
60 changes: 60 additions & 0 deletions wg-etcd-operator/charter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# WG etcd operator

This charter adheres to the conventions described in the [Kubernetes Charter README]
and uses the Roles and Organization Management outlined in [sig-governance].

[sig-governance]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance.md
[Kubernetes Charter README]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/README.md

## Scope

The purpose of an etcd-operator is to operate automatically etcd clusters which run in the Kubernetes environment.
It minimizes human intervention as much as possible.

### In Scope

- Clarify the Goal & Non-goal.
- Collect requirements & use cases with a [survey](https://forms.gle/5gBpzaxYtuQPWdBo9) to better understand what users care about the most.
- Prioritize the tasks based on feedback and create a roadmap.
- Bootstrap a project "etcd-operator" owned by SIG etcd which resides in the etcd-io or kubernetes-sigs Github orgs.
- Review existing etcd operators to see if any could be forked or referenced to advance the project.
- Discuss & design the core reconciliation workflow, and potentially provide a proof of concept (PoC).
- Figure out how to get resource for following dev/test, i.e. AWS S3.

### Out of scope

- Manage etcd clusters running within non-Kubernetes environments.
- Manage etcd clusters which are supporting the Kubernetes itself.

## Stakeholders

Stakeholders for this working group include members in the following SIGs:

- SIG etcd
- SIG Cluster Lifecycle

## Deliverables

The artifacts the group is supposed to deliver include:
- Survey results which describe the users requirements and use cases.
- Roadmap for the project etcd-operator.
- Core reconciliation workflow and PoC.
- A new repository "etcd-operator" owned by SIG etcd, and it should have implemented the very basic functionalities below,
- Creation of a new etcd cluster with one or multiple members;
- Scale out & in the etcd cluster;
- Upgrading patch versions or one minor version.

## Roles and Organization Management

This working group adheres to the Roles and Organization Management outlined in
[sig-governance] and opts-in to updates and modifications to [sig-governance].

[sig-governance]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance.md

## Timelines and Disbanding

The exact timeline for this working group is hard to define at this time.

When all the deliverables mentioned above are done and there is no additional coordination needed,
then we will disband this working group and continue to track the development of the proejct
under SIG etcd.

0 comments on commit 8d79f06

Please sign in to comment.