github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-13 13:55:41 +00:00
Code Issues Projects Releases Wiki Activity

Remove redundant comment and improve documentation.

Browse Source 
The comment is also present in lines 143-145 where it makes more sense.
This commit is contained in:
Rohit Agarwal 2017-10-27 12:50:09 -07:00
parent 55e216f56e
commit 3de7e5ab40
2 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
cluster/addons/addon-manager/README.md
View File

@ -1,26 +1,27 @@
### Addon-manager ### Addon-manager
addon-manager manages two classes of addons with given template files. addon-manager manages two classes of addons with given template files in
`$ADDON_PATH` (default `/etc/kubernetes/addons/`).
- Addons with label `addonmanager.kubernetes.io/mode=Reconcile` will be periodically - Addons with label `addonmanager.kubernetes.io/mode=Reconcile` will be periodically
reconciled. Direct manipulation to these addons through apiserver is discouraged because reconciled. Direct manipulation to these addons through apiserver is discouraged because
addon-manager will bring them back to the original state. In particular: addon-manager will bring them back to the original state. In particular:
- Addon will be re-created if it is deleted. - Addon will be re-created if it is deleted.
- Addon will be reconfigured to the state given by the supplied fields in the template - Addon will be reconfigured to the state given by the supplied fields in the template
file periodically. file periodically.
- Addon will be deleted when its manifest file is deleted. - Addon will be deleted when its manifest file is deleted from the `$ADDON_PATH`.
- Addons with label `addonmanager.kubernetes.io/mode=EnsureExists` will be checked for - Addons with label `addonmanager.kubernetes.io/mode=EnsureExists` will be checked for
existence only. Users can edit these addons as they want. In particular: existence only. Users can edit these addons as they want. In particular:
- Addon will only be created/re-created with the given template file when there is no - Addon will only be created/re-created with the given template file when there is no
instance of the resource with that name. instance of the resource with that name.
- Addon will not be deleted when the manifest file is deleted. - Addon will not be deleted when the manifest file is deleted from the `$ADDON_PATH`.
Notes: Notes:
- Label `kubernetes.io/cluster-service=true` is deprecated (only for Addon Manager). - Label `kubernetes.io/cluster-service=true` is deprecated (only for Addon Manager).
In future release (after one year), Addon Manager may not respect it anymore. Addons In future release (after one year), Addon Manager may not respect it anymore. Addons
have this label but without `addonmanager.kubernetes.io/mode=EnsureExists` will be have this label but without `addonmanager.kubernetes.io/mode=EnsureExists` will be
treated as "reconcile class addons" for now. treated as "reconcile class addons" for now.
- Resources under $ADDON_PATH (default `/etc/kubernetes/addons/`) needs to have either one - Resources under `$ADDON_PATH` need to have either one of these two labels.
of these two labels. Meanwhile namespaced resources need to be in `kube-system` namespace. Meanwhile namespaced resources need to be in `kube-system` namespace.
Otherwise it will be omitted. Otherwise it will be omitted.
- The above label and namespace rule does not stand for `/opt/namespace.yaml` and - The above label and namespace rule does not stand for `/opt/namespace.yaml` and
resources under `/etc/kubernetes/admission-controls/`. addon-manager will attempt to resources under `/etc/kubernetes/admission-controls/`. addon-manager will attempt to

3
cluster/addons/addon-manager/kube-addons.sh
View File

@ -26,9 +26,6 @@
# 3. Kubectl prints the output to stderr (the output should be captured and then # 3. Kubectl prints the output to stderr (the output should be captured and then
# logged) # logged)
# The business logic for whether a given object should be created
# was already enforced by salt, and /etc/kubernetes/addons is the
# managed result is of that. Start everything below that directory.
KUBECTL=${KUBECTL_BIN:-/usr/local/bin/kubectl} KUBECTL=${KUBECTL_BIN:-/usr/local/bin/kubectl}
KUBECTL_OPTS=${KUBECTL_OPTS:-} KUBECTL_OPTS=${KUBECTL_OPTS:-}