Skip to content

Commit 26a3273

Browse files
rob8714rob8714
committed
Migrate command line docs from kustomize repo to cli-experimental
1 parent a8eef26 commit 26a3273

File tree

12 files changed

+158
-3
lines changed

12 files changed

+158
-3
lines changed

‎site/content/en/references/kustomize/builtins/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Kustomize Built-Ins"
33
linkTitle: "Built-Ins"
4-
weight: 3
4+
weight: 1
55
type: docs
66
description: >
77
Reference docs for Kustomize's built-in transformers and generators

‎site/content/en/references/kustomize/cmd/_index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "Command Line Options"
3+
linkTitle: "Command Line Options"
4+
type: docs
5+
weight: 2
6+
description: >
7+
Usage of command line options
8+
---

‎site/content/en/references/kustomize/cmd/build/_index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "kustomize build"
3+
linkTitle: "build"
4+
type: docs
5+
weight: 2
6+
description: >
7+
Print configuration per contents of kustomization.yaml
8+
---

‎site/content/en/references/kustomize/cmd/cfg/_index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "kustomize cfg"
3+
linkTitle: "cfg"
4+
type: docs
5+
weight: 3
6+
description: >
7+
Commands for reading and writing configuration
8+
---

‎site/content/en/references/kustomize/cmd/completion/_index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "kustomize completion"
3+
linkTitle: "completion"
4+
type: docs
5+
weight: 3
6+
description: >
7+
Generate shell completion script
8+
---

‎site/content/en/references/kustomize/cmd/create/_index.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "kustomize create"
3+
linkTitle: "create"
4+
type: docs
5+
weight: 4
6+
description: >
7+
Create a new kustomization in the current directory
8+
---
9+
10+
The `kustomize create` command will create a new kustomization in the current directory.
11+
12+
When run without any flags the command will create an empty `kustomization.yaml` file that can then be updated manually or with the `kustomize edit` sub-commands.
13+
14+
Example command:
15+
16+
```
17+
kustomize create --namespace=myapp --resources=deployment.yaml,service.yaml --labels=app:myapp
18+
```
19+
20+
Output from example command:
21+
22+
```
23+
apiVersion: kustomize.config.k8s.io/v1beta1
24+
kind: Kustomization
25+
resources:
26+
- deployment.yaml
27+
- service.yaml
28+
namespace: myapp
29+
commonLabels:
30+
app: myapp
31+
```
32+
33+
### Detecting resources
34+
35+
> NOTE: Resource detection will not follow symlinks.
36+
37+
```
38+
Flags:
39+
--annotations string Add one or more common annotations.
40+
--autodetect Search for kubernetes resources in the current directory to be added to the kustomization file.
41+
-h, --help help for create
42+
--labels string Add one or more common labels.
43+
--nameprefix string Sets the value of the namePrefix field in the kustomization file.
44+
--namespace string Set the value of the namespace field in the customization file.
45+
--namesuffix string Sets the value of the nameSuffix field in the kustomization file.
46+
--recursive Enable recursive directory searching for resource auto-detection.
47+
--resources string Name of a file containing a file to add to the kustomization file.
48+
49+
Global Flags:
50+
--stack-trace print a stack-trace on error
51+
```

‎site/content/en/references/kustomize/cmd/edit/_index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "kustomize edit"
3+
linkTitle: "edit"
4+
type: docs
5+
weight: 5
6+
description: >
7+
Edits a kustomization file
8+
---

‎site/content/en/references/kustomize/cmd/fn/_index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "kustomize fn"
3+
linkTitle: "fn"
4+
type: docs
5+
weight: 6
6+
description: >
7+
Commands for running functions against configuration
8+
---

‎site/content/en/references/kustomize/cmd/help/_index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "kustomize help"
3+
linkTitle: "help"
4+
type: docs
5+
weight: 7
6+
description: >
7+
Help about any command
8+
---
9+
10+
```
11+
kustomize help
12+
13+
Manages declarative configuration of Kubernetes.
14+
See https://sigs.k8s.io/kustomize
15+
16+
Usage:
17+
kustomize [command]
18+
19+
Available Commands:
20+
build Build a kustomization target from a directory or URL.
21+
cfg Commands for reading and writing configuration.
22+
completion Generate shell completion script
23+
create Create a new kustomization in the current directory
24+
edit Edits a kustomization file
25+
fn Commands for running functions against configuration.
26+
help Help about any command
27+
version Prints the kustomize version
28+
29+
Flags:
30+
-h, --help help for kustomize
31+
--stack-trace print a stack-trace on error
32+
33+
Additional help topics:
34+
kustomize docs-fn [Alpha] Documentation for developing and invoking Configuration Functions.
35+
kustomize docs-fn-spec [Alpha] Documentation for Configuration Functions Specification.
36+
kustomize docs-io-annotations [Alpha] Documentation for annotations used by io.
37+
kustomize docs-merge [Alpha] Documentation for merging Resources (2-way merge).
38+
kustomize docs-merge3 [Alpha] Documentation for merging Resources (3-way merge).
39+
kustomize tutorials-command-basics [Alpha] Tutorials for using basic config commands.
40+
kustomize tutorials-function-basics [Alpha] Tutorials for using functions.
41+
42+
Use "kustomize [command] --help" for more information about a command.
43+
```

‎site/content/en/references/kustomize/cmd/version/_index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "kustomize version"
3+
linkTitle: "version"
4+
type: docs
5+
weight: 8
6+
description: >
7+
Prints the kustomize version
8+
---
9+
10+
```
11+
kustomize version
12+
{Version:kustomize/v4.5.2 GitCommit:9091919699baf1c5a5bf71b32ca73a993e98088b BuildDate:2022-02-09T23:26:42Z GoOs:linux GoArch:amd64}
13+
```

‎site/content/en/references/kustomize/glossary/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Glossary"
33
linkTitle: "Glossary"
44
type: docs
5-
weight: 1
5+
weight: 3
66
description: >
77
Glossary of terms
88
---

‎site/content/en/references/kustomize/kustomization/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "The Kustomization File"
33
linkTitle: "kustomization"
44
type: docs
5-
weight: 2
5+
weight: 4
66
description: >
77
An overview of the content of a kustomization file.
88
---

0 commit comments

Comments
 (0)