Fix secrets docs in 1.12 branch #10056
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for kubernetes-io-vnext-staging processing. Built with commit 3d4849d https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5b9aa5d082d3f1517eee36ba |
k8s-ci-robot
added
the
size/XS
k8s-ci-robot
added
the
cncf-cla: yes
|
/lgtm @wojtek-t btw, is there a PR in K/K wrt to this change? |
k8s-ci-robot
added
the
lgtm
kubernetes/kubernetes#64752 is the last one in the series - you can probably navigate from there (submitted almost 2 months ago so it was soaking for almost whole 1.12 cycle) |
|
Thanks @wojtek-t ! |
| @@ -339,9 +339,9 @@ files. | |||
|
|
|||
| When a secret being already consumed in a volume is updated, projected keys are eventually updated as well. | |||
| Kubelet is checking whether the mounted secret is fresh on every periodic sync. | |||
| However, it is using its local ttl-based cache for getting the current value of the secret. | |||
| However, it is using its local cache propagated via watch for getting the current value of the secret. | |||
There was a problem hiding this comment.
@wojtek-t as per the PR you referenced, IIUC, the detection strategy is configurable. So, do we need to explain something more here? [EDIT: watch is the default strategy though]
There was a problem hiding this comment.
/hold
@wojtek-t feel free to hold cancel if there is no more explanation needed here :)
There was a problem hiding this comment.
Yes, this is configurable. @wojtek-t, could you augment the doc to include that? Thanks!
There was a problem hiding this comment.
PTAL - hopefully it's better now.
There was a problem hiding this comment.
Overall LGTM. One more question (just for user convenience), is there any place documented how the detection strategy be configured ? If users want to change this strategy, they may not know where and how to configure this. @wojtek-t @yujuhong WDYT?
@mtaufen since kubelet flags are migrating to config files, are the fields of configure documented ? Thanks!
There was a problem hiding this comment.
For the config file, we link directly to the types.go file from the docs page.
See: https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/.
There was a problem hiding this comment.
Thanks @mtaufen ! But I notice that link references a fixed release types.go
(release 1.10: https://github.com/kubernetes/kubernetes/blob/release-1.10/pkg/kubelet/apis/kubeletconfig/v1beta1/types.go) while the current docs version is 1.11. Shouldn't we use the same versioned types.go with docs?
There was a problem hiding this comment.
It must not have been updated in the 1.11 docs.
I sent #10087 to update.
There was a problem hiding this comment.
@mtaufen thanks for the update! Review comment is in that PR :)
There was a problem hiding this comment.
I added the link to appropriate field to this doc.
PTAL
k8s-ci-robot
added
the
do-not-merge/hold
wojtek-t
force-pushed
the
secrets_using_watch
branch
from
4b82e74 to
382942d
Compare
k8s-ci-robot
removed
the
lgtm
wojtek-t
force-pushed
the
secrets_using_watch
branch
from
382942d to
b8583bd
Compare
k8s-ci-robot
added
size/S
wojtek-t
force-pushed
the
secrets_using_watch
branch
from
b8583bd to
3fbca8f
Compare
| projected to the pod can be as long as kubelet sync period + ttl of secrets cache in kubelet. | ||
| However, it is using its local cache for getting the current value of the secret. | ||
| The type of the cache is configurable (`ConfigMapAndSecretChangeDetectionStrategy` field in | ||
| [KubeletConfiguration struct](https://github.com/kubernetes/kubernetes/blob/release-1.12/pkg/kubelet/apis/kubeletconfig/v1beta1/types.go)) |
There was a problem hiding this comment.
I have the same concern here as in https://github.com/kubernetes/website/pull/10087/files#r212857293
/cc @chenopis
There was a problem hiding this comment.
Good catch, @xiangpengzhao! ✨
@wojtek-t Please take a look at the linked PR ☝️ and update this PR to use the same pattern for the URL. Thanks in advance!
|
@wojtek-t @xiangpengzhao Is this in a technical shape ready for my docs (english/grammar) review? |
|
@zparnold - I think so (we may want to change the exact link, but overall I think it's ready). |
|
@zparnold this technically LGTM, but I still want my last inline comment addressed (wrt the hard-coded version). Kindly ping @chenopis @zacharysarah @bradtopol to confirm it :) |
wojtek-t
force-pushed
the
secrets_using_watch
branch
from
3fbca8f to
e7aa12e
Compare
|
PTAL |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
xiangpengzhao
removed
the
do-not-merge/hold
k8s-ci-robot
removed
the
lgtm
|
/approve |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: zparnold The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
k8s-ci-robot
pushed a commit
that referenced
this pull request
Sep 27, 2018
* Update docs for fields allowed at root of CRD schema (#9973) * add plugin docs and examples (#10053) * docs update to promote TaintNodesByCondition to beta (#9626) * HPA Specificity Improvements (#8757) Updated the HPA docs to reference the `autoscaling/v2beta2` API version, and added documentation about the new fields. * adjust docs for pod ready++ (#10049) * Remove --cadvisor-port - has been deprecated since v1.10 (#10023) Change-Id: Id2a685473a243aef492a98ff450759f39e362557 * Add Documentation for Snapshot Feature (#9948) * Add documentation for snapshot feature * Update volume-snapshots.md * Add dry-run to api-concepts (#10033) * kubeadm-init: Update the offline support section (#10062) The update includes the following things (in mind with Kubernetes 1.12): - Remove the 1.8 image versions - Add the 1.10 image versions that were missing until now - Include a comment for the missing arch suffixes in 1.12 Signed-off-by: Rostislav M. Georgiev <[email protected]> * Say bye to `DynamicProvisioningScheduling` (#10157) The mentioned feature gate is now collapsed into `VolumeScheduling`. xref: kubernetes/kubernetes#67432 * Update ResourceQuota per PriorityClass state for 1.12 (#10229) * TokenRequest and TokenRequestProjection now beta (#10161) xref: kubernetes/kubernetes#67349 * Change feature state for kms provider to beta. (#10230) KMS Provider will be graduating to beta in v1.12, reflecting this change on the website. * coredns default (#10200) * Promote ShareProcessNamespace to beta in docs (#9996) * Add CoreDNS details to DNS Debug docs (#10201) * add coredns details * address nits, add query logging section * Update docs with topology aware dynamic provisioning (#9939) * Document topology aware volume binding feature * update for readability * Update storage-classes.md * comma splice * don't abbreviate * HPA Algorithm Information Improvements (#9780) * Update HPA docs with more algorithm details The HPA docs pointed to an out-of-date document for information on the algorithm details, which users were finding confusing. This sticks a section on the algorithm in the HPA docs instead, documenting both general behavior and corner cases. * Add glossary info, HPA docs on quantities People often ask about the quantity notation when working with the metrics APIs, so this adds a glossary entry on quantities (since they're used elsewhere in the system), and a short explantation in the HPA walkthough. * Information about HPA readiness and stabilization This adds information about the new changes to HPA readiness and stabilization from kubernetes/enhancements#591, and other minor changes that landed in Kubernetes 1.12. * Update horizontal-pod-autoscale.md * Audit 1.12 doc (#9953) * audit 1.12 document * remove legacy audit feature kubernetes/kubernetes#65862 * update feature gate doc * MountPropagation is now GA (#10090) * RuntimeClass documentation (#10102) * RuntimeClass documentation * Update runtime-class.md * Add documentation for Scheduler performance tuning (#10048) * Add documentation for Scheduler performance tuning * Update scheduler-perf-tuning.md * TTL controller for cleaning up finished resources (#10064) * TTL controller for cleaning up finished resources * Address comments * Update ttlafterfinished.md * Bump quota configuration api version (#10217) * Incremental update from master (#10278) * fix invalid href of cloud controller manager (#10240) * fix invalid yaml format (#10238) * update storage-limits doc with Azure disk part (#10224) update storage-limits doc with Azure disk part fix comments * Update kubelet-config-file.md (#10222) Update link to KubeletConfiguration struct. * fix a trivial misspelling (#10244) * Fix cassandra-statefulset.yaml indent level (#10243) * Mention minimum etcd versions (#10208) Source: https://groups.google.com/d/msg/kubernetes-dev/jMPA4JzKiY4/HIx2ugvLBAAJ * fix 404 error (#10250) * Small verb tweak (#10190) Present participle, ftw. * Add AnchorJS logic for header links (#10155) * Add AnchorJS JavaScript * Remove existing inpage_heading logic * Remove underline from anchor tags * Use single icon and add touch visibility * Use paragraph link icon for AnchorJS * Update Sass to use code formatting in docsContent headers * Update header size coverage to H3-H6 * fix broken link in kubefed.md (#10254) * Update the version numbers for the X-Remote-Extra- and Impersonate-Extra- key fixes (#9827) The fix was cherry picked into 1.11.3, 1.10.7, and 1.9.11: kubernetes/kubernetes#67162 kubernetes/kubernetes#67163 kubernetes/kubernetes#67164 * fix typo (#10168) * fix typo * addressing comments. * Update setup-ha-etcd-with-kubeadm.md * fix typos (#10252) * fix description of contribute guide (#10253) * describe truncate feature about advanced audit (#10236) * describe truncate feature about advanced audit * Update audit.md * docs update to promote ScheduleDaemonSetPods to beta (#9923) * Dynamic volume limit updates for 1.12 (#10211) * add a placeholder commit * Update docs for csi volume limits * Update storage-limits.md * Add "MayRunAs" value among other GroupStrategies (#9888) * Add CoreDNS details to the customize DNS doc (#10228) * Add CoreDNS details to the customize DNS doc Rewrite the document to include more details about CoreDNS, since it's now the default from v1.12 * Address comments * Improve doc wording * Fix link * Update dns-custom-nameservers.md * Update dns-custom-nameservers.md * Fix secrets docs in 1.12 branch (#10056) * Fix secrets docs * Update secret.md * Revert CoreDNS Docs (#10319) * Revert "Add CoreDNS details to DNS Debug docs (#10201)" This reverts commit 462817a. * Revert "Add CoreDNS details to the customize DNS doc (#10228)" This reverts commit e7319ee. * Revert "coredns default (#10200)" This reverts commit 698e93b. * Add CRI installation instructions page Added cri-installation page with CRI installation instructions Referenced it from kubeadm-init and install-kubeadm pages. * kubeadm: update API types documentation for 1.12 (#10283) v1alpha2 -> v1alpha3 MasterConfiguration -> [new-api-types] * TokenRequest feature documentation (#10295) * AdvancedAuditing is now GA (#10156) xref: kubernetes/kubernetes#65862 `AdvancedAuditing` feature is GA in 1.12. This PR adjusts the related docs. * update runtime-class.md (#10332) * update runtime-class.md * Update runtime-class.md * Document cross-authorizer permissions for creating RBAC roles (#10015) * Document cross-authorizer permissions for creating RBAC roles * Update rbac.md * kubeadm: update authored content for 1.12 (reference docs and cluster creation) (#10348) * kubeadm: update authored content in reference docs for 1.12 * kubeadm: add time frame in create-cluster-kubeadm for 1.12 * add AllowedProcMountTypes and ProcMountType to docs (#9911) Signed-off-by: Jess Frazelle <[email protected]> * kubeadm: add new command line reference (#10306) Add: - placeholder files - include place holder files - include "renew" sub command - add missing tabs for "alpha phase kubelet" * Documenting SCTP support in Kubernetes (#10279) * Documenting SCTP support in Kubernetes Service, Endpoint, NetworkPolicy and Pod * Updates based on comments on the PR * kubectl expose update with SCTP support * Updated according to comments in the PR * Revert "kubectl expose update with SCTP support" This reverts commit 0d5a1e6. * TLS Bootstrap and Server Cert Rotation feature documentation (#10232) * TokenRequest feature documentation * line wrapping to make review not insane * update content for GA without major refactor * Update kubelet-tls-bootstrapping.md * Add clarifications for volume snapshots (#10296) * Update kubadm ha installation for 1.12 (#10264) * Update kubadm ha installation for 1.12 Signed-off-by: Chuck Ha <[email protected]> * update stable version Signed-off-by: Chuck Ha <[email protected]> * Update stacked control plane for v1.12 (#2) * use v1alpha3 Signed-off-by: Chuck Ha <[email protected]> * more v1alpha3 (#4) * updates Signed-off-by: Chuck Ha <[email protected]> * Document how to run in-tree cloud providers with kubeadm (#10357) Change-Id: Iab6b996a830503d74a6eb0c507c5f8ca7a39235b * kubeadm reference doc for release 1.12 (#10359) * Revert "Revert "Add CoreDNS details to DNS Debug docs (#10201)"" This reverts commit bb30f4d. * Revert "Revert "Add CoreDNS details to the customize DNS doc (#10228)"" This reverts commit bc23d45. * Revert "Revert "coredns default (#10200)"" This reverts commit 7f4350d. * add missing instruction for ha guide (#10374) Signed-off-by: Chuck Ha <[email protected]> * kubeadm - Ha upgrade updates (#10340) * Update HA upgrade docs * Adds external etcd HA upgrade guide Signed-off-by: Chuck Ha <[email protected]> * copyedit * more edits * add runasgroup in psp (#10076) * update KubeletPluginsWatcher feature gate (#10205) * generated 1.12 docs * Building Multi-arch images with Manifests (#10379) In 1.12, a variety of images used in a typical kubernetes installation have started to using manifests to better support environments with arm or ppc64le architectures. For example all images used with kubeadm by default have manifests, another would be all the tests in the conformance test suite. Here we capture the best practices for everyone to start using manifests in their own workflows. Change-Id: I5ba4c5fe55ffc9486a8251760f3352be4f2e1494 * Upgrade docs for v1.12 (#10344) * generated assets and docs * remove 1.7 * update 1.12 * update plugin documentation under docs>tasks>extend-kubectl (#10259) * update plugin documentation under docs>tasks>extend-kubectl * Update kubectl-plugins.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.