Skip to content

Commit 93b69e0

Browse files
authored
Merge pull request #6551 from dims/sig-arch-annual-report-2021
2021 Annual Report: SIG Architecture
2 parents 8e952ec + 1cbf735 commit 93b69e0

File tree

1 file changed

+172
-70
lines changed

1 file changed

+172
-70
lines changed

sig-architecture/annual-report-2021.md

Lines changed: 172 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -3,80 +3,140 @@
33
## Current initiatives
44

55
1. What work did the SIG do this year that should be highlighted?
6-
7-
-
8-
-
9-
-
6+
7+
SIG-Architecture operates mostly through its subprojects like conformance, enhancements, code organization and production readiness.
8+
The regular SIG meetings have turned into a policy making/adjusting forum and for tackling issues that are across various SIGs.
9+
The focus has been to increase reliability, make things stable and document things that we hadn't before.
10+
Closing conformance gaps!
11+
We haven't had to update architecture very much. Stability improved.
12+
increased reliability, Stabilizing, version skews etc have helped the community
13+
- ecosystem balance shifted from using beta APIs primarily to using stable APIs primarily (1.22+)
1014

1115
2. What initiatives are you working on that aren't being tracked in KEPs?
16+
- KEP survey for enhancements
17+
- Working with dependencies to cut down indirect go.sum entries.
18+
- Updating API conventions by adding documentation
1219

13-
-
14-
-
15-
-
16-
17-
3. KEP work in 2021 (1.x, 1.y, 1.z):
18-
19-
<!--
20-
In future, this will be generated from kubernetes/enhancements kep.yaml files
21-
1. with SIG as owning-sig or in participating-sigs
22-
2. listing 1.x, 1.y, or 1.z in milestones or in latest-milestone
23-
-->
20+
3. KEP work in 2021 (1.21, 1.22, 1.23):
2421

2522
- Stable
26-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable
27-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable
23+
- [2527 - Clarify meaning of status](https://github.com/kubernetes/enhancements/blob/master/keps/sig-architecture/2527-clarify-status-observations-vs-rbac/README.md) - 1.22
24+
- [1693 - Warning API mechanism](https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/1693-warnings/README.md) - 1.22
2825
- Beta
29-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta
30-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta
31-
- Alpha
32-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha
33-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha
34-
- Pre-alpha
35-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md)
26+
- [2572 - Defining the Kubernetes release cadence](https://github.com/kubernetes/enhancements/blob/master/keps/sig-release/2572-release-cadence/) - 1.23
3627

3728
## Project health
3829

3930
1. What areas and/or subprojects does your group need the most help with?
4031
Any areas with 2 or fewer OWNERs? (link to more details)
4132

42-
-
43-
-
44-
-
33+
- PRR we need to grow more reviewers and approvers
34+
- API reviews has a pipeline set up with Jordan leading. Need more SIGs to identify additional folks to start learning
35+
- Conformance, all the easy stuff is done. So we have harder stuff to review, so need additional folks with context to help make progress
4536

4637
2. What metrics/community health stats does your group care about and/or measure?
4738

48-
-
49-
-
39+
- We care about regressions, backports, dependencies across release boundaries
40+
- We care about the number of enhancements per release along with their timely graduation
5041
-
5142

5243
3. Does your [CONTRIBUTING.md] help **new** contributors engage with your group specifically by pointing
5344
to activities or programs that provide useful context or allow easy participation?
5445

55-
-
46+
- Yes. it is [here](https://github.com/kubernetes/community/blob/master/sig-architecture/CONTRIBUTING.md)
5647

5748
4. If your group has special training, requirements for reviewers/approvers, or processes beyond the general [contributor guide],
5849
does your [CONTRIBUTING.md] document those to help **existing** contributors grow throughout the [contributor ladder]?
5950

60-
-
51+
- PRR and API review has dedicated docs that can help folks get start. What we need is for SIG leads to send people our way
52+
- API review: each SIG can identify 2-3 people to be involved in API reviews - https://github.com/kubernetes/kubernetes/blob/v1.23.0/OWNERS_ALIASES#L451-L452
6153

6254
5. Does the group have contributors from multiple companies/affiliations?
6355

64-
-
56+
- yes
6557

6658
6. Are there ways end users/companies can contribute that they currently are not?
6759
If one of those ways is more full time support, what would they work on and why?
6860

69-
-
61+
- We need help across all the subprojects that have well defined, ongoing work with an onboarding guide/doc
7062
-
7163

7264
## Membership
7365

74-
- Primary slack channel member count:
75-
- Primary mailing list member count:
76-
- Primary meeting attendee count (estimated, if needed):
77-
- Primary meeting participant count (estimated, if needed):
78-
- Unique reviewers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
79-
- Unique approvers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
66+
- Primary slack channel member count: #sig-architecture Slack - 2 519
67+
- Primary mailing list member count: kubernetes-sig-architecture mailing list - 552 members
68+
- Primary meeting attendee count (estimated, if needed): ~ 10 - 12
69+
- Primary meeting participant count (estimated, if needed): ~6 - 8
70+
- Unique reviewers for SIG-owned packages: 20 <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
71+
- Unique approvers for SIG-owned packages: 13
72+
<!--
73+
Used this from the owners [alias file](https://github.com/kubernetes/kubernetes/blob/master/OWNERS_ALIASES)
74+
Counted Unique approvers and reviewers.
75+
Did not count approvers again as reviewers. - Riaan
76+
Enhancements [owners file](https://github.com/kubernetes/enhancements/blob/master/OWNERS_ALIASES)
77+
- sig-architecture-approvers:
78+
- dims
79+
- derekwaynecarr
80+
- johnbelamaric
81+
- api-approvers:
82+
- lavalamp
83+
- smarterclayton
84+
- thockin
85+
- liggitt
86+
- api-reviewers:
87+
- andrewsykim
88+
- lavalamp
89+
- smarterclayton
90+
- thockin
91+
- liggitt
92+
- wojtek-t
93+
- deads2k
94+
- yujuhong
95+
- derekwaynecarr
96+
- caesarxuchao
97+
- mikedanese
98+
- sttts
99+
- dchen1107
100+
- saad-ali
101+
- luxas
102+
- janetkuo
103+
- justinsb
104+
- pwittrock
105+
- ncdc
106+
- tallclair
107+
- mwielgus
108+
- soltysh
109+
- jsafrane
110+
- dims
111+
- conformance-behavior-approvers:
112+
- smarterclayton
113+
- johnbelamaric
114+
- spiffxp
115+
- conformance/OWNERS
116+
- approvers:
117+
- cheftako
118+
- spiffxp
119+
- johnbelamaric
120+
- reviewers:
121+
- cheftako
122+
- oomichi
123+
- johnbelamaric
124+
- enhancements/OWNERS
125+
- approvers:
126+
- jeremyrickard
127+
- johnbelamaric
128+
- kikisdeliveryservice
129+
- mrbobbytables
130+
- reviewers:
131+
- annajung
132+
- jeremyrickard
133+
- johnbelamaric
134+
- kikisdeliveryservice
135+
- mrbobbytables
136+
- palnabarun
137+
138+
-->
139+
<!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
80140

81141
Include any other ways you measure group membership
82142

@@ -87,51 +147,93 @@ In future, this will be generated from delta of sigs.yaml from $YYYY-01-01 to $Y
87147
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
88148
-->
89149

90-
New in $YYYY:
91-
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
92-
-
93-
94-
Retired in $YYYY:
95-
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
96-
-
97-
98150
Continuing:
99-
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
100-
-
101151

102-
## Working groups
103-
104-
<!--
105-
In future, this will be generated from delta of sigs.yaml from $YYYY-01-01 to $YYYY-12-31
106-
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
107-
-->
152+
- [Architecture and API Governance](https://github.com/kubernetes/community/tree/master/sig-architecture#architecture-and-api-governance-1)
153+
- API guidance updates
154+
- [Object references](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#object-references), including cross-namespace references from namespaced objects
155+
- [Spec and Status](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status) ([#5842](https://github.com/kubernetes/community/pull/5842))
156+
- 114 [API reviews completed](https://github.com/orgs/kubernetes/projects/13) in 2021 (30 for v1.21, 45 for v1.22, 39 for v1.23)
157+
- Each SIG can identify 2-3 people to be involved in API reviews - https://github.com/kubernetes/kubernetes/blob/v1.23.0/OWNERS_ALIASES#L451-L452
158+
- [Conformance Definition](https://github.com/kubernetes/community/tree/master/sig-architecture#conformance-definition-1)
159+
- We started 2021 with 128 endpoints remaining without conformance test.(69.13% conformance tested)
160+
- The current count is [51 endpoints](https://apisnoop.cncf.io/conformance-progress/endpoints/1.24.0/?filter=untested)
161+
remaining without conformance tests putting us at [87.25%](https://apisnoop.cncf.io/?conformance-only=true) conformance tested.
162+
- In the last 12 months
163+
- Tests for 75 endpoints was promoted to conformance
164+
- 34 Endpoints was promoted to GA with conformance tests
165+
- No new technical debt was incurred
166+
- We moved the Conformance Office Hours Meeting from Bi-weekly to monthly in Aug 2021 to reduce the strain on attendee's calendars and increase engagement.
167+
- At the start of 2021 the tracking of ineligible endpoints for conformance was moved to
168+
[`ineligible_endpoints.yaml`](https://github.com/kubernetes/kubernetes/blob/master/test/conformance/testdata/ineligible_endpoints.yaml) file.
169+
This allows for more community engagement on the eligibility of endpoints for conformance before any endpoint is added to the endpoint to the
170+
[Ineligible Endpoints list](https://apisnoop.cncf.io/conformance-progress/ineligible-endpoints) through pubic pull request.
171+
- Our target for 2022 is to clean up the last 51 endpoint and then move over to Conformance profiles
172+
to further increase the value added by conformance testing.
173+
- [Code Organization](https://github.com/kubernetes/community/tree/master/sig-architecture#code-organization-1)
174+
- Added [Snyk based scanning](https://testgrid.k8s.io/sig-security-snyk-scan#ci-kubernetes-snyk-master) for kubernetes/kubernetes repository
175+
- Updated license tooling for dependencies to generate a directory tree of licenses instead of a single file
176+
- Cleaned up go.mod/sum contents and tooling removing a whole lot of transitive dependecies and even a couple of recursive dependencies
177+
- Added tooling to exclude unwanted dependencies
178+
- Use new tools like golangci-lint for better code health
179+
- [Enhancements](https://github.com/kubernetes/community/tree/master/sig-architecture#enhancement-proposals)
180+
- In 2021, the subproject was mainly focused on improving the contributor experience via automation and thoughtful ui/ux changes making visible changes to the KEP process.
181+
- Major efforts were put into improving tooling on the enhancements repo throughout the year allowing us to automate more validation lessening the burden on individual approvers and resulting in more accurate information reflected in the document. All KEPs were migrated to the new template which now includes a key.yaml file.
182+
- The team had major contributions authoring and negotiating [KEP 2572 - Defining the Kubernetes release cadence](https://github.com/kubernetes/enhancements/blob/master/keps/sig-release/2572-release-cadence/).
183+
- We made progress on the receipts process, but ultimately decided that it was too disruptive for the community as a new UI/UX.
184+
- The team updated the repository documentation and work was started on a KEP website for easier navigation.
185+
- New members joined the team: 1 new approver and 2 reviewers were added to the Enhancements Subproject. A new kep tools team with initially 4 reviewers and approvers was created and more recently had an addition of 1 new approver/reviewer. We also had 2 owners transition to become our first Emeritus approvers.
186+
- We hope to keep improving the KEP process in 2022 and will be conducting a community survey to collect feedback, working on a Process KEP template and other improvements.
187+
- In 2021, the subproject also started a [_KEP Reading Club_](https://docs.google.com/document/d/17kQZ__AfMv2D4O5PHJIKXyr9lNwYNAZjYUhvt3gRXCU/edit?usp=sharing) with the intent of creating more awareness around the features being worked on, more familiarity with the KEP process, and potentially connecting aspiring contributors with KEP authors looking for help.
188+
- In 2021, we've conducted [8 sessions](https://www.youtube.com/playlist?list=PL69nYSiGNLP3hHfpaik9WzlbxB43BUPJ6) of the reading club which involved discussing important KEPs such as [KEP-2221: Removing dockershim from kubelet](https://github.com/kubernetes/enhancements/tree/master/keps/sig-node/2221-remove-dockershim) and [KEP-3136: Beta APIs Are Off by Default](https://github.com/kubernetes/enhancements/tree/master/keps/sig-architecture/3136-beta-apis-off-by-default).
189+
- These discussions have led to feedback that was taken by stakeholder SIGs and used to drive deeper discussions around the design of that feature, examples of such cases are [KEP-1440: kubectl events](https://github.com/kubernetes/enhancements/tree/master/keps/sig-cli/1440-kubectl-events) and [KEP-2258: Node service log viewer](https://github.com/kubernetes/enhancements/blob/master/keps/sig-windows/2258-node-service-log-viewer/README.md).
190+
- [Production Readiness](https://github.com/kubernetes/community/tree/master/sig-architecture#production-readiness-1)
191+
- Production readiness review [became mandatory] for enhancements in 2021, starting with the 1.21 release cycle.
192+
- We added a fourth approver, Elana Hashman, who joined the team after shadowing in 1.21.
193+
- We created documentation on the [lifecycle of feature gates].
194+
- We reviewed data from the 2020 Production Readiness Survey, and prepared a 2021 survey, whose [responses we analyzed].
195+
- Survey report URL: https://datastudio.google.com/reporting/2e9c7439-202b-48a9-8c57-4459e0d69c8d/page/GC5HB
196+
- YouTube recording: https://youtu.be/9GM28aAyRQs
197+
- The team implemented a [soft deadline] to set expectations around what can be reviewed in time for enhancements freeze.
198+
- We reviewed a total of 171 KEPs in 2021, averaging 16 per approver per release:
199+
- 51 KEPs in 1.21 (3 approvers)
200+
- 52 KEPs in 1.22 (4 approvers)
201+
- 68 KEPs in 1.23 (4 approvers)
202+
203+
[became mandatory]: https://groups.google.com/g/kubernetes-dev/c/GvT-qOaVsWE/m/zeazt2kODQAJ
204+
[soft deadline]: https://groups.google.com/g/kubernetes-dev/c/EvpXsyLf5E0/m/D4Jhc7ItAgAJ
205+
[responses we analyzed]: https://docs.google.com/document/d/1BlmHq5uPyBUDlppYqAAzslVbAO8hilgjqZUTaNXUhKM/edit#bookmark=id.g9stoq3xr2dx
206+
[lifecycle of feature gates]: https://git.k8s.io/community/contributors/devel/sig-architecture/feature-gates.md
207+
108208

109-
New in $YYYY:
110-
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
111-
-
209+
## Working groups
112210

113-
Retired in $YYYY:
114-
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
115-
-
211+
- [API Expression](https://git.k8s.io/community/wg-api-expression/) ([2021 report](https://git.k8s.io/community/wg-api-expression/annual-report-2021.md))
116212

117-
Continuing:
118-
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
119-
-
213+
TODO: dims to send email to WG asking them to talk to us sync of async
120214

121215
## Operational
122216

123217
Operational tasks in [sig-governance.md]:
124218

125-
- [ ] [README.md] reviewed for accuracy and updated if needed
126-
- [ ] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
219+
- [x] [README.md](https://github.com/kubernetes/community/blob/master/sig-architecture/README.md) reviewed for accuracy and updated if needed
220+
- [x] [CONTRIBUTING.md](https://github.com/kubernetes/community/blob/master/sig-architecture/CONTRIBUTING.md) reviewed for accuracy and updated if needed
127221
(or created if missing and your contributor steps and experience are different or more
128222
in-depth than the documentation listed in the general [contributor guide] and [devel] folder.)
129-
- [ ] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
223+
**We need to create this:**
224+
- [ ] [HackMD](https://hackmd.io/GY081dMNThS16WWWB46unw) for template started - Riaan
225+
- [ ] [Subprojects list](https://github.com/kubernetes/community/blob/master/sig-architecture/README.md#subprojects) and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
130226
- [ ] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
131-
- [ ] Meeting notes and recordings for 2021 are linked from [README.md] and updated/uploaded if needed
227+
- [ ] **MAYBE SOME REVIEW IS NEEDED, SOME OWNERS FILES LAST UPDATED 2019**
228+
- [ ] [Meeting notes and recordings](https://github.com/kubernetes/community/blob/master/sig-architecture/README.md#meetings) for 2021 are linked from [README.md] and updated/uploaded if needed
229+
- [ ] **NEED UPDATES**
230+
- [ ] Dead link to Enhancements Subproject Meeting Youtube
231+
- [ ] Last SIG Recording uploaded Jul 2021
132232
- [ ] Did you have community-wide updates in 2021 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
133-
-
134-
-
233+
- 2021 Kubecon EU Virtual Kubernetes Conformance
234+
[A talk on what Kubernetes Conformance is and how to contribute to it](https://www.youtube.com/watch?v=05NMwOhD6Ks) by Zach Mandeville and Caleb Woodbine.
235+
- 2021 Kubecon NA Virtual - Kubernetes Conformance
236+
[A talk on the tooling that has been used the community to bring Kubernetes Conformance coverage up to 77%](https://www.youtube.com/watch?v=IQsBahak7PQ) by Stephen Heywood and Caleb Woodbine.
135237

136238
[CONTRIBUTING.md]: https://git.k8s.io/community/sig-architecture/CONTRIBUTING.md
137239
[contributor ladder]: https://git.k8s.io/community/community-membership.md

0 commit comments

Comments
 (0)