kapitan 0.35.2.dev10__tar.gz → 0.35.2.dev11__tar.gz

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kapitan
-Version: 0.35.2.dev10
+Version: 0.35.2.dev11
 Summary: Generic templated configuration management for Kubernetes, Terraform and other things
 Project-URL: Homepage, https://kapitan.dev
 Project-URL: Repository, https://github.com/kapicorp/kapitan

kapitan-0.35.2.dev11/docs/FAQ.md

@@ -0,0 +1,66 @@
+---
+comments: true
+title: "Kapitan FAQ: Common Questions About Inventory, Compile, and Secrets"
+description: "Find answers to frequently asked questions about Kapitan inventory, targets, classes, compilation, references, secrets, and supported input types."
+---
+
+# :kapitan-logo: **Kapitan FAQ**
+
+## Why do I need Kapitan?
+
+See the blog post [Why do I need **Kapitan**?](pages/blog/posts/2022-12-04.md#why-do-i-need-kapitan) for a detailed explanation of the problems Kapitan solves, including configuration sprawl, duplication across environments, and secrets management.
+
+## What is the Kapitan inventory?
+
+The [inventory](pages/inventory/introduction.md) is a hierarchical YAML structure that captures all the data you want to make available to Kapitan's templating engines. It is divided into [targets](pages/inventory/targets.md) (environments or deployments) and [classes](pages/inventory/classes.md) (reusable configuration fragments). Learn more in the [inventory introduction](pages/inventory/introduction.md).
+
+## How do I install Kapitan?
+
+The easiest way is via Docker:
+
+```shell
+docker run -t --rm -v $(pwd):/src:delegated kapicorp/kapitan -h
+```
+
+Or install with pip:
+
+```shell
+pip3 install --user --upgrade kapitan
+```
+
+See the [Getting Started](getting_started.md) page for full installation instructions.
+
+## Which input type should I use?
+
+It depends on your use case:
+
+- **[Jsonnet](pages/input_types/jsonnet.md)** — structured data, Kubernetes manifests, JSON Schema validation
+- **[Jinja](pages/input_types/jinja.md)** — scripts, documentation, text templates
+- **[Kadet](pages/input_types/kadet.md)** — Python-based generation, reusable libraries
+- **[Helm](pages/input_types/helm.md)** — rendering existing Helm charts
+- **[Kustomize](pages/input_types/kustomize.md)** — patching Kubernetes manifests
+- **[CUE](pages/input_types/cuelang.md)** — typed configuration with validation
+
+## How does Kapitan manage secrets?
+
+Kapitan uses [References](references.md) (formerly Secrets) to manage sensitive and dynamic values. Supported backends include GPG, AWS KMS, GCP KMS, Azure Key Vault, HashiCorp Vault, and plain/base64 for non-sensitive data. See the [References documentation](references.md) for setup instructions.
+
+## What is parameter interpolation?
+
+Parameter interpolation lets you reference values defined elsewhere in the inventory using the `${variable:name}` syntax. This reduces duplication and makes configuration more maintainable. Read the [parameter interpolation guide](pages/inventory/parameters_interpolation.md) for details.
+
+## How do I compile a target?
+
+```shell
+kapitan compile -t <target_name>
+```
+
+Without a target flag, Kapitan compiles all discovered targets. See the [`kapitan compile` CLI reference](pages/commands/kapitan_compile.md) for all options.
+
+## Where can I find examples?
+
+The [kapicorp/kapitan-reference](https://github.com/kapicorp/kapitan-reference) repository contains working examples for Kubernetes, Terraform, and more. You can also explore the [input type documentation](pages/input_types/introduction.md) for small, focused examples.
+
+## Ask your question
+
+Please use the comments facility below to ask your question.

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/getting_started.md

@@ -171,3 +171,12 @@ Every merge to `master` is automatically published to PyPI as a PEP 440 pre-rele
     ```shell
     poetry add --allow-prereleases kapitan
     ```
+
+---
+
+## Next steps
+
+- Learn the [Kapitan core concepts](pages/core_concepts.md): how inventory, targets, classes, and input types work together.
+- Understand the [Kapitan inventory](pages/inventory/introduction.md): targets, classes, and parameter interpolation.
+- Explore [input types](pages/input_types/introduction.md) such as [Jsonnet](pages/input_types/jsonnet.md), [Jinja](pages/input_types/jinja.md), [Kadet](pages/input_types/kadet.md), [Helm](pages/input_types/helm.md), and [Kustomize](pages/input_types/kustomize.md).
+- Manage secrets and external values with [Kapitan References](references.md).

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/pages/core_concepts.md

@@ -161,3 +161,11 @@ parameters:
     headquarters: London
     timezone: Europe/London
 ```
+
+---
+
+## Next steps
+
+- Dive deeper into the [Kapitan inventory](inventory/introduction.md): how [targets](inventory/targets.md), [classes](inventory/classes.md), and [parameter interpolation](inventory/parameters_interpolation.md) model your configuration.
+- Choose an [input type](input_types/introduction.md) for your use case: [Jsonnet](input_types/jsonnet.md), [Jinja](input_types/jinja.md), [Kadet](input_types/kadet.md), [Helm](input_types/helm.md), [Kustomize](input_types/kustomize.md), or [CUE](input_types/cuelang.md).
+- Learn how to manage secrets and dynamic values with [Kapitan References](../references.md).

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/pages/input_types/introduction.md

@@ -156,3 +156,17 @@ Input types can be specified in the inventory under `kapitan.compile` in the fol
     ```
 
     1. (Default: global --prune)
+
+---
+
+## Next steps
+
+- Learn how the [Kapitan inventory](../inventory/introduction.md) feeds data into every input type.
+- Choose the right template engine for your use case:
+  - [Jsonnet](jsonnet.md) for structured data and Kubernetes manifests
+  - [Jinja](jinja.md) for scripts and documentation
+  - [Kadet](kadet.md) for Python-based generation
+  - [Helm](helm.md) for existing Helm charts
+  - [Kustomize](kustomize.md) for Kubernetes manifest patches
+  - [CUE](cuelang.md) for typed configuration validation
+- Manage secrets and external values with [Kapitan References](../../references.md).

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/pages/input_types/jsonnet.md

@@ -138,3 +138,12 @@ If `validation.valid` is not true, it will then fail compilation and display `va
 
     Compile error: failed to compile target: minikube-mysql
     ```
+
+---
+
+## Next steps
+
+- Learn how the [Kapitan inventory](../inventory/introduction.md) makes data available to Jsonnet templates.
+- Explore other [input types](introduction.md) such as [Jinja](jinja.md), [Kadet](kadet.md), and [Helm](helm.md).
+- Validate your generated output with [`kapitan validate`](../commands/kapitan_validate.md).
+- Manage secrets in Jsonnet templates with [Kapitan References](../../references.md).

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/pages/inventory/advanced.md

@@ -40,3 +40,11 @@ For instance you could define the following:
         Compiled acme (0.06s)
         Compiled acme-documentation (0.09s)
         ```
+
+---
+
+## Next steps
+
+- Review the [inventory introduction](introduction.md) for a refresher on targets and classes.
+- Learn about [inventory backends](backends.md) such as reclass-rs and OmegaConf.
+- Explore the [`kapitan compile` CLI reference](../commands/kapitan_compile.md#using-labels) for more label options.

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/pages/inventory/classes.md

@@ -56,4 +56,13 @@ If we open the file, we find another familiar yaml fragment.
 
 Notice that this class includes an import definition for another class, `kapitan.common`. We've already learned this means that kapitan will import a file on disk called `inventory/classes/kapitan/common.yml`
 
-You can also see that in the `parameters` section we now encounter a new syntax which unlocks another powerful inventory feature: *parameters interpolation*!
+You can also see that in the `parameters` section we now encounter a new syntax which unlocks another powerful inventory feature: [parameter interpolation](parameters_interpolation.md)!
+
+---
+
+## Next steps
+
+- Learn how to define environments and deployments with [Kapitan inventory targets](targets.md).
+- Understand how to reference values across classes and targets with [parameter interpolation](parameters_interpolation.md).
+- Explore [advanced inventory features](advanced.md) such as wildcard classes and inventory backends.
+- See how classes power [input types](../input_types/introduction.md) like [Jsonnet](../input_types/jsonnet.md) and [Jinja](../input_types/jinja.md).

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/pages/inventory/introduction.md

@@ -71,3 +71,13 @@ parameters:
 
 
 By combining [**target**](targets.md) and [**classes**](classes.md), the **Inventory** becomes the SSOT for your whole configuration, and learning how to use it will unleash the real power of **Kapitan**.
+
+---
+
+## Next steps
+
+- Learn how to define environments and deployments with [Kapitan inventory targets](targets.md).
+- Understand how to compose reusable configuration with [Kapitan inventory classes](classes.md).
+- Discover how to reference values across the inventory with [parameter interpolation](parameters_interpolation.md).
+- Explore [advanced inventory features](advanced.md) such as target labels and inventory backends.
+- See how the inventory drives [input types](../input_types/introduction.md) like [Jsonnet](../input_types/jsonnet.md), [Jinja](../input_types/jinja.md), and [Helm](../input_types/helm.md).

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/pages/inventory/parameters_interpolation.md

@@ -68,4 +68,13 @@ classes:
 
 Here in this case `application.location` refers to a value `location` which has been defined elsewhere, perhaps (but not necessarily) in the `project.production` class.
 
-Also notice that the class name (`project.production`) is not in any ways influencing the name or the structed of the yaml it imports into the file
+Also notice that the class name (`project.production`) is not in any ways influencing the name or the structed of the yaml it imports into the file.
+
+---
+
+## Next steps
+
+- Review the [Kapitan inventory introduction](introduction.md) to understand how targets and classes form the configuration hierarchy.
+- Learn how to define environments with [Kapitan inventory targets](targets.md).
+- Compose reusable fragments with [Kapitan inventory classes](classes.md).
+- Explore [advanced inventory features](advanced.md) such as inventory backends and wildcard classes.

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/pages/inventory/targets.md

@@ -76,3 +76,12 @@ inventory/
 ```
 
 In this example, the `my-cluster.yml` target file is located within the `clusters/production/` subdirectory, and can be identified with `clusters.production.my-cluster`.
+
+---
+
+## Next steps
+
+- Compose reusable configuration fragments with [Kapitan inventory classes](classes.md).
+- Learn how to reference values across classes and targets with [parameter interpolation](parameters_interpolation.md).
+- Explore [advanced inventory features](advanced.md) such as target labels.
+- See how targets are compiled with different [input types](../input_types/introduction.md).

{kapitan-0.35.2.dev10 → kapitan-0.35.2.dev11}/docs/references.md

@@ -796,3 +796,11 @@ For example, to reveal the secret stored at `path/to/secret_inside_kapitan`
     ```
 
 *Note:* Cryptographic algorithm used for encryption is *rsa-oaep-256*.
+
+---
+
+## Next steps
+
+- Learn how to model your configuration with the [Kapitan inventory](pages/inventory/introduction.md).
+- See how references are used during [compilation](pages/input_types/introduction.md).
+- Explore the [`kapitan compile`](pages/commands/kapitan_compile.md) and [`kapitan refs`](pages/commands/kapitan_inventory.md) CLI commands.

kapitan-0.35.2.dev10/docs/FAQ.md

@@ -1,15 +0,0 @@
----
-comments: true
-title: "Kapitan FAQ: Common Questions About Inventory, Compile, and Secrets"
-description: "Find answers to frequently asked questions about Kapitan inventory, targets, classes, compilation, references, secrets, and supported input types."
----
-
-# :kapitan-logo: **Kapitan FAQ**
-
-## Why do I need **Kapitan**?
-
-See [Why do I need **Kapitan**?](pages/blog/posts/2022-12-04.md#why-do-i-need-kapitan)
-
-## Ask your question
-
-Please use the comments facility below to ask your question