diff --git a/docs/12-support.md b/docs/12-support.md index 279f6d80af..142d6ad495 100644 --- a/docs/12-support.md +++ b/docs/12-support.md @@ -1,6 +1,6 @@ # Support -1. Make sure you've read the [Zarf Overview](./zarf-overview), [Understanding the Basics](./understand-the-basics), and the [Getting Started](./getting-started) guides. -2. Look for an answer in [the frequently asked questions](./faq). +1. Make sure you've read the [Zarf Overview](./0-zarf-overview.md), [Understanding the Basics](./1-understand-the-basics.md), and the [Getting Started](./3-getting-started.md) guides. +2. Look for an answer in [the frequently asked questions](./9-faq.md). 3. Ask a question in [the Zarf Slack Channel](https://kubernetes.slack.com/archives/C03B6BJAUJ3) 4. [Read issues, report a bug, or rquest a new feature](https://github.com/defenseunicorns/zarf/issues) \ No newline at end of file diff --git a/docs/3-getting-started.md b/docs/3-getting-started.md index 6850a31d4d..48942ce685 100644 --- a/docs/3-getting-started.md +++ b/docs/3-getting-started.md @@ -68,8 +68,8 @@ Depending on how familiar you are with Kubernetes, DevOps, and Zarf, let's find - If you want to dive straight into Zarf, you can find examples and guides in the [Walkthroughs](./walkthroughs) page. -- More information about the Zarf CLI is available in the [Zarf CLI](./user-guide/the-zarf-cli) page, or by browsing through the help descriptions of all the commands available through `zarf --help`. +- More information about the Zarf CLI is available in the [Zarf CLI](./4-user-guide/1-the-zarf-cli/index.md) page, or by browsing through the help descriptions of all the commands available through `zarf --help`. -- More information about the packages that Zarf create and deploy is available in the [Understanding Zarf Packages](./user-guide/zarf-packages/zarf-packages) page. +- More information about the packages that Zarf create and deploy is available in the [Understanding Zarf Packages](./4-user-guide/2-zarf-packages/1-zarf-packages.md) page. -- If you want to take a step back and better understand the problem Zarf is trying to solve, you can find more context in the [Understand the Basics](./understand-the-basics) and [Core Concepts](./core-concepts) page. +- If you want to take a step back and better understand the problem Zarf is trying to solve, you can find more context in the [Understand the Basics](./1-understand-the-basics.md) and [Core Concepts](./2-core-concepts.md) page. diff --git a/docs/4-user-guide/1-the-zarf-cli/1-building-your-own-cli.md b/docs/4-user-guide/1-the-zarf-cli/1-building-your-own-cli.md index d62a5fbcd5..55221f8517 100644 --- a/docs/4-user-guide/1-the-zarf-cli/1-building-your-own-cli.md +++ b/docs/4-user-guide/1-the-zarf-cli/1-building-your-own-cli.md @@ -1,7 +1,7 @@ # Building Your Own Zarf CLI :::note -As mentioned in the [Getting Started page](../../getting-started), a pre-compiled binary is available for arm64 and amd64 machines under the 'Assets' tab of our latest releases on [GitHub](https://github.com/defenseunicorns/zarf/releases). If you don't want to build the CLI yourself you could always download it from there. +As mentioned in the [Getting Started page](../../3-getting-started.md), a pre-compiled binary is available for arm64 and amd64 machines under the 'Assets' tab of our latest releases on [GitHub](https://github.com/defenseunicorns/zarf/releases). If you don't want to build the CLI yourself you could always download it from there. ::: ## Dependencies diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/0-zarf.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/0-zarf.md index 8f78137449..29c2c0b576 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/0-zarf.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/0-zarf.md @@ -17,13 +17,13 @@ zarf [COMMAND]|[ZARF-PACKAGE]|[ZARF-YAML] [flags] ### SEE ALSO -* [zarf completion](./completion) - Generate the autocompletion script for the specified shell -* [zarf connect](./zarf_connect) - Access services or pods deployed in the cluster. -* [zarf destroy](./zarf_destroy) - Tear it all down, we'll miss you Zarf... -* [zarf init](./zarf_init) - Deploys the gitops service or appliance cluster on a clean linux box -* [zarf package](./package) - Pack and unpack updates for the Zarf gitops service. -* [zarf prepare](./prepare) - Tools to help prepare assets for packaging -* [zarf tools](./tools) - Collection of additional tools to make airgap easier -* [zarf version](./zarf_version) - Displays the version the zarf binary was built from +* [zarf completion](./4-completion/index.md) - Generate the autocompletion script for the specified shell +* [zarf connect](./zarf_connect.md) - Access services or pods deployed in the cluster. +* [zarf destroy](./zarf_destroy.md) - Tear it all down, we'll miss you Zarf... +* [zarf init](./zarf_init.md) - Deploys the gitops service or appliance cluster on a clean linux box +* [zarf package](./2-package/index.md) - Pack and unpack updates for the Zarf gitops service. +* [zarf prepare](./5-prepare/index.md) - Tools to help prepare assets for packaging +* [zarf tools](./3-tools/index.md) - Collection of additional tools to make airgap easier +* [zarf version](./zarf_version.md) - Displays the version the zarf binary was built from ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/index.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/index.md index a09e849d8e..795c74d05d 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/index.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/index.md @@ -17,9 +17,9 @@ Pack and unpack updates for the Zarf gitops service. ### SEE ALSO -* [zarf](../zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments -* [zarf package create](./zarf_package_create) - Create an update package to push to the gitops server (runs online) -* [zarf package deploy](./zarf_package_deploy) - Deploys an update package from a local file or URL (runs offline) -* [zarf package inspect](./zarf_package_inspect) - lists the payload of an update package file (runs offline) +* [zarf](../0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments +* [zarf package create](./zarf_package_create.md) - Create an update package to push to the gitops server (runs online) +* [zarf package deploy](./zarf_package_deploy.md) - Deploys an update package from a local file or URL (runs offline) +* [zarf package inspect](./zarf_package_inspect.md) - lists the payload of an update package file (runs offline) ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_create.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_create.md index ed68565cc8..42dfbe6cfb 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_create.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_create.md @@ -24,6 +24,6 @@ zarf package create [flags] ### SEE ALSO -* [zarf package](./) - Pack and unpack updates for the Zarf gitops service. +* [zarf package](./index.md) - Pack and unpack updates for the Zarf gitops service. ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_deploy.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_deploy.md index d865800627..5440f8d6ed 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_deploy.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_deploy.md @@ -25,6 +25,6 @@ zarf package deploy [PACKAGE] [flags] ### SEE ALSO -* [zarf package](./) - Pack and unpack updates for the Zarf gitops service. +* [zarf package](./index.md) - Pack and unpack updates for the Zarf gitops service. ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_inspect.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_inspect.md index fa36fd5499..77701b50ab 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_inspect.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_inspect.md @@ -21,6 +21,6 @@ zarf package inspect [PACKAGE] [flags] ### SEE ALSO -* [zarf package](./) - Pack and unpack updates for the Zarf gitops service. +* [zarf package](./index.md) - Pack and unpack updates for the Zarf gitops service. ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/archiver/index.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/archiver/index.md index 8900cb533c..941d27bb8a 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/archiver/index.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/archiver/index.md @@ -17,7 +17,7 @@ Compress/Decompress tools ### SEE ALSO -* [zarf tools](../) - Collection of additional tools to make airgap easier +* [zarf tools](../index.md) - Collection of additional tools to make airgap easier * [zarf tools archiver compress](zarf_tools_archiver_compress.md) - Compress a collection of sources based off of the destination file extension * [zarf tools archiver decompress](zarf_tools_archiver_decompress.md) - Decompress an archive to a specified location. diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/index.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/index.md index d808834d44..7a138d743f 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/index.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/index.md @@ -17,11 +17,11 @@ Collection of additional tools to make airgap easier ### SEE ALSO -* [zarf](../zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments -* [zarf tools archiver](./archiver) - Compress/Decompress tools -* [zarf tools config-schema](./zarf_tools_config-schema) - Generates a JSON schema for the zarf.yaml configuration -* [zarf tools get-admin-password](./zarf_tools_get-admin-password) - Returns the Zarf admin password for gitea read from the zarf-state secret in the zarf namespace -* [zarf tools monitor](./zarf_tools_monitor) - Launch K9s tool for managing K8s clusters -* [zarf tools registry](./registry) - Collection of registry commands provided by Crane +* [zarf](../0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments +* [zarf tools archiver](./archiver/index.md) - Compress/Decompress tools +* [zarf tools config-schema](./zarf_tools_config-schema.md) - Generates a JSON schema for the zarf.yaml configuration +* [zarf tools get-admin-password](./zarf_tools_get-admin-password.md) - Returns the Zarf admin password for gitea read from the zarf-state secret in the zarf namespace +* [zarf tools monitor](./zarf_tools_monitor.md) - Launch K9s tool for managing K8s clusters +* [zarf tools registry](./registry/index.md) - Collection of registry commands provided by Crane ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/registry/index.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/registry/index.md index 4ed8142811..d92ddc759c 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/registry/index.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/registry/index.md @@ -17,7 +17,7 @@ Collection of registry commands provided by Crane ### SEE ALSO -* [zarf tools](../) - Collection of additional tools to make airgap easier +* [zarf tools](../index.md) - Collection of additional tools to make airgap easier * [zarf tools registry catalog](zarf_tools_registry_catalog.md) - List the repos in a registry * [zarf tools registry copy](zarf_tools_registry_copy.md) - Efficiently copy a remote image from src to dst while retaining the digest value * [zarf tools registry login](zarf_tools_registry_login.md) - Log in to a registry diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_config-schema.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_config-schema.md index 635bcb5c4d..9dc12c41c2 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_config-schema.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_config-schema.md @@ -21,6 +21,6 @@ zarf tools config-schema [flags] ### SEE ALSO -* [zarf tools](./) - Collection of additional tools to make airgap easier +* [zarf tools](./index.md) - Collection of additional tools to make airgap easier ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_get-admin-password.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_get-admin-password.md index e63fe69c4d..6dfb9bca64 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_get-admin-password.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_get-admin-password.md @@ -21,6 +21,6 @@ zarf tools get-admin-password [flags] ### SEE ALSO -* [zarf tools](./) - Collection of additional tools to make airgap easier +* [zarf tools](./index.md) - Collection of additional tools to make airgap easier ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_monitor.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_monitor.md index 4d63e37256..370b026361 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_monitor.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_monitor.md @@ -21,6 +21,6 @@ zarf tools monitor [flags] ### SEE ALSO -* [zarf tools](./) - Collection of additional tools to make airgap easier +* [zarf tools](./index.md) - Collection of additional tools to make airgap easier ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/index.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/index.md index 33e1c1ce48..4c7d50b1dd 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/index.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/index.md @@ -23,10 +23,10 @@ See each sub-command's help for details on how to use the generated script. ### SEE ALSO -* [zarf](../zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments -* [zarf completion bash](./zarf_completion_bash) - Generate the autocompletion script for bash -* [zarf completion fish](./zarf_completion_fish) - Generate the autocompletion script for fish -* [zarf completion powershell](./zarf_completion_powershell) - Generate the autocompletion script for powershell -* [zarf completion zsh](./zarf_completion_zsh) - Generate the autocompletion script for zsh +* [zarf](../0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments +* [zarf completion bash](./zarf_completion_bash.md) - Generate the autocompletion script for bash +* [zarf completion fish](./zarf_completion_fish.md) - Generate the autocompletion script for fish +* [zarf completion powershell](./zarf_completion_powershell.md) - Generate the autocompletion script for powershell +* [zarf completion zsh](./zarf_completion_zsh.md) - Generate the autocompletion script for zsh ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_bash.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_bash.md index ed6a2966b4..716c3b2f40 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_bash.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_bash.md @@ -46,6 +46,6 @@ zarf completion bash ### SEE ALSO -* [zarf completion](./) - Generate the autocompletion script for the specified shell +* [zarf completion](./index.md) - Generate the autocompletion script for the specified shell ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_fish.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_fish.md index ab4d65da00..c8329bdfb2 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_fish.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_fish.md @@ -37,6 +37,6 @@ zarf completion fish [flags] ### SEE ALSO -* [zarf completion](./) - Generate the autocompletion script for the specified shell +* [zarf completion](./index.md) - Generate the autocompletion script for the specified shell ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_powershell.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_powershell.md index 67387d6cec..ba43c25868 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_powershell.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_powershell.md @@ -34,6 +34,6 @@ zarf completion powershell [flags] ### SEE ALSO -* [zarf completion](./) - Generate the autocompletion script for the specified shell +* [zarf completion](./index.md) - Generate the autocompletion script for the specified shell ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_zsh.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_zsh.md index 367826824e..aa1142efe4 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_zsh.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/zarf_completion_zsh.md @@ -44,6 +44,6 @@ zarf completion zsh [flags] ### SEE ALSO -* [zarf completion](./) - Generate the autocompletion script for the specified shell +* [zarf completion](./index.md) - Generate the autocompletion script for the specified shell ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/index.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/index.md index 7abf50bc60..8618cf576e 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/index.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/index.md @@ -17,9 +17,9 @@ Tools to help prepare assets for packaging ### SEE ALSO -* [zarf](../zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments -* [zarf prepare find-images](./zarf_prepare_find-images) - evaluates components in a zarf file to identify images specified in their helm charts and manifests -* [zarf prepare patch-git](./zarf_prepare_patch-git) - Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE -* [zarf prepare sha256sum](./zarf_prepare_sha256sum) - Generate a SHA256SUM for the given file +* [zarf](../0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments +* [zarf prepare find-images](./zarf_prepare_find-images.md) - evaluates components in a zarf file to identify images specified in their helm charts and manifests +* [zarf prepare patch-git](./zarf_prepare_patch-git.md) - Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE +* [zarf prepare sha256sum](./zarf_prepare_sha256sum.md) - Generate a SHA256SUM for the given file ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_find-images.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_find-images.md index 90ba100902..8e360b6bce 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_find-images.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_find-images.md @@ -22,6 +22,6 @@ zarf prepare find-images [flags] ### SEE ALSO -* [zarf prepare](./) - Tools to help prepare assets for packaging +* [zarf prepare](./index.md) - Tools to help prepare assets for packaging ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_patch-git.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_patch-git.md index 34f1f53272..edbce2f60d 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_patch-git.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_patch-git.md @@ -21,6 +21,6 @@ zarf prepare patch-git [HOST] [FILE] [flags] ### SEE ALSO -* [zarf prepare](./) - Tools to help prepare assets for packaging +* [zarf prepare](./index.md) - Tools to help prepare assets for packaging ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_sha256sum.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_sha256sum.md index 9a8aaf1782..77c25ba46b 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_sha256sum.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_sha256sum.md @@ -21,6 +21,6 @@ zarf prepare sha256sum [FILE|URL] [flags] ### SEE ALSO -* [zarf prepare](./) - Tools to help prepare assets for packaging +* [zarf prepare](./index.md) - Tools to help prepare assets for packaging ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_connect.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_connect.md index 222e1765ec..812c9da72a 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_connect.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_connect.md @@ -27,6 +27,6 @@ zarf connect [flags] ### SEE ALSO -* [zarf](./zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments +* [zarf](./0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_destroy.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_destroy.md index bc72df6820..4604455170 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_destroy.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_destroy.md @@ -23,6 +23,6 @@ zarf destroy [flags] ### SEE ALSO -* [zarf](./zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments +* [zarf](./0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_init.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_init.md index 34681da591..be1d0f3806 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_init.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_init.md @@ -30,6 +30,6 @@ zarf init [flags] ### SEE ALSO -* [zarf](./zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments +* [zarf](./0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_version.md b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_version.md index 5085b85357..db0ee2b3a7 100644 --- a/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_version.md +++ b/docs/4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_version.md @@ -21,6 +21,6 @@ zarf version [flags] ### SEE ALSO -* [zarf](./zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments +* [zarf](./0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments ###### Auto generated by spf13/cobra on 20-May-2022 diff --git a/docs/4-user-guide/1-the-zarf-cli/2-cli-commond-uses.md b/docs/4-user-guide/1-the-zarf-cli/2-cli-commond-uses.md index e5e0d085ab..1fb47779e5 100644 --- a/docs/4-user-guide/1-the-zarf-cli/2-cli-commond-uses.md +++ b/docs/4-user-guide/1-the-zarf-cli/2-cli-commond-uses.md @@ -7,14 +7,14 @@ Since the main priority of Zarf is to make deploying applications into disconnec ## Building Packages: `zarf package create` -[`zarf package create`](./cli-commands/package/zarf_package_create) is used to create a tar.zst binary file that contains all the necessary dependencies and instructions to deploy a set of functionality onto another machine. We call this tar.zst file a 'package'. The 'package create' command looks for a file called `zarf.yaml` which describes all of the things that make up the package and then does all the work necessary to prepare the output tar.zst package, such as downloading required container images and git repositories. More information on what these Zarf packages are can be found in the [Zarf Packages](../zarf-packages/zarf-packages) page. +[`zarf package create`](./100-cli-commands/2-package/zarf_package_create.md) is used to create a tar.zst binary file that contains all the necessary dependencies and instructions to deploy a set of functionality onto another machine. We call this tar.zst file a 'package'. The 'package create' command looks for a file called `zarf.yaml` which describes all of the things that make up the package and then does all the work necessary to prepare the output tar.zst package, such as downloading required container images and git repositories. More information on what these Zarf packages are can be found in the [Zarf Packages](../2-zarf-packages/index.md) page.
## Initializing a Cluster: `zarf init` -Before you are able to deploy onto a cluster, Zarf needs to initialize the cluster to be ready. This is done through the [`zarf init`](./cli-commands/zarf_init) command, which injects and starts-up an in-cluster container registry, along with other optional tools and services into your cluster within the Zarf namespace that future packages will need. If you don't have a cluster yet, this command can help with that too! This command uses a specialized package called an 'init-package' that also contains all the resources necessary to create a local k3s cluster on your machine. This init-package can either be located in your current working directory, in the directory where the Zarf CLI binary lives, or be downloaded from the GitHub releases as the command is running. More information about what the 'init' command is doing will be provided soon but more information about the init-package can be found on the [init-package](../zarf-packages/the-zarf-init-package) page. +Before you are able to deploy onto a cluster, Zarf needs to initialize the cluster to be ready. This is done through the [`zarf init`](./100-cli-commands/zarf_init.md) command, which injects and starts-up an in-cluster container registry, along with other optional tools and services into your cluster within the Zarf namespace that future packages will need. If you don't have a cluster yet, this command can help with that too! This command uses a specialized package called an 'init-package' that also contains all the resources necessary to create a local k3s cluster on your machine. This init-package can either be located in your current working directory, in the directory where the Zarf CLI binary lives, or be downloaded from the GitHub releases as the command is running. More information about what the 'init' command is doing will be provided soon but more information about the init-package can be found on the [init-package](../2-zarf-packages/3-the-zarf-init-package.md) page. :::note Depending on the permissions of your user, if you are installing k3s through the `zarf init` command you may need to run the command as a privileged user. This can be done by either: @@ -30,8 +30,8 @@ Depending on the permissions of your user, if you are installing k3s through the -As stated many times now, the entire purpose of Zarf is to make it easier to deploy applications onto air gapped environments. This is where that magic happens! [`zarf package deploy`](./cli-commands/package/zarf_package_deploy) is used to deploy an already built tar.zst package onto a machine, usually specifically into a k8s cluster. It is usually assumed that the `zarf init` command has already been run on the machine you are deploying to but there are a few rare cases where this doesn't apply. +As stated many times now, the entire purpose of Zarf is to make it easier to deploy applications onto air gapped environments. This is where that magic happens! [`zarf package deploy`](./100-cli-commands/2-package/zarf_package_deploy.md) is used to deploy an already built tar.zst package onto a machine, usually specifically into a k8s cluster. It is usually assumed that the `zarf init` command has already been run on the machine you are deploying to but there are a few rare cases where this doesn't apply. Since the package has all of its dependencies built-in, it can be deployed onto any cluster, even without an external internet connection. The dependency resources are pushed onto the cluster in their respective places, such as an in-cluster Gitea Git server or Docker registry, and then the application is deployed as instructed in the `zarf.yaml` file (i.e. deploying a helm chart, deploying raw k8s manifests, or even just executing a series of shell commands). -More information about Zarf packages is available on the [Understanding Zarf Packages](../zarf-packages/zarf-packages) page +More information about Zarf packages is available on the [Understanding Zarf Packages](../2-zarf-packages/1-zarf-packages.md) page diff --git a/docs/4-user-guide/1-the-zarf-cli/index.md b/docs/4-user-guide/1-the-zarf-cli/index.md index 2f12104bdf..19bef5662f 100644 --- a/docs/4-user-guide/1-the-zarf-cli/index.md +++ b/docs/4-user-guide/1-the-zarf-cli/index.md @@ -16,7 +16,7 @@ Zarf is a command line interface (CLI) tool used to enable software delivery, sp -There are multiple ways to get the Zarf CLI onto your machine including installing from the Defense Unicorns Homebrew Tap, downloading a prebuilt binary from our GitHub releases, or even building the CLI from scratch yourself. Instructions for all of these methods are provided in the [Installing Zarf](../../getting-started/#installing-zarf) section of the Getting Started guide but if you have Homebrew installed and you want to dive right in, you can install Zarf by copying the commands for your systems OS into a terminal: +There are multiple ways to get the Zarf CLI onto your machine including installing from the Defense Unicorns Homebrew Tap, downloading a prebuilt binary from our GitHub releases, or even building the CLI from scratch yourself. Instructions for all of these methods are provided in the [Installing Zarf](../../3-getting-started.md#installing-zarf) section of the Getting Started guide but if you have Homebrew installed and you want to dive right in, you can install Zarf by copying the commands for your systems OS into a terminal: @@ -139,13 +139,13 @@ Throughout the rest of the does we will often be describing commands as `zarf {c Zarf has multiple commands to make building, deploying, and maintaining packages easier. Some commands also have multiple sub-commands under them. All of the commands and sub-commands available have a short description of what they do when the `--help` flag is provided. These descriptions get more detailed the further down you go into the command hierarchy. Feel free to explore around the different commands available to get a feel for what Zarf can do. -As stated before, Zarf was built to make deploying applications into disconnected environments easier. To reach this objective, the most common commands that get used are `zarf init`, `zarf package create` and `zarf package deploy`. More detail on all of the commands can be found in the [CLI Commands](./cli-commands/zarf) section but a short description of the most commonly used commands are provided below. You might notice that all three of these commands operate in some way with what we call a Zarf package. More information about Zarf packages can be found in the next section [Zarf Packages](../zarf-packages/zarf-packages). +As stated before, Zarf was built to make deploying applications into disconnected environments easier. To reach this objective, the most common commands that get used are `zarf init`, `zarf package create` and `zarf package deploy`. More detail on all of the commands can be found in the [CLI Commands](./100-cli-commands/0-zarf.md) section but a short description of the most commonly used commands are provided below. You might notice that all three of these commands operate in some way with what we call a Zarf package. More information about Zarf packages can be found in the next section [Zarf Packages](../2-zarf-packages/1-zarf-packages.md). ### zarf init -`zarf init` is used to prepare a k8s cluster for the deployment of future zarf packages. The init command uses a specialized 'init-package' to operate. This package can either be located in your current working directory, in the directory where the Zarf CLI binary lives, or be downloaded from the GitHub releases as the command is running. More information about what the 'init' command is doing will be provided soon but more information about the init-package can be found on the [init-package](../zarf-packages/the-zarf-init-package) page. +`zarf init` is used to prepare a k8s cluster for the deployment of future zarf packages. The init command uses a specialized 'init-package' to operate. This package can either be located in your current working directory, in the directory where the Zarf CLI binary lives, or be downloaded from the GitHub releases as the command is running. More information about what the 'init' command is doing will be provided soon but more information about the init-package can be found on the [init-package](../2-zarf-packages/3-the-zarf-init-package.md) page. ### zarf package deploy diff --git a/docs/4-user-guide/2-zarf-packages/1-zarf-packages.md b/docs/4-user-guide/2-zarf-packages/1-zarf-packages.md index e0ccc5b784..57dd3dd771 100644 --- a/docs/4-user-guide/2-zarf-packages/1-zarf-packages.md +++ b/docs/4-user-guide/2-zarf-packages/1-zarf-packages.md @@ -10,7 +10,7 @@ Zarf packages are built while 'online' and connected to whatever is hosting the The `zarf.yaml` file, that the package builds from, defines declarative instructions on how capabilities of the package should be deployed. The declarative nature of the package means everything is represented by code and automatically runs as it is configured, instead of having to give manual steps that might not be reproducible on all systems. -Zarf Packages are made up of functionality blocks called components which are described more in the [Zarf Components page](./zarf-components). These components can be optional, giving more flexibility to how packages can be used. +Zarf Packages are made up of functionality blocks called components which are described more in the [Zarf Components page](./2-zarf-components.md). These components can be optional, giving more flexibility to how packages can be used.
@@ -31,7 +31,7 @@ For the remainder of the docs, we will often refer to the `ZarfInitConfig` as an ### ZarfInitConfig -The init package is the package you use to initialize your cluster to be ready to deploy other Zarf packages on to. Because the init package is a special package, we have more documentation in the [Zarf 'init' Package page](./the-zarf-init-package) if you're still curious after reading this section. +The init package is the package you use to initialize your cluster to be ready to deploy other Zarf packages on to. Because the init package is a special package, we have more documentation in the [Zarf 'init' Package page](./3-the-zarf-init-package.md) if you're still curious after reading this section. **The init package needs to be run once on every cluster you want to deploy another package onto, even if the clusters share the same host.** @@ -62,7 +62,7 @@ When Zarf is deploying the package, it will use the infrastructure that was crea ## What Makes Up A Package -Zarf packages are split into smaller chunks called 'components'. These components are defined more in the [Zarf Components page](./zarf-components) but a quick way to understand components are as the actual named capabilities that packages provide. The schema of a zarf.yaml package follows the following format: +Zarf packages are split into smaller chunks called 'components'. These components are defined more in the [Zarf Components page](./2-zarf-components.md) but a quick way to understand components are as the actual named capabilities that packages provide. The schema of a zarf.yaml package follows the following format: ```yaml kind: # Either ZarfPackageConfig or ZarfInitConfig @@ -84,8 +84,8 @@ components: # Components definitions are complex and broken down more **Dependencies** for Building a Zarf Package - A local k8s cluster to work with ([k3s](https://k3s.io/)/[k3d](https://k3d.io/v5.4.1/)/[KinD](https://kind.sigs.k8s.io/docs/user/quick-start#installation)) -- A Zarf CLI ([downloaded](https://github.com/defenseunicorns/zarf/releases) or [manually built](../the-zarf-cli/building-your-own-cli)) -- A Zarf init package ([downloaded](https://github.com/defenseunicorns/zarf/releases) or [manually built](../the-zarf-cli/building-your-own-cli)) +- A Zarf CLI ([downloaded](https://github.com/defenseunicorns/zarf/releases) or [manually built](../1-the-zarf-cli/1-building-your-own-cli.md)) +- A Zarf init package ([downloaded](https://github.com/defenseunicorns/zarf/releases) or [manually built](../1-the-zarf-cli/1-building-your-own-cli.md)) ::: diff --git a/docs/4-user-guide/2-zarf-packages/3-the-zarf-init-package.md b/docs/4-user-guide/2-zarf-packages/3-the-zarf-init-package.md index 7f5fa30023..37ec50d318 100644 --- a/docs/4-user-guide/2-zarf-packages/3-the-zarf-init-package.md +++ b/docs/4-user-guide/2-zarf-packages/3-the-zarf-init-package.md @@ -39,7 +39,7 @@ There are two ways to deploy optional components, you can either pass a comma se # What Makes the Init Package Special -Deploying onto air-gapped environments is a [hard problem](../../understand-the-basics#what-is-the-air-gap), especially when the k8s environment you're deploying to doesn't have a container registry running for you to put your images into. This leads to a classic 'chicken or the egg' problem since the container registry image needs to make its way into the cluster but there is on container registry running on the cluster to push to yet because the image isn't in the cluster yet. In order to remain distro agnostic, we had to come up with a unique solution to seed the container registry into the cluster. +Deploying onto air-gapped environments is a [hard problem](../../1-understand-the-basics.md#what-is-the-air-gap), especially when the k8s environment you're deploying to doesn't have a container registry running for you to put your images into. This leads to a classic 'chicken or the egg' problem since the container registry image needs to make its way into the cluster but there is on container registry running on the cluster to push to yet because the image isn't in the cluster yet. In order to remain distro agnostic, we had to come up with a unique solution to seed the container registry into the cluster. The `zarf-injector` [component](https://github.com/defenseunicorns/zarf/blob/master/packages/zarf-injector/zarf.yaml) within the init-package solves this problem by injecting a really small [Go registry binary](https://github.com/defenseunicorns/zarf/blob/master/src/injector/stage2/registry.go) into the cluster by splitting the binary into small enough chunks that would fit inside of a k8s ConfigMap. Once th config map is pushed onto the cluster, it gets stitched back together and runs to bootstrap the registry. diff --git a/docs/4-user-guide/2-zarf-packages/index.md b/docs/4-user-guide/2-zarf-packages/index.md index 11f7489f03..d265118dc7 100644 --- a/docs/4-user-guide/2-zarf-packages/index.md +++ b/docs/4-user-guide/2-zarf-packages/index.md @@ -18,9 +18,9 @@ Such packages also become highly distributable, as they can now run on edge, emb **Dependencies** -- A Zarf CLI ([downloaded](https://github.com/defenseunicorns/zarf/releases) or [manually built](../the-zarf-cli/building-your-own-cli)) -- A Zarf init package ([downloaded](https://github.com/defenseunicorns/zarf/releases) or [manually built](../the-zarf-cli/building-your-own-cli)) -- A Zarf Package (provided externally or [manually built](./zarf-packages#building-a-package)) +- A Zarf CLI ([downloaded](https://github.com/defenseunicorns/zarf/releases) or [manually built](../1-the-zarf-cli/1-building-your-own-cli.md)) +- A Zarf init package ([downloaded](https://github.com/defenseunicorns/zarf/releases) or [manually built](../1-the-zarf-cli/1-building-your-own-cli.md)) +- A Zarf Package (provided externally or [manually built](./1-zarf-packages.md#building-a-package)) - kube-context into a k8s cluster - (NOTE: Not needed if you plan on deploying the cluster with `zarf init` step) diff --git a/docs/5-operator-manual/0-set-up-and-install.md b/docs/5-operator-manual/0-set-up-and-install.md index 08cfa9d224..39af77d84c 100644 --- a/docs/5-operator-manual/0-set-up-and-install.md +++ b/docs/5-operator-manual/0-set-up-and-install.md @@ -21,9 +21,9 @@ Until we get Zarf into common package managers, you can install the Zarf CLI by: ### Zarf Deployed K3s Cluster -Now that you have a Zarf CLI to work with, let's make a cluster that you can deploy to! The [init package](../user-guide/zarf-packages/the-zarf-init-package) comes with a built-in k3s cluster that you can deploy if you don't already have another cluster available. You can find the relevant [init package release](https://github.com/defenseunicorns/zarf/releases) on the GitHub releases page. +Now that you have a Zarf CLI to work with, let's make a cluster that you can deploy to! The [init package](../4-user-guide/2-zarf-packages/3-the-zarf-init-package.md) comes with a built-in k3s cluster that you can deploy if you don't already have another cluster available. You can find the relevant [init package release](https://github.com/defenseunicorns/zarf/releases) on the GitHub releases page. -Once downloaded, you can install the init package by navigating to the directory containing the init package and running the command [zarf init](../user-guide/the-zarf-cli/cli-commands/zarf_init). Zarf will prompt you, asking if you want to deploy the k3s component, you can type `y` and hit enter to have Zarf startup a local single node k3s cluster on your current machine. Other useful information about initializing a cluster with Zarf is available in the [Initializing a Cluster](./set-up-and-install#initializing-) section later on in this page. +Once downloaded, you can install the init package by navigating to the directory containing the init package and running the command [zarf init](../4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_init.md). Zarf will prompt you, asking if you want to deploy the k3s component, you can type `y` and hit enter to have Zarf startup a local single node k3s cluster on your current machine. Other useful information about initializing a cluster with Zarf is available in the [Initializing a Cluster](./0-set-up-and-install.md#initializing-) section later on in this page. :::note Depending on the permissions of your user, if you are installing k3s through the `zarf init` command you may need to run the command as a privileged user. This can be done by either: @@ -35,7 +35,7 @@ Depending on the permissions of your user, if you are installing k3s through the ### Any Other Cluster -Zarf deploys to almost any cluster, you are not tied down to the K3s cluster that the [init package](../user-guide/zarf-packages/the-zarf-init-package) provides! You could use local dockerized k8s cluster such as [k3d](https://k3d.io/v5.4.1/) or [KinD](https://kind.sigs.k8s.io/), Rancher's next-generation k8s distribution [RKE2](https://docs.rke2.io/), or cloud-provided clusters such as [eks](https://aws.amazon.com/eks/) +Zarf deploys to almost any cluster, you are not tied down to the K3s cluster that the [init package](../4-user-guide/2-zarf-packages/3-the-zarf-init-package.md) provides! You could use local dockerized k8s cluster such as [k3d](https://k3d.io/v5.4.1/) or [KinD](https://kind.sigs.k8s.io/), Rancher's next-generation k8s distribution [RKE2](https://docs.rke2.io/), or cloud-provided clusters such as [eks](https://aws.amazon.com/eks/) # Initializing a Cluster @@ -43,11 +43,11 @@ Zarf deploys to almost any cluster, you are not tied down to the K3s cluster tha Now that you have the CLI installed and a cluster to work with, let's get that cluster initialized so you can deploy application packages onto it! -Initializing a cluster is necessary since almost all k8 clusters do not come with a container registry by default. This becomes an interesting 'chicken or the egg' problem since you don't have a container registry available to push your container registry image into. This problem is discussed more in the [init package](http://localhost:3000/docs/user-guide/zarf-packages/the-zarf-init-package#what-makes-the-init-package-special) page. +Initializing a cluster is necessary since almost all k8 clusters do not come with a container registry by default. This becomes an interesting 'chicken or the egg' problem since you don't have a container registry available to push your container registry image into. This problem is discussed more in the [init package](./../4-user-guide/2-zarf-packages/3-the-zarf-init-package.md) page. During the initialization process, Zarf will create a 'zarf' namespace and deploy an in-cluster Docker registry (used to host container images future packages will need), a 'zarf agent' mutating webhook (to redirect outgoing requests into the internally hosted resources), an optional gitea server (to host the git repositories future packages will need), and a handful of secrets. -You can find the relevant [init package release](https://github.com/defenseunicorns/zarf/releases) on the GitHub releases page. Once downloaded, you can install the init package by navigating to the directory containing the init package and running the command [zarf init](../user-guide/the-zarf-cli/cli-commands/zarf_init). Zarf will prompt you, asking if you want to deploy the optional component, you can type `y` or `n` depending on your use case and needs. +You can find the relevant [init package release](https://github.com/defenseunicorns/zarf/releases) on the GitHub releases page. Once downloaded, you can install the init package by navigating to the directory containing the init package and running the command [zarf init](../4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_init.md). Zarf will prompt you, asking if you want to deploy the optional component, you can type `y` or `n` depending on your use case and needs. Once the init command is finished, you can run `kubectl get pods -n zarf` to verify that the pods have come up healthy. You should expect to see two `agent-hook` pods, a `zarf-docker-registry` pod, and optionally a `zarf-gitea` pod.