structure for manifest documentation
This commit is contained in:
parent
030ffa7bb3
commit
8051dc5e3d
|
@ -0,0 +1,25 @@
|
||||||
|
SHELL := /bin/bash -euo pipefail
|
||||||
|
|
||||||
|
config_file_name = Kube-manifest.yaml
|
||||||
|
example_config = docs/$(config_file_name)
|
||||||
|
|
||||||
|
.PHONY: all
|
||||||
|
all: docs
|
||||||
|
|
||||||
|
# In a branch, run 'make docs' to update docs with
|
||||||
|
# generated code, then merge it to master.
|
||||||
|
docs: $(example_config)
|
||||||
|
|
||||||
|
# Use kinflate to create the standard kinflate configuration
|
||||||
|
# file that appears in the website's documentation.
|
||||||
|
$(example_config): /tmp/bin/kinflate
|
||||||
|
rm -f TMP
|
||||||
|
echo "# This is a generated example; do not edit. Rebuild with 'make docs'." >> TMP
|
||||||
|
echo " " >> TMP
|
||||||
|
/tmp/bin/kinflate init
|
||||||
|
cat $(config_file_name) >> TMP
|
||||||
|
mv TMP $(example_config)
|
||||||
|
rm $(config_file_name)
|
||||||
|
|
||||||
|
/tmp/bin/kinflate:
|
||||||
|
go build -o /tmp/bin/kinflate kinflate.go
|
|
@ -0,0 +1,22 @@
|
||||||
|
# This is a generated example; do not edit. Rebuild with 'make docs'.
|
||||||
|
|
||||||
|
apiVersion: manifest.k8s.io/v1alpha1
|
||||||
|
kind: Manifest
|
||||||
|
metadata:
|
||||||
|
name: helloworld
|
||||||
|
description: helloworld does useful stuff.
|
||||||
|
namePrefix: some-prefix
|
||||||
|
# Labels to add to all objects and selectors.
|
||||||
|
# These labels would also be used to form the selector for apply --prune
|
||||||
|
# Named differently than “labels” to avoid confusion with metadata for this object
|
||||||
|
objectLabels:
|
||||||
|
app: helloworld
|
||||||
|
objectAnnotations:
|
||||||
|
note: This is an example annotation
|
||||||
|
resources: []
|
||||||
|
#- service.yaml
|
||||||
|
#- ../some-dir/
|
||||||
|
# There could also be configmaps in Base, which would make these overlays
|
||||||
|
configMapGenerator: []
|
||||||
|
# There could be secrets in Base, if just using a fork/rebase workflow
|
||||||
|
secretGenerator: []
|
|
@ -139,6 +139,8 @@ kinflate is an implementation of [DAM].
|
||||||
A _manifest_ is a file called `Kube-manifest.yaml` that
|
A _manifest_ is a file called `Kube-manifest.yaml` that
|
||||||
describes a configuration consumable by [kinflate].
|
describes a configuration consumable by [kinflate].
|
||||||
|
|
||||||
|
Here's an [example](Kube-manifest.yaml).
|
||||||
|
|
||||||
A manifest contains fields falling into these categories:
|
A manifest contains fields falling into these categories:
|
||||||
|
|
||||||
* Immediate customization instructions -
|
* Immediate customization instructions -
|
||||||
|
|
Loading…
Reference in New Issue