From 5a4e2c289847a34770feafb00fd9b9af71bcec35 Mon Sep 17 00:00:00 2001 From: Naveen Gogineni Date: Sat, 5 Sep 2020 11:36:49 -0400 Subject: [PATCH] Add basic structure for command line options for users to be able to place info into them --- site/content/en/guides/cmd/_index.md | 7 ++++ site/content/en/guides/cmd/build/_index.md | 7 ++++ site/content/en/guides/cmd/cfg/_index.md | 7 ++++ site/content/en/guides/cmd/create/_index.md | 7 ++++ site/content/en/guides/cmd/edit/_index.md | 7 ++++ site/content/en/guides/cmd/fn/_index.md | 7 ++++ site/content/en/guides/cmd/help/_index.md | 42 +++++++++++++++++++ .../guides/cmd/install-completion/_index.md | 7 ++++ site/content/en/guides/cmd/live/_index.md | 7 ++++ site/content/en/guides/cmd/version/_index.md | 14 +++++++ 10 files changed, 112 insertions(+) create mode 100644 site/content/en/guides/cmd/_index.md create mode 100644 site/content/en/guides/cmd/build/_index.md create mode 100644 site/content/en/guides/cmd/cfg/_index.md create mode 100644 site/content/en/guides/cmd/create/_index.md create mode 100644 site/content/en/guides/cmd/edit/_index.md create mode 100644 site/content/en/guides/cmd/fn/_index.md create mode 100644 site/content/en/guides/cmd/help/_index.md create mode 100644 site/content/en/guides/cmd/install-completion/_index.md create mode 100644 site/content/en/guides/cmd/live/_index.md create mode 100644 site/content/en/guides/cmd/version/_index.md diff --git a/site/content/en/guides/cmd/_index.md b/site/content/en/guides/cmd/_index.md new file mode 100644 index 000000000..572ba0f1f --- /dev/null +++ b/site/content/en/guides/cmd/_index.md @@ -0,0 +1,7 @@ +--- +title: "Command Line Options" +linkTitle: "Command Line Options" +type: docs +description: > + Usage of command line options +--- diff --git a/site/content/en/guides/cmd/build/_index.md b/site/content/en/guides/cmd/build/_index.md new file mode 100644 index 000000000..0e4ca4bfa --- /dev/null +++ b/site/content/en/guides/cmd/build/_index.md @@ -0,0 +1,7 @@ +--- +title: "build" +linkTitle: "build" +type: docs +description: > + Print configuration per contents of kustomization.yaml +--- diff --git a/site/content/en/guides/cmd/cfg/_index.md b/site/content/en/guides/cmd/cfg/_index.md new file mode 100644 index 000000000..f22ac1b6d --- /dev/null +++ b/site/content/en/guides/cmd/cfg/_index.md @@ -0,0 +1,7 @@ +--- +title: "cfg" +linkTitle: "cfg" +type: docs +description: > + Commands for reading and writing configuration. +--- diff --git a/site/content/en/guides/cmd/create/_index.md b/site/content/en/guides/cmd/create/_index.md new file mode 100644 index 000000000..d139a8237 --- /dev/null +++ b/site/content/en/guides/cmd/create/_index.md @@ -0,0 +1,7 @@ +--- +title: "create" +linkTitle: "create" +type: docs +description: > + Create a new kustomization in the current directory +--- diff --git a/site/content/en/guides/cmd/edit/_index.md b/site/content/en/guides/cmd/edit/_index.md new file mode 100644 index 000000000..d649691c5 --- /dev/null +++ b/site/content/en/guides/cmd/edit/_index.md @@ -0,0 +1,7 @@ +--- +title: "edit" +linkTitle: "edit" +type: docs +description: > + Edits a kustomization file +--- diff --git a/site/content/en/guides/cmd/fn/_index.md b/site/content/en/guides/cmd/fn/_index.md new file mode 100644 index 000000000..e5d4a973a --- /dev/null +++ b/site/content/en/guides/cmd/fn/_index.md @@ -0,0 +1,7 @@ +--- +title: "fn" +linkTitle: "fn" +type: docs +description: > + Commands for running functions against configuration +--- diff --git a/site/content/en/guides/cmd/help/_index.md b/site/content/en/guides/cmd/help/_index.md new file mode 100644 index 000000000..0b183f19a --- /dev/null +++ b/site/content/en/guides/cmd/help/_index.md @@ -0,0 +1,42 @@ +--- +title: "help" +linkTitle: "help" +type: docs +description: > + Help about any command +--- + +> ``` +> kustomize help +> +> Manages declarative configuration of Kubernetes. +> See https://sigs.k8s.io/kustomize +> +> Usage: +> kustomize [command] +> +> Available Commands: +> build Print configuration per contents of kustomization.yaml +> cfg Commands for reading and writing configuration. +> create Create a new kustomization in the current directory +> edit Edits a kustomization file +> fn Commands for running functions against configuration. +> help Help about any command +> install-completion Install shell completion. +> live Commands for reading and writing resources to a cluster. +> version Prints the kustomize version +> +> Flags: +> -h, --help help for kustomize +> --stack-trace print a stack-trace on error +> +> Additional help topics: +> kustomize docs-fn [Alpha] Documentation for developing and invoking Configuration Functions. +> kustomize docs-fn-spec [Alpha] Documentation for Configuration Functions Specification. +> kustomize docs-io-annotations [Alpha] Documentation for annotations used by io. +> kustomize docs-merge [Alpha] Documentation for merging Resources (2-way merge). +> kustomize docs-merge3 [Alpha] Documentation for merging Resources (3-way merge). +> kustomize tutorials-command-basics [Alpha] Tutorials for using basic config commands. +> kustomize tutorials-function-basics [Alpha] Tutorials for using functions. +> +> Use "kustomize [command] --help" for more information about a command. \ No newline at end of file diff --git a/site/content/en/guides/cmd/install-completion/_index.md b/site/content/en/guides/cmd/install-completion/_index.md new file mode 100644 index 000000000..a4cfec63a --- /dev/null +++ b/site/content/en/guides/cmd/install-completion/_index.md @@ -0,0 +1,7 @@ +--- +title: "install-completion" +linkTitle: "install-completion" +type: docs +description: > + Installs shell completion +--- diff --git a/site/content/en/guides/cmd/live/_index.md b/site/content/en/guides/cmd/live/_index.md new file mode 100644 index 000000000..6ba80d260 --- /dev/null +++ b/site/content/en/guides/cmd/live/_index.md @@ -0,0 +1,7 @@ +--- +title: "live" +linkTitle: "live" +type: docs +description: > + Commands for reading and writing resources to a cluster. +--- diff --git a/site/content/en/guides/cmd/version/_index.md b/site/content/en/guides/cmd/version/_index.md new file mode 100644 index 000000000..ec1bda4db --- /dev/null +++ b/site/content/en/guides/cmd/version/_index.md @@ -0,0 +1,14 @@ +--- +title: "version" +linkTitle: "version" +type: docs +description: > + Prints the kustomize version +--- + +Prints the current kustomize version + +> ``` +> kustomize version +> {Version:kustomize/v3.8.1 GitCommit:0b359d0ef0272e6545eda0e99aacd63aef99c4d0 BuildDate:2020-07-16T00:58:46Z GoOs:linux GoArch:amd64} +> ``` \ No newline at end of file