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

add glossary

This commit is contained in:
Jeffrey Regan 2018-04-02 11:51:23 -07:00
parent 6f94496d77
commit 6a98129deb
2 changed files with 16 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cmd/kinflate/README.md
View File

@ -1,7 +1,7 @@
# kinflate # kinflate
[_kubectl apply_]: https://goo.gl/UbCRuf [_kubectl apply_]: glossary.md#apply
[DAM]: glossary#delcarative-application-management [DAM]: glossary.md#declarative-application-management
[workflows]: workflows.md [workflows]: workflows.md
`kinflate` is a command line tool supporting `kinflate` is a command line tool supporting

32
cmd/kinflate/glossary.md
View File

@ -3,7 +3,6 @@
[DAM]: #declarative-application-management [DAM]: #declarative-application-management
[JSON]: https://www.json.org/ [JSON]: https://www.json.org/
[Resource]: #resource [Resource]: #resource
[TypeMeta]: https://github.com/kubernetes/kubernetes/blob/master/pkg/api/unversioned/types.go
[YAML]: http://www.yaml.org/start.html [YAML]: http://www.yaml.org/start.html
[application]: #application [application]: #application
[apply]: #apply [apply]: #apply
@ -115,8 +114,11 @@ of k8s clusters.
An _instance_ is the outcome, in a cluster, of applying An _instance_ is the outcome, in a cluster, of applying
an [overlay] to a [base]. an [overlay] to a [base].
> E.g. a _staging_ and _production_ overlay both modify Roughly synonymous with [overlay].
> some common base to create distinct instances.
> For example, a _staging_ and _production_ overlay
> both modify some common base to create distinct
> instances.
> >
> The _staging_ instance is the set of resources > The _staging_ instance is the set of resources
> exposed to quality assurance testing, or to some > exposed to quality assurance testing, or to some
@ -128,12 +130,6 @@ an [overlay] to a [base].
> deployments with a large number of replicas and higher > deployments with a large number of replicas and higher
> cpu and memory requests. > cpu and memory requests.
In a best practices end-user target layout, a directory
called _overlays_ (or _instances_) contains overlays in
its sub-directories.
Roughly synonymous with [overlay].
## kinflate ## kinflate
@ -155,16 +151,18 @@ describes a configuration consumable by [kinflate].
A manifest contains fields falling into these categories: A manifest contains fields falling into these categories:
* (_TBD_) Standard k8s API kind-version fields, e.g. [TypeMeta]. * Immediate customization instructions -
* Immediate customization instructions - _nameprefix_, _labelprefix_, etc. _nameprefix_, _labelprefix_, etc.
* Resource _generators_ for configmaps and secrets. * Resource _generators_ for configmaps and secrets.
* Cargo - _names of external files_ in these categories: * Cargo - _names of external files_ in these categories:
* [resources] - completely specified k8s API objects, * [resources] - completely specified k8s API objects,
e.g. `deployment.yaml`, `configmap.yaml`, etc. e.g. `deployment.yaml`, `configmap.yaml`, etc.
* [patches] - _partial_ resources that modify full * [patches] - _partial_ resources that modify full
resources defined in a [base] (only meaningful in an [overlay]). resources defined in a [base]
* [bases] - path to a directory containing a [manifest] (only meaningful in an [overlay]).
(only meaningful in an [overlay]). * [bases] - path to a directory containing
a [manifest] (only meaningful in an [overlay]).
* (_TBD_) Standard k8s API kind-version fields.
## off-the-shelf configuration ## off-the-shelf configuration
@ -212,10 +210,8 @@ One configures the cluser like this:
> kinflate inflate -f ldap/overlays/production | kubectl apply -f - > kinflate inflate -f ldap/overlays/production | kubectl apply -f -
> ``` > ```
etc. Usage of the base is implicit (the overlay's manifest
points to the base).
Usage of the base is implicit (one would need to
examine the manifests to see it).
An overlay may act as a base to another overlay. An overlay may act as a base to another overlay.