Skip to content

Commit 59dea9c

Browse files
jpbetzKevin Wiesmüllerlavalamp
authored
Apply suggestions from code review
Co-authored-by: Kevin Wiesmüller <[email protected]> Co-authored-by: Daniel Smith <[email protected]>
1 parent b4024ae commit 59dea9c

File tree

1 file changed

+9
-9
lines changed
  • keps/sig-api-machinery/2144-clientgo-apply

1 file changed

+9
-9
lines changed

keps/sig-api-machinery/2144-clientgo-apply/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,16 +102,16 @@ deficiencies:
102102
being accidentally being clamed as owned.
103103

104104
Both sig-api-machinery and wg-api-expression agree that this enhancement is
105-
required before server side apply to be promoted to GA.
105+
required for server side apply to be promoted to GA.
106106

107107
### Goals
108108

109109
Introduce a typesafe, programmatic way to call server side apply using the typed
110110
client in client-go.
111111

112112
Express all apply configurations in Go that can be expressed in
113-
YAML. Specifically, an apply request must include only field that are set by
114-
applier and exclude those not set by applier.
113+
YAML. Specifically, an apply request must include only fields that are set by
114+
the applier and exclude those not set by the applier.
115115

116116
Validate this enhancement meets the needs of developers:
117117

@@ -141,14 +141,14 @@ representation, which will need to be generated for this purpose.
141141

142142
#### Poor adoption
143143

144-
Risk: Developers adoption is poor, either because the asthetics/ergonomics are
144+
Risk: Developers adoption is poor, either because the aesthetics/ergonomics are
145145
not to their liking or the functinality is insufficient to do what they need to
146146
do with it. This could lead to (a) poor server side apply adoption, and/or (b)
147147
developers building alternate solutions.
148148

149149
Mitigation: We are working with the kubebuilder community to
150150
get hands on feedback from developers to guide our design decisions around
151-
asthetics/egronomics with a goal of having both client-go and kubebuilder
151+
aesthetics/ergonomics with a goal of having both client-go and kubebuilder
152152
take an aligned approach to adding apply to clients in a typesafe way.
153153

154154
## Design Details
@@ -178,7 +178,7 @@ Apply will combine the `fieldManager` argument with `ApplyOptions` to create the
178178
`PatchOptions`.
179179

180180
Each apply call will be required to provide a fieldmanager name. We will not
181-
provide a a way for the fieldmanager name to be set for the entire
181+
provide a way for the fieldmanager name to be set for the entire
182182
clientset. There are a couple reasons for this:
183183

184184
- If a client has multiple code paths where it makes apply requests to the same
@@ -208,7 +208,7 @@ the two below alternatives. We are working with the Kubebuilder community to
208208
gather feedback on what developers prefer.
209209
<<[/UNRESOLVED]>>
210210

211-
#### Alternative 1: Genreated structs where all fields are pointers
211+
#### Alternative 1: Generated structs where all fields are pointers
212212

213213
Example usage:
214214

@@ -269,7 +269,7 @@ for a working implementation of alternative 2.
269269

270270
Of the two leading alternatives--"builders" and "structs with pointers"--we implemented
271271
prototypes of both. They had roughly equivalent performance, and no differences
272-
in their capabilities. The choice between the two is primarily one of asthetics/ergonomics.
272+
in their capabilities. The choice between the two is primarily one of aesthetics/ergonomics.
273273

274274
Some of the feedback we have heard from the community:
275275

@@ -351,7 +351,7 @@ together in test/integration/client/client_test.go.
351351

352352
### e2e testing
353353

354-
We will migrate the cluste rrole aggregation controller to use apply and verify
354+
We will migrate the cluster role aggregation controller to use apply and verify
355355
it is correct using the existing e2e tests, expanding coverage as needed.
356356

357357
### Graduation Criteria

0 commit comments

Comments
 (0)