mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-11 17:12:51 +00:00
Redirect kustomize docs to the new unified site.
This commit is contained in:
@@ -9,3 +9,5 @@ menu:
|
||||
description: >
|
||||
Reference for Kustomize client-side APIs
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/" />
|
||||
@@ -7,6 +7,9 @@ description: >
|
||||
Glossary of terms
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/glossary/" />
|
||||
|
||||
|
||||
# Glossary
|
||||
|
||||
[CRD spec]: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
||||
|
||||
@@ -7,5 +7,6 @@ description: >
|
||||
kustomization.yaml fields and API
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/" />
|
||||
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ description: >
|
||||
Add resources from a kustomization dir.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/bases/" />
|
||||
|
||||
{{% pageinfo color="warning" %}}
|
||||
The `bases` field was deprecated in v2.1.0
|
||||
{{% /pageinfo %}}
|
||||
|
||||
@@ -6,6 +6,8 @@ description: >
|
||||
Add annotations to all resources.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/commonannotations/" />
|
||||
|
||||
Add annotations to all resources. If the annotation key is already present on the resource,
|
||||
the value will be overridden.
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Add labels and selectors to add all resources.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/commonlabels/" />
|
||||
|
||||
|
||||
Add labels and selectors to all resources. If the label key already is present on the resource,
|
||||
the value will be overridden.
|
||||
|
||||
|
||||
@@ -6,4 +6,7 @@ description: >
|
||||
Compose kustomizations.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/components/" />
|
||||
|
||||
|
||||
*Coming soon*
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Generate ConfigMap resources.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/configmapgenerator/" />
|
||||
|
||||
|
||||
Each entry in this list results in the creation of
|
||||
one ConfigMap resource (it's a generator of n maps).
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Adding CRD support
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/crds/" />
|
||||
|
||||
|
||||
Each entry in this list should be a relative path to
|
||||
a file for custom resource definition (CRD).
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@ description: >
|
||||
[Secret](/kustomize/api-reference/kustomization/secretgenerator) generators.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/generatoroptions/" />
|
||||
|
||||
|
||||
Additionally, generatorOptions can be set on a per resource level within each
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Modify the name, tags and/or digest for images.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/images/" />
|
||||
|
||||
|
||||
Images modify the name, tags and/or digest for images without creating patches. E.g. Given this
|
||||
kubernetes Deployment fragment:
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Prepends the value to the names of all resources and references.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/nameprefix/" />
|
||||
|
||||
|
||||
```yaml
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Adds namespace to all resources.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/namespace/" />
|
||||
|
||||
|
||||
```yaml
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Appends the value to the names of all resources and references.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/namesuffix/" />
|
||||
|
||||
|
||||
```yaml
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Patch resources
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/patches/" />
|
||||
|
||||
|
||||
[strategic merge]: /kustomize/api-reference/glossary#patchstrategicmerge
|
||||
[JSON]: /kustomize/api-reference/glossary#patchjson6902
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Patch resources using the strategic merge patch standard.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/" />
|
||||
|
||||
|
||||
Each entry in this list should be either a relative
|
||||
file path or an inline content
|
||||
resolving to a partial or complete resource
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Patch resources using the [json 6902 standard](https://tools.ietf.org/html/rfc6902)
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/" />
|
||||
|
||||
|
||||
Each entry in this list should resolve to a kubernetes object and a JSON patch that will be applied
|
||||
to the object.
|
||||
The JSON patch is documented at <https://tools.ietf.org/html/rfc6902>
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Change the number of replicas for a resource.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/replicas/" />
|
||||
|
||||
|
||||
Given this kubernetes Deployment fragment:
|
||||
|
||||
```
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Resources to include.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/resources/" />
|
||||
|
||||
|
||||
Each entry in this list must be a path to a _file_, or a path (or URL) referring to another
|
||||
kustomization _directory_, e.g.
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Generate Secret resources.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/secretegenerator/" />
|
||||
|
||||
|
||||
Each entry in the argument list results in the creation of one Secret resource (it's a generator of N secrets).
|
||||
|
||||
This works like the [configMapGenerator](/kustomize/api-reference/kustomization/configmapgenerator).
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Substitute name references.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/references/kustomize/vars/" />
|
||||
|
||||
|
||||
Vars are used to capture text from one resource's field
|
||||
and insert that text elsewhere - a reflection feature.
|
||||
|
||||
|
||||
@@ -5,3 +5,5 @@ menu:
|
||||
main:
|
||||
weight: 80
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/blog/" />
|
||||
|
||||
@@ -4,3 +4,4 @@ linkTitle: "Releases"
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/blog/releases" />
|
||||
|
||||
@@ -7,4 +7,7 @@ menu:
|
||||
weight: 99
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/" />
|
||||
|
||||
|
||||
Follow are resources for Kustomize contributors.
|
||||
|
||||
@@ -7,6 +7,8 @@ description: >
|
||||
How to file bugs and fix Kustomize bugs
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/bugs" />
|
||||
|
||||
|
||||
[krusty package]: https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty
|
||||
[reusable custom transformer test]: https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty/customconfigreusable_test.go
|
||||
|
||||
@@ -7,6 +7,9 @@ description: >
|
||||
Joining SIG-CLI and the Kubernetes community
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/community" />
|
||||
|
||||
|
||||
[CLI special interest group]: https://github.com/kubernetes/community/tree/master/sig-cli#cli-special-interest-group
|
||||
[contributor roles]: https://github.com/kubernetes/community/blob/master/community-membership.md#community-membership
|
||||
[mailing list]: https://groups.google.com/forum/#!forum/kubernetes-sig-cli
|
||||
|
||||
@@ -7,6 +7,9 @@ description: >
|
||||
How to make Kustomize docs contributions
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/docs" />
|
||||
|
||||
|
||||
Kustomize uses [Docsy](https://www.docsy.dev) for the site, and was
|
||||
forked from the [docsy-example](https://github.com/google/docsy-example)
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ weight: 21
|
||||
description: >
|
||||
How to contribute features
|
||||
---
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/features" />
|
||||
|
||||
|
||||
[issue]: https://github.com/kubernetes-sigs/kustomize/issues
|
||||
[sig-cli]: /kustomize/contributing/community/
|
||||
|
||||
@@ -7,6 +7,9 @@ description: >
|
||||
How to modify Kustomize
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/howitworks" />
|
||||
|
||||
|
||||
{{% pageinfo color="info" %}}
|
||||
To build kustomize using the locally modified modules, `replace` statements must be added to
|
||||
the `kustomize/go.mod`.
|
||||
|
||||
@@ -6,6 +6,7 @@ weight: 50
|
||||
description: >
|
||||
How to develop on MacOS
|
||||
---
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/mac" />
|
||||
|
||||
First install the tools to build and run tests
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ description: >
|
||||
How to develop on Windows
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/windows" />
|
||||
|
||||
This is the PowerShell script to run all go tests for Kustomize on a windows based platform which mimics /build/pre-commit.sh
|
||||
|
||||
## Pre-Reqs
|
||||
|
||||
@@ -7,6 +7,8 @@ menu:
|
||||
weight: 70
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/faq/kustomize/" />
|
||||
|
||||
## kubectl doesn't have the latest kustomize, when will it be updated?
|
||||
|
||||
TLDR: This is blocked on either moving kubectl into its own repo, or changing its dependencies. ETA k8s ~1.20.
|
||||
|
||||
@@ -7,6 +7,8 @@ description: >
|
||||
Eschewed Features
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/faq/kustomize/eschewedfeatures/" />
|
||||
|
||||
The maintainers established this list to
|
||||
place bounds on the kustomize feature
|
||||
set. The bounds can be changed with
|
||||
|
||||
@@ -5,6 +5,8 @@ weight: 99
|
||||
type: docs
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/faq/kustomize/versioningpolicy/" />
|
||||
|
||||
Running `kustomize` means one is running a
|
||||
particular version of a program (a CLI), using a
|
||||
particular version of underlying packages (a Go
|
||||
|
||||
@@ -9,3 +9,4 @@ menu:
|
||||
description: >
|
||||
Reference for Kustomize usage and best practices
|
||||
---
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/config_management" />
|
||||
@@ -7,6 +7,9 @@ description: >
|
||||
Workflow for bespoke applications
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/config_management/bespoke/" />
|
||||
|
||||
|
||||
In this workflow, all configuration (resource YAML) files are owned by the user.
|
||||
No content is incorporated from version control repositories owned by others.
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Kustomize components guide
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/config_management/components/" />
|
||||
|
||||
|
||||
As of ``v3.7.0`` Kustomize supports a special type of kustomization that allows
|
||||
one to define reusable pieces of configuration logic that can be included from
|
||||
multiple overlays.
|
||||
|
||||
@@ -7,6 +7,9 @@ description: >
|
||||
Workflow for off the shelf applications
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/config_management/offtheshelf/" />
|
||||
|
||||
|
||||
In this workflow, all files are owned by the user and maintained in a repository under their control, but
|
||||
they are based on an [off-the-shelf] configuration that is periodically consulted for updates.
|
||||
|
||||
|
||||
@@ -7,6 +7,8 @@ description: >
|
||||
Kustomize plugins guide
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/plugins" />
|
||||
|
||||
Kustomize offers a plugin framework allowing people to write their own resource _generators_
|
||||
and _transformers_.
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Builtin Plugins
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/builtins" />
|
||||
|
||||
|
||||
# Builtin Plugins
|
||||
|
||||
A list of kustomize's builtin plugins - both
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Exec plugin on linux in 60 seconds
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/execpluginguidedexample" />
|
||||
|
||||
|
||||
This is a (no reading allowed!) 60 second copy/paste guided
|
||||
example. Full plugin docs [here](..).
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ description: >
|
||||
Go plugin Caveats
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/goplugincaveats" />
|
||||
|
||||
[plugin package]: https://golang.org/pkg/plugin
|
||||
[Go modules]: https://github.com/golang/go/wiki/Modules
|
||||
[ELF]: https://en.wikipedia.org/wiki/Executable_and_Linkable_Format
|
||||
|
||||
@@ -6,6 +6,9 @@ description: >
|
||||
Go plugin example
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/gopluginguidedexample" />
|
||||
|
||||
|
||||
# Go Plugin Guided Example for Linux
|
||||
|
||||
[SopsEncodedSecrets repository]: https://github.com/monopole/sopsencodedsecrets
|
||||
|
||||
@@ -7,3 +7,5 @@ menu:
|
||||
main:
|
||||
weight: 10
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/installation/kustomize/" />
|
||||
|
||||
@@ -7,6 +7,8 @@ description: >
|
||||
Install Kustomize by downloading precompiled binaries.
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/installation/kustomize/binaries/" />
|
||||
|
||||
Binaries at various versions for linux, MacOs and Windows are published on the [releases page].
|
||||
|
||||
The following [script] detects your OS and downloads the appropriate kustomize binary to your
|
||||
|
||||
@@ -7,6 +7,9 @@ description: >
|
||||
Install Kustomize for Windows using Chocolatey
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/installation/kustomize/chocolatey/" />
|
||||
|
||||
|
||||
```
|
||||
choco install kustomize
|
||||
```
|
||||
|
||||
@@ -7,6 +7,9 @@ description: >
|
||||
Install Kustomize for MacOS using Homebrew or MacPorts
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/installation/kustomize/homebrew/" />
|
||||
|
||||
|
||||
For [Homebrew](https://brew.sh) users:
|
||||
|
||||
```
|
||||
|
||||
@@ -7,6 +7,8 @@ description: >
|
||||
Install Kustomize from the Go source code
|
||||
---
|
||||
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/installation/kustomize/source/" />
|
||||
|
||||
Requires [Go] to be installed.
|
||||
|
||||
## Install the kustomize CLI from source without cloning the repo
|
||||
|
||||
Reference in New Issue
Block a user