Fix typos and add a paragraph for initializers doc #4369
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
/assign @caesarxuchao |
- Fixed a few consistency issues and typos in the doc - Also fixed an username typo in assignees - Added a paragraph explaining how the example initializerconfiguration will be applied once it is created. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
| @@ -126,6 +126,11 @@ initializers: | |||
| - pods | |||
| ``` | |||
|
|
|||
| Once this `initializerConfiguration` named `example-config` is created, the | |||
There was a problem hiding this comment.
Could you move it to after line 137, so it will read like:
"After you create the initializerConfiguration, the system will take a few seconds to honor the new configuration. Then, "podimage.example.com" will be appended to the metadata.initializers.pending field of newly created pods. You should already have a ready "podimage" initializer controller that handles pods whose metadata.initializers.pending[0].name="podimage.example.com". Otherwise the pods will stuck uninitialized."
BTW, there is another occurrence of metadata.initializers[0] earlier in the doc, could you replace it with metadata.initializers.pending[0].name?
There was a problem hiding this comment.
@caesarxuchao there were about 4 other occurrences of metadata.initializers that doesn't mention .pending. I changed them all. PTAL again.
|
Thanks. A comment, otherwise lgtm. |
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
| should already have a ready "podimage" initializer controller that handles pods | ||
| whose `metadata.initializers.pending[0].name="podimage.example.com"`. Otherwise | ||
| the pods will stuck uninitialized. | ||
|
|
||
| Make sure that all expansions of the `<apiGroup, apiVersions, resources>` tuple |
There was a problem hiding this comment.
I feel this paragraph should go before "After you create ...", since it's talking about the best-practice of InitializerConfiguration. WDYT?
There was a problem hiding this comment.
I left it here because explaining what this InitializerConfiguration does seemed more important. Can move if necessary, but I think it reads fine.
There was a problem hiding this comment.
It's ok. I don't feel strongly about it.
|
/lgtm |
|
/assign @zacharysarah |
* Fix typos and add a paragraph for initializers doc - Fixed a few consistency issues and typos in the doc - Also fixed an username typo in assignees - Added a paragraph explaining how the example initializerconfiguration will be applied once it is created. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com> * Add .pending to metadata.initializers, re-wording Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
be applied once it is created.
/assign @chenopis
This change is