mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-30 01:46:23 +00:00
Add generator kustomization references (#5447)
* Initial configMapGenerator ref * Draft configMapGenerator options * ConfigMapArgs * Add sources * Begin to restructure generator spec * Add ObjectMeta * Draft kustomization.md * Draft kustomization file links * Move bases weight * Update generatorArgs link to commmon generatorOptions * Remove api/generators for now * Update generatorOptions * Add generatorArgs header * Add secretGenerator * Remove ObjectMeta for now * Draft generators * Fix secretGenerator * Cleanup * Add include shortcode, cleanup generators * Use common includes * Update object metadata description * spelling * Improve args description
This commit is contained in:
48
site/content/en/docs/Reference/API/included/generatorargs.md
Normal file
48
site/content/en/docs/Reference/API/included/generatorargs.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: "GeneratorArgs"
|
||||
weight: 2
|
||||
date: 2023-11-15
|
||||
description: >
|
||||
GeneratorArgs contains arguments common to generators.
|
||||
headless: true
|
||||
_build:
|
||||
list: never
|
||||
render: never
|
||||
publishResources: false
|
||||
---
|
||||
|
||||
* **name** (string), optional
|
||||
|
||||
Name of the generated resource. A hash suffix will be added to the Name by default.
|
||||
|
||||
* **namespace** (string), optional
|
||||
|
||||
Namespace of the generated resource.
|
||||
|
||||
* **behavior** (string), optional
|
||||
|
||||
Behavior of generated resource, must be one of:
|
||||
|
||||
* **create**: Create new resource
|
||||
* **replace**: Replace existing resource
|
||||
* **merge**: Merge with existing resource
|
||||
|
||||
* **literals** ([]string), optional
|
||||
|
||||
List of string literal pair sources. Each literal source should be a key and literal value, e.g. `key=value`.
|
||||
|
||||
* **files** ([]string), optional
|
||||
|
||||
List of files paths to use in creating a list of key value pairs. A source should be in the form [{key}=]{path}. If the `key=` argument is not provided, the key is the path's basename. If the `key=` argument is provided, it becomes the key. The value is the file contents. Specifying a directory will iterate each named file in the directory whose basename is a valid resource key.
|
||||
|
||||
* **envs** ([]string), optional
|
||||
|
||||
List of file paths. The contents of each file should be one key=value pair per line. Additionally, npm `.env` and `.ini` files are supported.
|
||||
|
||||
* **env** (string), optional
|
||||
|
||||
Env is the singular form of `envs`. This is merged with `env` on edits with `kustomize fix` for consistency with `literals` and `files`.
|
||||
|
||||
* **options** ([GeneratorOptions]({{< ref "../kustomization%20file/generatorOptions.md" >}}))
|
||||
|
||||
Options override global [generatorOptions]({{< ref "../kustomization%20file/generatorOptions.md" >}}) field.
|
||||
Reference in New Issue
Block a user