kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

config: move config proposal to developer docs 

* strip some of the design proposal cruft
* make recommendation on config group naming
This commit is contained in:
Mike Danese 2017-10-30 11:27:35 -07:00
parent a0d81523e3
commit c9c9a94c2a
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
contributors/design-proposals/config-conventions.md → contributors/devel/component-config-conventions.md
View File

@ -1,6 +1,4 @@
# Component Configuration Convetions # Component Configuration Conventions
Author: Mike Danese (@mikedanese)
# Objective # Objective
@ -20,10 +18,8 @@ flags. Command line driven configuration poses certain problems which are
discussed below. Attempts to improve component configuration as a whole have discussed below. Attempts to improve component configuration as a whole have
been slow to make progress and have petered out (ref componentconfig api group, been slow to make progress and have petered out (ref componentconfig api group,
configmap driven config issues). Some component owners have made use case configmap driven config issues). Some component owners have made use case
specific improvements on a per-need basis (ref @mtaufen kubelet configuration, specific improvements on a per-need basis. Various comments in issues recommend
@bsalamat scheduling policy configuration). Various comments in issues subsets of best design practice but no coherent, complete story exists.
recommend subsets of best design practice but no coherent, complete story
exists.
## Pain Points of Current Configuration ## Pain Points of Current Configuration
@ -110,14 +106,17 @@ whether alternatives might be a better fit.
### Versioning Configuration ### Versioning Configuration
We create configuration API groups per component that live in the source tree We create configuration API groups per component that live in the source tree of
of the component. Each component has its own API group for configuration. the component. Each component has its own API group for configuration.
Components will use the same API machinery that we use for other API groups. Components will use the same API machinery that we use for other API groups.
Configuration API serialization doesn't have the same performance requirements Configuration API serialization doesn't have the same performance requirements
as other APIs so much of the codegen can be avoided (e.g. ugorji, generated as other APIs so much of the codegen can be avoided (e.g. ugorji, generated
conversions) and we can instead fallback to the reflection based conversions) and we can instead fallback to the reflection based implementations
implementations where they exist. where they exist.
Configuration API groups for component config should be named according to the
scheme `<component>.config.k8s.io`. The `.config.k8s.io` suffix serves to
disambiguate types of config API groups from served APIs.
### Retrieving Configuration ### Retrieving Configuration
@ -136,7 +135,7 @@ Group related options into distinct objects and subobjects. Instead of writing:
```yaml ```yaml
kind: KubeProxyConfiguration kind: KubeProxyConfiguration
apiVersion: kubeproxy/v1beta3 apiVersion: kubeproxy.config.k8s.io/v1beta3
ipTablesSyncPeriod: 2 ipTablesSyncPeriod: 2
ipTablesConntrackHashSize: 2 ipTablesConntrackHashSize: 2
ipTablesConntrackTableSize: 2 ipTablesConntrackTableSize: 2
@ -146,7 +145,7 @@ Write:
```yaml ```yaml
kind: KubeProxyConfiguration kind: KubeProxyConfiguration
apiVersion: kubeproxy/v1beta3 apiVersion: kubeproxy.config.k8s.io/v1beta3
ipTables: ipTables:
syncPeriod: 2 syncPeriod: 2
conntrack: conntrack: