Skip to content

Commit 331fe6f

Browse files
authored
Add feature page for: Service Credential Distribution for VMs [Beta] (kubernetes#43)
1 parent 76c0832 commit 331fe6f

File tree

1 file changed

+225
-0
lines changed

1 file changed

+225
-0
lines changed
Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
[//]: # (The syntax preceeding this line is a comment marker used to help guide the author in populating this document)
2+
[//]: # (to github. Unlike HTML comments commonly used throughout istio.io documentation, this comment will not be rendered)
3+
[//]: # (by github. Comments must be separated by carriage return preceding and concluding the text and be a single line.)
4+
5+
[//]: # (This is a living document representing the maturity of a feature. Completion of this template enables Istio work groups)
6+
[//]: # (to collect information on potential new functionality. This template should be completed before users are exposed to)
7+
[//]: # (any new experimental feature. Please complete this template during development.)
8+
9+
[//]: # (The feature implementation section must be completed before submission of the document.)
10+
11+
# Feature:
12+
13+
[//]: # (All information in this section is mandatory.)
14+
15+
**Feature name:**
16+
17+
Service Credential Distribution for Virtual Machines
18+
19+
[//]: # (The name of the feature, e.g. Multiple control planes)
20+
21+
**Primary lead(s):**
22+
23+
Limin Wang
24+
25+
[//]: # (The primary lead or leads responsible for the feature. These individuals serve as a point of contact for the feature.)
26+
27+
**Short description:**
28+
29+
Identity and certificate management for VMs in Istio
30+
31+
[//]: # (A short description of the feature. One or two sentences maximum.)
32+
33+
34+
**Design Docs:**
35+
36+
- [Mesh Expansion: VM Security](https://docs.google.com/document/d/1-612Sgz_skeoX44dw3MU6Z8ONgq1f29wLUI9zggyLec/edit#heading=h.ls9r1x3pxz4v)
37+
- [VM Cert Provisioning](https://docs.google.com/document/d/1lPyIPLYQfjde_DUL3eBIlJqof65LSoDiRqB60xVZESY/edit#heading=h.xw1gqgyqs5b)
38+
- [VM Identity Bootstrapping](https://docs.google.com/document/d/1JndFmMKpWKg0kuRK7GVsNEyu9Z3ha0XFGpI2G0_wrWA/edit#heading=h.gahs6ye2t8n2)
39+
- [Bootstrapping VM Identities using bootstrap tokens](https://docs.google.com/document/d/1Fp-Oe7P4_JU9_c6InQwFgJZgjcy1OIfrrQ-UEQUu5YU/edit#heading=h.xw1gqgyqs5b)
40+
41+
[//]: # (Design docs for feature)
42+
43+
44+
**Relevant Documentation:**
45+
46+
[//]: # (Links to relevant documentation for feature)
47+
48+
**RFC:**
49+
50+
[//]: # (Link to RFC for feature)
51+
52+
53+
---
54+
55+
## Experimental
56+
57+
### Requirements:
58+
59+
[//]: # (All information in this section is mandatory for promotion. Please modify the links in this)
60+
[//]: # (section.)
61+
62+
- [ ] [User stories](insert_your_link_here) reviewed in a work group meeting.
63+
64+
[//]: # (User stories are a way to communicate user value. User stories follow the style)
65+
[//]: # (as a [type of user], I want [an action] so that [a benefit/a value]. Istio currently has no user)
66+
[//]: # (story template. Maybe you can make one?)
67+
68+
[//]: # (User stories must be presented in a work group meeting. They need no approval and are later integrated)
69+
[//]: # (into the RFCs, which do need approval for alpha. You may find value to negotiate within the work group where the)
70+
[//]: # (user stories are presented to help clarify the user stories.)
71+
72+
- [ ] [RFC Authored] - [create an RFC using template](https://docs.google.com/document/d/1ewJoCcw5-04crH-M0xw4zFxz1cfwVCPnNyW4K3m4Yyc/template/preview).
73+
74+
[//]: # (An RFC is mandatory to graduate to experimental. The RFC does not have to be reviewed in a work group)
75+
[//]: # (meeting to graduate to experimental.)
76+
77+
- [ ] [Documentation](insert_your_link_here) for enabling and using the feature.
78+
79+
[//]: # (The documentation instructions may exist on the developer wiki or the team drive. They may include instructions)
80+
[//]: # (for building running a `istioctl experimental command`, or using the preview profile,)
81+
[//]: # (or any other relevant information.)
82+
83+
- [ ] [Feedback plan](insert_your_link_here).
84+
85+
[//]: # (This may include user feedback meetings, discuss.istio.io conversations, GitHub issues, or mailing lists.)
86+
87+
- [ ] Disabled by default.
88+
89+
- [ ] No impact on performance when the feature is disabled.
90+
91+
92+
[//]: # (Once all other items are completed, features.yaml should be updated to promote the feature)
93+
94+
- [ ] [features.yaml](https://github.com/istio/enhancements/blob/master/features.yaml) updated for this feature
95+
---
96+
97+
## Alpha
98+
99+
### Requirements:
100+
101+
**Design**
102+
103+
- [x] RFC has been approved describing the intention of the feature as well as the user stories behind the feature.
104+
105+
**Config**
106+
107+
- [x] Explicit user action is required to enable this feature (e.g. a config field, config resource, or installation action).
108+
109+
> Link to instructions for enabling
110+
111+
**Docs**
112+
113+
- [x] Reference docs are published to preliminary.istio.io or the Istio wiki.
114+
- [x] Basic feature docs are published on preliminary.istio.io describing what the feature does, how to use it, and any caveats.
115+
- [x] Release notes entries added as appropriate
116+
- [x] Upgrade notes entries added as appropriate
117+
118+
**Tests**
119+
120+
- [x] Automated integration tests cover core use cases with the feature enabled.
121+
- [x] When disabled, the feature does not affect system stability or performance.
122+
123+
**API**
124+
125+
- [x] Initial API review.
126+
127+
**Approvals**
128+
129+
- [x] The appropriate work group(s) have reviewed and approved promotion of the feature.
130+
- [x] The TOC has reviewed and approved promotion of the feature as part of the
131+
roadmap for a release.
132+
133+
**Promotion**
134+
135+
[//]: # (Once all other items are completed, features.yaml should be updated to promote the feature)
136+
137+
- [x] [features.yaml](https://github.com/istio/enhancements/blob/master/features.yaml) updated for this feature
138+
139+
---
140+
141+
## Beta
142+
143+
### Requirements:
144+
145+
**Design**
146+
147+
- [x] Design doc describing the intention of the feature, how it will be
148+
implemented, and any thoughts on how to test the feature has been approved by
149+
relevant work group leads
150+
- [x] Feature coverage and test plans written and approved.
151+
152+
**Docs**
153+
154+
- [x] Documentation on istio.io includes performance expectations; may have caveats.
155+
- [x] Documentation on istio.io includes samples/tutorials.
156+
- [x] Documentation on istio.io includes appropriate glossary entries.
157+
- [x] All new documentation containing user actions includes istio.io tests.
158+
- [x] Release notes have been added.
159+
- [x] Upgrade notes have been added.
160+
161+
**Tests**
162+
163+
- [x] Integration tests cover feature edge cases
164+
- [x] End-to-end tests cover samples/tutorials
165+
- [x] Fixed issues have tests to prevent regressions
166+
- [ ] Stability/stress test suite includes coverage for the feature.
167+
168+
**Performance**
169+
170+
- [x] Feature coverage and test plans written and approved
171+
- [ ] Tests exist with the feature enabled that can be integrated with our automated performance testing.
172+
173+
**API**
174+
175+
- [x] TOC has reviewed the API and determined it to be complete.
176+
177+
**Tooling**
178+
179+
- [ ] Any necessary tooling to use/debug the feature has been implemented and is complete.
180+
181+
**Bugs**
182+
183+
- [x] Feature has no known major issues.
184+
185+
**Approvals**
186+
187+
- [x] The appropriate work group(s) have reviewed and approved promotion of the feature.
188+
- [x] The supportability review panel has reviewed promotion of the feature.
189+
- [x] The TOC has reviewed and approved promotion of the feature as part of the
190+
road map for a release.
191+
192+
193+
**Promotion**
194+
195+
[//]: # (Once all other items are completed, features.yaml should be updated to promote the feature)
196+
197+
- [x] [features.yaml](https://github.com/istio/enhancements/blob/master/features.yaml) updated for this feature
198+
---
199+
200+
## Stable
201+
202+
### Requirements:
203+
204+
**Performance**
205+
206+
- [ ] Latency, throughput, and scalability are quantified and documented on
207+
istio.io.
208+
209+
**Bugs**
210+
211+
- [ ] Feature has no known major issues.
212+
213+
**Approvals**
214+
215+
- [ ] The appropriate work group(s) have reviewed and approved promotion of the feature.
216+
- [ ] The [supportability review panel](https://docs.google.com/document/d/1w0epyFhhDSf_TwFEfa_lrn1v61mXNJKpEp_kUgp4sSc/edit#) has reviewed the feature in order to find any supportability concerns.
217+
- [ ] The TOC has reviewed and approved promotion of the feature as part of the
218+
roadmap for a release.
219+
220+
221+
**Promotion**
222+
223+
[//]: # (Once all other items are completed, features.yaml should be updated to promote the feature)
224+
225+
- [ ] [features.yaml](https://github.com/istio/enhancements/blob/master/features.yaml) updated for this feature

0 commit comments

Comments
 (0)