From 0820bd1d8db582fd9072530474b85299c547e7c4 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Mon, 22 Apr 2024 12:34:49 +0000 Subject: [PATCH 01/18] init package updates --- site/src/content/docs/ref/create.mdx | 98 ---------------------- site/src/content/docs/ref/init-package.mdx | 14 +++- site/src/content/docs/ref/packages.mdx | 70 +++++++++++++--- 3 files changed, 73 insertions(+), 109 deletions(-) delete mode 100644 site/src/content/docs/ref/create.mdx diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx deleted file mode 100644 index b53ea157bc..0000000000 --- a/site/src/content/docs/ref/create.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Create a Package -sidebar: - order: 60 ---- - -import Mermaid from "@components/Mermaid.astro"; -import Details from "@components/Details.astro"; - -The following diagram shows the order of operations for the `zarf package create` command and the hook locations for [actions](/ref/actions). - -
-A2 - A2(parse zarf.yaml)-->A3 - A3(filter components by architecture)-->A4 - A4(detect init package)-->A5 - A5(handle deprecations)-->A6 - A6(parse component imports)-->A7 - A7(process create-time variables)-->A8 - A8(write build data and zarf.yaml)-->A9 - - A9(run validations)-->A10 - A10(confirm package create):::prompt-->A11 - A11{Init package?} - A11 -->|Yes| A12(add seed image)-->A13 - A11 -->|No| A13 - - subgraph - A13(add each component)-->A13 - A13 --> A14(run each '.actions.onCreate.before'):::action-->A14 - A14 --> A15(load '.charts')-->A16 - A16(load '.files')-->A17 - A17(load '.dataInjections')-->A18 - A18(load '.manifests')-->A19 - A19(load '.repos')-->A20 - A20(run each '.actions.onCreate.after'):::action-->A20 - A20-->A21{Success?} - A21-->|Yes|A22(run each\n'.actions.onCreate.success'):::action-->A22 - A21-->|No|A23(run each\n'.actions.onCreate.failure'):::action-->A23-->A999 - end - - A22-->A24(load all '.images') - A24-->A25{Skip SBOM?} - A25-->|Yes|A27 - A25-->|No|A26 - A26(generate SBOM)-->A27 - A27(reset working directory)-->A28 - A28(create package archive)-->A29 - A29{Is multipart?} - A29-->|Yes|A30(split package archive)-->A31 - A29-->|No|A31 - A31(handle sbom view/out flags) - - A999[Abort]:::fail - - classDef prompt fill:#4adede,color:#000000 - classDef action fill:#bd93f9,color:#000000 - classDef fail fill:#aa0000 -`}/> -
- -## Types of Zarf Packages - -There are two types of Zarf Packages, the `ZarfInitConfig` and the `ZarfPackageConfig`, which are distinguished by the `kind:` field and specified in the `zarf.yaml` file. - -Throughout the rest of the documentation, we will refer to the `ZarfInitConfig` as an `init config` package or `init` package, and to the `ZarfPackageConfig` as simply a "package". - -### ZarfInitConfig - -The init package is used to initialize a cluster, making it ready for deployment of other Zarf Packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). - -If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. Usually, an init package is the first Zarf Package to be deployed on a cluster as other packages often depend on the services installed or configured by the init package. If you want to install a K8s cluster with Zarf, but you don't want to use K3s as your cluster, you will need to create or find another Zarf Package that will stand up your cluster before you run the zarf init command. - -:::note - -To clarify, in most cases, the first Zarf Package you deploy onto a cluster should be the init package since other packages often depend on the services it installs onto your cluster. However, if you don't want to use the K3s distribution included in the init package or if you already have a preferred K8s distribution, you can deploy the distribution package first, followed by the init package, and then any other packages you want. This only applies if you don't have a K8s cluster yet. - -::: - -During the initialization process, Zarf will seed your cluster with a container registry to store images that other packages may require. Additionally, the init package has the option to deploy other features to your cluster, such as a Git server to manage your repositories or a PLG logging stack that allows you to monitor the applications running on your cluster. - -#### Using the init-package - -To initialize your cluster, you need to run the command `zarf init`. This command will search for a file with the specific naming convention: `zarf-init-{ARCHITECTURE}-{VERSION}.tar.zst`. The architecture must match that of the cluster you are deploying to. If you are deploying to a cluster with a different architecture, you will need to specify the name of the architecture you are deploying on with the `-a` flag. For example, if you are on an arm64 machine but are deploying on an amd64 machine, you will run `zarf init -a amd64`. - -Init packages can also be run with `zarf package deploy zarf-init-{ARCHITECTURE}-{VERSION}.tar.zst`. - -You do not need to create init configs by yourself unless you want to customize how your cluster is installed/configured. For example, if you want to use the init process to install a specifically configured K3s cluster onto your host machine, you can create a specific package to do that before running the init package. - -### ZarfPackageConfig - -`ZarfPackageConfig` refers to any package that is not an init package and is used to define specific capabilities that you want to deploy onto your initialized cluster. - -To deploy a Zarf Package, you can use the command `zarf package deploy`. This will prompt you to select from all of the files in your current directory that match the name `zarf-package-*.tar.zst`. Alternatively, if you already know which package you want to deploy, you can simply use the command `zarf package deploy {PACKAGE_NAME}`. - -During the deployment process, Zarf will leverage the infrastructure created during the 'init' process (such as the Docker registry and Git server) to push all the necessary images and repositories required for the package to operate. diff --git a/site/src/content/docs/ref/init-package.mdx b/site/src/content/docs/ref/init-package.mdx index 62954eb6f5..cc438286e6 100644 --- a/site/src/content/docs/ref/init-package.mdx +++ b/site/src/content/docs/ref/init-package.mdx @@ -104,6 +104,18 @@ The `registry:2` image and the Zarf Agent image can be configured with a custom ::: +## Cluster creation + +If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. To install a K8s distribution other than k3s, finding or creating a custom package is necessary. + +Typically, an init package is the first Zarf Package to be deployed on a cluster as other packages often rely on the services it installs or configures, however Zarf may be used to package and install the cluster distribution itself. In this scenario, the distribution package would be deployed first, followed by the init package, and then any other packages planned for deployment. + +:::tip + +Check out our [k3s cluster package](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) to see an example of a Zarf package which installs a kubernetes distribution + +::: + ## The `zarf init` Lifecycle The `zarf init` lifecycle is _very similar_ to the [`zarf package deploy` lifecycle](/ref/deploy/) except that it sets up resources specific to Zarf such as the `zarf-state` and performs special actions such as the injection procedure. @@ -123,7 +135,7 @@ graph TD B12(prompt to confirm components)-->B13 B13(prompt to choose components in '.group')-->B14 - subgraph + subgraph B52 --> |Yes|B14(deploy each component)-->B14 B14 --> B15{Component is \n zarf-seed-registry} B15 --> |Yes|B51(initialize zarf-state secret):::action diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index 913e125f3a..fe6175fad9 100644 --- a/site/src/content/docs/ref/packages.mdx +++ b/site/src/content/docs/ref/packages.mdx @@ -20,17 +20,9 @@ Throughout the rest of the documentation, we will refer to the `ZarfInitConfig` ### `ZarfInitConfig` -The init package is used to initialize a cluster, making it ready for deployment of other Zarf packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). +The init package is used to initialize a cluster, making it ready for deployment of other Zarf packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. -If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. Usually, an init package is the first Zarf Package to be deployed on a cluster as other packages often depend on the services installed or configured by the init package. If you want to install a K8s cluster with Zarf, but you don't want to use K3s as your cluster, you will need to create or find another Zarf Package that will stand up your cluster before you run the zarf init command. - -:::note - -To clarify, in most cases, the first Zarf Package you deploy onto a cluster should be the init package since other packages often depend on the services it installs onto your cluster. However, if you don't want to use the K3s distribution included in the init package or if you already have a preferred K8s distribution, you can deploy the distribution package first, followed by the init package, and then any other packages you want. This only applies if you don't have a K8s cluster yet. - -::: - -During the initialization process, Zarf will seed your cluster with a container registry to store images that other packages may require. Additionally, the init package has the option to deploy other features to your cluster, such as a Git server to manage your repositories or a PLG logging stack that allows you to monitor the applications running on your cluster. +During the initialization process, Zarf will seed your cluster with a container registry to store images that other packages may require. Additionally, the init package has the option to deploy other features to your cluster, such as a Git server to manage your repositories or a PLG logging stack that allows you to monitor the applications running on your cluster. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). #### Using the init-package @@ -89,3 +81,61 @@ In addition to the traditional sources outlined above, there is also a special " Additionally, inspecting a package deployed to a cluster will not be able to show the package's SBOMs, as they are not currently persisted to the cluster. ::: + +## Package create lifecycle +import Mermaid from "@components/Mermaid.astro"; +import Details from "@components/Details.astro"; + +The following diagram shows the order of operations for the `zarf package create` command and the hook locations for [actions](/ref/actions). + +
+A2 + A2(parse zarf.yaml)-->A3 + A3(filter components by architecture)-->A4 + A4(detect init package)-->A5 + A5(handle deprecations)-->A6 + A6(parse component imports)-->A7 + A7(process create-time variables)-->A8 + A8(write build data and zarf.yaml)-->A9 + + A9(run validations)-->A10 + A10(confirm package create):::prompt-->A11 + A11{Init package?} + A11 -->|Yes| A12(add seed image)-->A13 + A11 -->|No| A13 + + subgraph "" + A13(add each component)-->A13 + A13 --> A14(run each '.actions.onCreate.before'):::action-->A14 + A14 --> A15(load '.charts')-->A16 + A16(load '.files')-->A17 + A17(load '.dataInjections')-->A18 + A18(load '.manifests')-->A19 + A19(load '.repos')-->A20 + A20(run each '.actions.onCreate.after'):::action-->A20 + A20-->A21{Success?} + A21-->|Yes|A22(run each\n'.actions.onCreate.success'):::action-->A22 + A21-->|No|A23(run each\n'.actions.onCreate.failure'):::action-->A23-->A999 + end + + A22-->A24(load all '.images') + A24-->A25{Skip SBOM?} + A25-->|Yes|A27 + A25-->|No|A26 + A26(generate SBOM)-->A27 + A27(reset working directory)-->A28 + A28(create package archive)-->A29 + A29{Is multipart?} + A29-->|Yes|A30(split package archive)-->A31 + A29-->|No|A31 + A31(handle sbom view/out flags) + + A999[Abort]:::fail + + classDef prompt fill:#4adede,color:#000000 + classDef action fill:#bd93f9,color:#000000 + classDef fail fill:#aa0000 +`}/> +
From f4cd41a4da44a6fc28e6bff8850fa7334c001441 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Mon, 22 Apr 2024 12:36:38 +0000 Subject: [PATCH 02/18] clarity --- site/src/content/docs/ref/init-package.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/init-package.mdx b/site/src/content/docs/ref/init-package.mdx index cc438286e6..e646602add 100644 --- a/site/src/content/docs/ref/init-package.mdx +++ b/site/src/content/docs/ref/init-package.mdx @@ -106,7 +106,7 @@ The `registry:2` image and the Zarf Agent image can be configured with a custom ## Cluster creation -If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. To install a K8s distribution other than k3s, finding or creating a custom package is necessary. +If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. To install a K8s distribution other than k3s, finding or creating a custom Zarf package is necessary. Typically, an init package is the first Zarf Package to be deployed on a cluster as other packages often rely on the services it installs or configures, however Zarf may be used to package and install the cluster distribution itself. In this scenario, the distribution package would be deployed first, followed by the init package, and then any other packages planned for deployment. From 8664bab9ba7938007f73da03cebca87ce29d828c Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Mon, 22 Apr 2024 12:38:50 +0000 Subject: [PATCH 03/18] fix diagram --- site/src/content/docs/ref/init-package.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/init-package.mdx b/site/src/content/docs/ref/init-package.mdx index e646602add..eefcb7b0c8 100644 --- a/site/src/content/docs/ref/init-package.mdx +++ b/site/src/content/docs/ref/init-package.mdx @@ -135,7 +135,7 @@ graph TD B12(prompt to confirm components)-->B13 B13(prompt to choose components in '.group')-->B14 - subgraph + subgraph "" B52 --> |Yes|B14(deploy each component)-->B14 B14 --> B15{Component is \n zarf-seed-registry} B15 --> |Yes|B51(initialize zarf-state secret):::action From 0750383e093b361abe37a54f517071c94b91de8c Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Tue, 23 Apr 2024 12:02:05 +0000 Subject: [PATCH 04/18] update --- site/src/content/docs/ref/create.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index 255e9e1f74..70d714d4ab 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -71,9 +71,9 @@ Throughout the rest of the documentation, we will refer to the `ZarfInitConfig` The init package is used to initialize a cluster, making it ready for deployment of other Zarf Packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). -If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. To install a K8s distribution other than k3s, finding or creating a custom Zarf package is necessary. +If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed onto your machine. To install a K8s distribution other than k3s, finding or creating a custom Zarf package is necessary. -Typically, an init package is the first Zarf Package to be deployed on a cluster as other packages often rely on the services it installs or configures, however Zarf may be used to package and install the cluster distribution itself. In this scenario, the distribution package would be deployed first, followed by the init package, and then any other packages planned for deployment. +Typically, an init package is the first Zarf Package to be deployed onto a cluster as other packages often rely on the services it installs or configures, however Zarf may be used to package and install the cluster distribution itself. In this scenario, the distribution package would be deployed first, followed by the init package, and then any other packages planned for deployment. :::tip From 3f1a401cb7a9b046095faac0b7ea87d408c4dde9 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Tue, 23 Apr 2024 12:21:13 +0000 Subject: [PATCH 05/18] instructions --- site/src/content/docs/ref/create.mdx | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index 70d714d4ab..d9f55de6f3 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -71,13 +71,11 @@ Throughout the rest of the documentation, we will refer to the `ZarfInitConfig` The init package is used to initialize a cluster, making it ready for deployment of other Zarf Packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). -If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed onto your machine. To install a K8s distribution other than k3s, finding or creating a custom Zarf package is necessary. - -Typically, an init package is the first Zarf Package to be deployed onto a cluster as other packages often rely on the services it installs or configures, however Zarf may be used to package and install the cluster distribution itself. In this scenario, the distribution package would be deployed first, followed by the init package, and then any other packages planned for deployment. +If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed onto your machine. To install a Kubernetes distribution other than k3s, finding or creating a custom Zarf package is necessary. When deploying a custom distribution package, the distribution package should be deployed first, followed by the init package, and then any additional packages. :::tip -Check out our [k3s cluster package](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) to see an example of a Zarf package which installs a kubernetes distribution +Check out the [k3s cluster](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) portion of the init package to see an example of a Zarf package that installs a kubernetes distribution ::: From e3f6e8a6cee25debd25ad5917ce2698836070f92 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Tue, 23 Apr 2024 12:22:19 +0000 Subject: [PATCH 06/18] docs --- site/src/content/docs/ref/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index d9f55de6f3..507ed5f5ef 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -71,7 +71,7 @@ Throughout the rest of the documentation, we will refer to the `ZarfInitConfig` The init package is used to initialize a cluster, making it ready for deployment of other Zarf Packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). -If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed onto your machine. To install a Kubernetes distribution other than k3s, finding or creating a custom Zarf package is necessary. When deploying a custom distribution package, the distribution package should be deployed first, followed by the init package, and then any additional packages. +If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed onto your machine. To install a Kubernetes distribution other than k3s, finding or creating a custom Zarf package is necessary. When deploying a custom distribution package, the distribution package should be deployed first, followed by the init package, and then any additional packages planned for deployment. :::tip From 76c4e18cb2c26305385b56ef1083212f9e8866bc Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Tue, 23 Apr 2024 18:43:05 +0000 Subject: [PATCH 07/18] moving things around --- site/src/content/docs/ref/create.mdx | 37 +--------------- site/src/content/docs/ref/packages.mdx | 58 -------------------------- 2 files changed, 2 insertions(+), 93 deletions(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index 507ed5f5ef..ebf1695cab 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -61,42 +61,9 @@ graph TD `}/> -## Types of Zarf Packages - -There are two types of Zarf Packages, the `ZarfInitConfig` and the `ZarfPackageConfig`, which are distinguished by the `kind:` field and specified in the `zarf.yaml` file. - -Throughout the rest of the documentation, we will refer to the `ZarfInitConfig` as an `init config` package or `init` package, and to the `ZarfPackageConfig` as simply a "package". - -### ZarfInitConfig - -The init package is used to initialize a cluster, making it ready for deployment of other Zarf Packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). - -If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed onto your machine. To install a Kubernetes distribution other than k3s, finding or creating a custom Zarf package is necessary. When deploying a custom distribution package, the distribution package should be deployed first, followed by the init package, and then any additional packages planned for deployment. - -:::tip - -Check out the [k3s cluster](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) portion of the init package to see an example of a Zarf package that installs a kubernetes distribution - -::: - -During the initialization process, Zarf will seed your cluster with a container registry to store images that other packages may require. Additionally, the init package has the option to deploy other features to your cluster, such as a Git server to manage your repositories or a PLG logging stack that allows you to monitor the applications running on your cluster. - -#### Using the init-package - -To initialize your cluster, you need to run the command `zarf init`. This command will search for a file with the specific naming convention: `zarf-init-{ARCHITECTURE}-{VERSION}.tar.zst`. The architecture must match that of the cluster you are deploying to. If you are deploying to a cluster with a different architecture, you will need to specify the name of the architecture you are deploying on with the `-a` flag. For example, if you are on an arm64 machine but are deploying on an amd64 machine, you will run `zarf init -a amd64`. - -Init packages can also be run with `zarf package deploy zarf-init-{ARCHITECTURE}-{VERSION}.tar.zst`. - -You do not need to create init configs by yourself unless you want to customize how your cluster is installed/configured. For example, if you want to use the init process to install a specifically configured K3s cluster onto your host machine, you can create a specific package to do that before running the init package. - -### ZarfPackageConfig - -`ZarfPackageConfig` refers to any package that is not an init package and is used to define specific capabilities that you want to deploy onto your initialized cluster. - -To deploy a Zarf Package, you can use the command `zarf package deploy`. This will prompt you to select from all of the files in your current directory that match the name `zarf-package-*.tar.zst`. Alternatively, if you already know which package you want to deploy, you can simply use the command `zarf package deploy {PACKAGE_NAME}`. - -During the deployment process, Zarf will leverage the infrastructure created during the 'init' process (such as the Docker registry and Git server) to push all the necessary images and repositories required for the package to operate. +## Package creation +To create a package run `zarf package create` in a directory with a zarf.yaml ### Package Templates diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index fe6175fad9..34aa2e5134 100644 --- a/site/src/content/docs/ref/packages.mdx +++ b/site/src/content/docs/ref/packages.mdx @@ -81,61 +81,3 @@ In addition to the traditional sources outlined above, there is also a special " Additionally, inspecting a package deployed to a cluster will not be able to show the package's SBOMs, as they are not currently persisted to the cluster. ::: - -## Package create lifecycle -import Mermaid from "@components/Mermaid.astro"; -import Details from "@components/Details.astro"; - -The following diagram shows the order of operations for the `zarf package create` command and the hook locations for [actions](/ref/actions). - -
-A2 - A2(parse zarf.yaml)-->A3 - A3(filter components by architecture)-->A4 - A4(detect init package)-->A5 - A5(handle deprecations)-->A6 - A6(parse component imports)-->A7 - A7(process create-time variables)-->A8 - A8(write build data and zarf.yaml)-->A9 - - A9(run validations)-->A10 - A10(confirm package create):::prompt-->A11 - A11{Init package?} - A11 -->|Yes| A12(add seed image)-->A13 - A11 -->|No| A13 - - subgraph "" - A13(add each component)-->A13 - A13 --> A14(run each '.actions.onCreate.before'):::action-->A14 - A14 --> A15(load '.charts')-->A16 - A16(load '.files')-->A17 - A17(load '.dataInjections')-->A18 - A18(load '.manifests')-->A19 - A19(load '.repos')-->A20 - A20(run each '.actions.onCreate.after'):::action-->A20 - A20-->A21{Success?} - A21-->|Yes|A22(run each\n'.actions.onCreate.success'):::action-->A22 - A21-->|No|A23(run each\n'.actions.onCreate.failure'):::action-->A23-->A999 - end - - A22-->A24(load all '.images') - A24-->A25{Skip SBOM?} - A25-->|Yes|A27 - A25-->|No|A26 - A26(generate SBOM)-->A27 - A27(reset working directory)-->A28 - A28(create package archive)-->A29 - A29{Is multipart?} - A29-->|Yes|A30(split package archive)-->A31 - A29-->|No|A31 - A31(handle sbom view/out flags) - - A999[Abort]:::fail - - classDef prompt fill:#4adede,color:#000000 - classDef action fill:#bd93f9,color:#000000 - classDef fail fill:#aa0000 -`}/> -
From 2a92710eff17e1f5bc391be72dc307da495d8bef Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 13:28:50 +0000 Subject: [PATCH 08/18] reordering --- site/src/content/docs/ref/create.mdx | 69 ++------------------------ site/src/content/docs/ref/packages.mdx | 57 +++++++++++++++++++++ 2 files changed, 61 insertions(+), 65 deletions(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index ebf1695cab..2d68f292aa 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -1,71 +1,10 @@ --- -title: Create a Package +title: Create Templates sidebar: - order: 60 + order: 32 --- -import Mermaid from "@components/Mermaid.astro"; -import Details from "@components/Details.astro"; - -The following diagram shows the order of operations for the `zarf package create` command and the hook locations for [actions](/ref/actions). - -
-A2 - A2(parse zarf.yaml)-->A3 - A3(filter components by architecture)-->A4 - A4(detect init package)-->A5 - A5(handle deprecations)-->A6 - A6(parse component imports)-->A7 - A7(process create-time variables)-->A8 - A8(write build data and zarf.yaml)-->A9 - - A9(run validations)-->A10 - A10(confirm package create):::prompt-->A11 - A11{Init package?} - A11 -->|Yes| A12(add seed image)-->A13 - A11 -->|No| A13 - - subgraph "" - A13(add each component)-->A13 - A13 --> A14(run each '.actions.onCreate.before'):::action-->A14 - A14 --> A15(load '.charts')-->A16 - A16(load '.files')-->A17 - A17(load '.dataInjections')-->A18 - A18(load '.manifests')-->A19 - A19(load '.repos')-->A20 - A20(run each '.actions.onCreate.after'):::action-->A20 - A20-->A21{Success?} - A21-->|Yes|A22(run each\n'.actions.onCreate.success'):::action-->A22 - A21-->|No|A23(run each\n'.actions.onCreate.failure'):::action-->A23-->A999 - end - - A22-->A24(load all '.images') - A24-->A25{Skip SBOM?} - A25-->|Yes|A27 - A25-->|No|A26 - A26(generate SBOM)-->A27 - A27(reset working directory)-->A28 - A28(create package archive)-->A29 - A29{Is multipart?} - A29-->|Yes|A30(split package archive)-->A31 - A29-->|No|A31 - A31(handle sbom view/out flags) - - A999[Abort]:::fail - - classDef prompt fill:#4adede,color:#000000 - classDef action fill:#bd93f9,color:#000000 - classDef fail fill:#aa0000 -`}/> -
- -## Package creation - -To create a package run `zarf package create` in a directory with a zarf.yaml - -### Package Templates +Templates are used during `zarf package create` to template the `zarf.yaml` file. Templates are baked into the Zarf package meaning they cannot be changed post create. :::caution @@ -73,7 +12,7 @@ To create a package run `zarf package create` in a directory with a zarf.yaml ::: -You can also specify `zarf.yaml` package configuration templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. These values are discovered during `zarf package create` and will always be prompted for if not using `--confirm` or `--set`. An example of this is below: +You can specify `zarf.yaml` package configuration templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. These values are discovered during `zarf package create` and will always be prompted for if not using `--confirm` or not already set. Templates be set using [config files](/ref/config-files/) or the `--set` flag. An example of a package using templates is below: ```yaml kind: ZarfPackageConfig diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index 34aa2e5134..2d50636949 100644 --- a/site/src/content/docs/ref/packages.mdx +++ b/site/src/content/docs/ref/packages.mdx @@ -4,6 +4,9 @@ sidebar: order: 20 --- +import Mermaid from "@components/Mermaid.astro"; +import Details from "@components/Details.astro"; + Zarf offers a comprehensive solution for deploying system software or capabilities while fully disconnected. This is accomplished through the use of a single tarball archive, which includes all necessary components and is defined by a `zarf.yaml` file. Zarf packages are created while you are connected to internet or intranet resources defined in a Zarf package configuration. This allows these resources to be pulled and stored within a package archive and be deployed on disconnected systems without requiring a connection to the outside world. @@ -81,3 +84,57 @@ In addition to the traditional sources outlined above, there is also a special " Additionally, inspecting a package deployed to a cluster will not be able to show the package's SBOMs, as they are not currently persisted to the cluster. ::: + +The following diagram shows the order of operations for the `zarf package create` command and the hook locations for [actions](/ref/actions). + +
+A2 + A2(parse zarf.yaml)-->A3 + A3(filter components by architecture)-->A4 + A4(detect init package)-->A5 + A5(handle deprecations)-->A6 + A6(parse component imports)-->A7 + A7(process create-time variables)-->A8 + A8(write build data and zarf.yaml)-->A9 + + A9(run validations)-->A10 + A10(confirm package create):::prompt-->A11 + A11{Init package?} + A11 -->|Yes| A12(add seed image)-->A13 + A11 -->|No| A13 + + subgraph "" + A13(add each component)-->A13 + A13 --> A14(run each '.actions.onCreate.before'):::action-->A14 + A14 --> A15(load '.charts')-->A16 + A16(load '.files')-->A17 + A17(load '.dataInjections')-->A18 + A18(load '.manifests')-->A19 + A19(load '.repos')-->A20 + A20(run each '.actions.onCreate.after'):::action-->A20 + A20-->A21{Success?} + A21-->|Yes|A22(run each\n'.actions.onCreate.success'):::action-->A22 + A21-->|No|A23(run each\n'.actions.onCreate.failure'):::action-->A23-->A999 + end + + A22-->A24(load all '.images') + A24-->A25{Skip SBOM?} + A25-->|Yes|A27 + A25-->|No|A26 + A26(generate SBOM)-->A27 + A27(reset working directory)-->A28 + A28(create package archive)-->A29 + A29{Is multipart?} + A29-->|Yes|A30(split package archive)-->A31 + A29-->|No|A31 + A31(handle sbom view/out flags) + + A999[Abort]:::fail + + classDef prompt fill:#4adede,color:#000000 + classDef action fill:#bd93f9,color:#000000 + classDef fail fill:#aa0000 +`}/> +
From ca24c0d60d7496dba8bb8b6d56d45dee13a59bc8 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 13:40:59 +0000 Subject: [PATCH 09/18] redo --- site/src/content/docs/ref/create.mdx | 68 ++++++++++++++++++++++++-- site/src/content/docs/ref/packages.mdx | 57 --------------------- 2 files changed, 64 insertions(+), 61 deletions(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index 2d68f292aa..4d7cecf219 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -1,10 +1,70 @@ --- -title: Create Templates +title: Create a package sidebar: - order: 32 + order: 60 --- -Templates are used during `zarf package create` to template the `zarf.yaml` file. Templates are baked into the Zarf package meaning they cannot be changed post create. +import Mermaid from "@components/Mermaid.astro"; +import Details from "@components/Details.astro"; + +The following diagram shows the order of operations for the `zarf package create` command and the hook locations for [actions](/ref/actions). + +
+A2 + A2(parse zarf.yaml)-->A3 + A3(filter components by architecture)-->A4 + A4(detect init package)-->A5 + A5(handle deprecations)-->A6 + A6(parse component imports)-->A7 + A7(process create-time variables)-->A8 + A8(write build data and zarf.yaml)-->A9 + + A9(run validations)-->A10 + A10(confirm package create):::prompt-->A11 + A11{Init package?} + A11 -->|Yes| A12(add seed image)-->A13 + A11 -->|No| A13 + + subgraph "" + A13(add each component)-->A13 + A13 --> A14(run each '.actions.onCreate.before'):::action-->A14 + A14 --> A15(load '.charts')-->A16 + A16(load '.files')-->A17 + A17(load '.dataInjections')-->A18 + A18(load '.manifests')-->A19 + A19(load '.repos')-->A20 + A20(run each '.actions.onCreate.after'):::action-->A20 + A20-->A21{Success?} + A21-->|Yes|A22(run each\n'.actions.onCreate.success'):::action-->A22 + A21-->|No|A23(run each\n'.actions.onCreate.failure'):::action-->A23-->A999 + end + + A22-->A24(load all '.images') + A24-->A25{Skip SBOM?} + A25-->|Yes|A27 + A25-->|No|A26 + A26(generate SBOM)-->A27 + A27(reset working directory)-->A28 + A28(create package archive)-->A29 + A29{Is multipart?} + A29-->|Yes|A30(split package archive)-->A31 + A29-->|No|A31 + A31(handle sbom view/out flags) + + A999[Abort]:::fail + + classDef prompt fill:#4adede,color:#000000 + classDef action fill:#bd93f9,color:#000000 + classDef fail fill:#aa0000 +`}/> +
+ + +## Package Templates + +Templates are used during `zarf package create` to parameterize the `zarf.yaml` file. Templates are baked into the Zarf package meaning they cannot be changed post create. :::caution @@ -12,7 +72,7 @@ Templates are used during `zarf package create` to template the `zarf.yaml` file ::: -You can specify `zarf.yaml` package configuration templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. These values are discovered during `zarf package create` and will always be prompted for if not using `--confirm` or not already set. Templates be set using [config files](/ref/config-files/) or the `--set` flag. An example of a package using templates is below: +You can specify `zarf.yaml` package configuration templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. These values are discovered during `zarf package create` and will always be prompted for if not using `--confirm` or not already pre-set. Templates be pre-set using [config files](/ref/config-files/) or the `--set` flag. An example of a package using templates is below: ```yaml kind: ZarfPackageConfig diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index 2d50636949..34aa2e5134 100644 --- a/site/src/content/docs/ref/packages.mdx +++ b/site/src/content/docs/ref/packages.mdx @@ -4,9 +4,6 @@ sidebar: order: 20 --- -import Mermaid from "@components/Mermaid.astro"; -import Details from "@components/Details.astro"; - Zarf offers a comprehensive solution for deploying system software or capabilities while fully disconnected. This is accomplished through the use of a single tarball archive, which includes all necessary components and is defined by a `zarf.yaml` file. Zarf packages are created while you are connected to internet or intranet resources defined in a Zarf package configuration. This allows these resources to be pulled and stored within a package archive and be deployed on disconnected systems without requiring a connection to the outside world. @@ -84,57 +81,3 @@ In addition to the traditional sources outlined above, there is also a special " Additionally, inspecting a package deployed to a cluster will not be able to show the package's SBOMs, as they are not currently persisted to the cluster. ::: - -The following diagram shows the order of operations for the `zarf package create` command and the hook locations for [actions](/ref/actions). - -
-A2 - A2(parse zarf.yaml)-->A3 - A3(filter components by architecture)-->A4 - A4(detect init package)-->A5 - A5(handle deprecations)-->A6 - A6(parse component imports)-->A7 - A7(process create-time variables)-->A8 - A8(write build data and zarf.yaml)-->A9 - - A9(run validations)-->A10 - A10(confirm package create):::prompt-->A11 - A11{Init package?} - A11 -->|Yes| A12(add seed image)-->A13 - A11 -->|No| A13 - - subgraph "" - A13(add each component)-->A13 - A13 --> A14(run each '.actions.onCreate.before'):::action-->A14 - A14 --> A15(load '.charts')-->A16 - A16(load '.files')-->A17 - A17(load '.dataInjections')-->A18 - A18(load '.manifests')-->A19 - A19(load '.repos')-->A20 - A20(run each '.actions.onCreate.after'):::action-->A20 - A20-->A21{Success?} - A21-->|Yes|A22(run each\n'.actions.onCreate.success'):::action-->A22 - A21-->|No|A23(run each\n'.actions.onCreate.failure'):::action-->A23-->A999 - end - - A22-->A24(load all '.images') - A24-->A25{Skip SBOM?} - A25-->|Yes|A27 - A25-->|No|A26 - A26(generate SBOM)-->A27 - A27(reset working directory)-->A28 - A28(create package archive)-->A29 - A29{Is multipart?} - A29-->|Yes|A30(split package archive)-->A31 - A29-->|No|A31 - A31(handle sbom view/out flags) - - A999[Abort]:::fail - - classDef prompt fill:#4adede,color:#000000 - classDef action fill:#bd93f9,color:#000000 - classDef fail fill:#aa0000 -`}/> -
From c1e235eb28dc50849b3d68659983c80bba3fb717 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 13:42:37 +0000 Subject: [PATCH 10/18] correct capitalization --- site/src/content/docs/ref/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index 4d7cecf219..6ec7bddbde 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -1,5 +1,5 @@ --- -title: Create a package +title: Create a Package sidebar: order: 60 --- From cd0361e2456dd1aca36408a5a37eb8ab18de1082 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 13:46:00 +0000 Subject: [PATCH 11/18] re-add info --- site/src/content/docs/ref/packages.mdx | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index 34aa2e5134..031e0ce1b1 100644 --- a/site/src/content/docs/ref/packages.mdx +++ b/site/src/content/docs/ref/packages.mdx @@ -22,7 +22,17 @@ Throughout the rest of the documentation, we will refer to the `ZarfInitConfig` The init package is used to initialize a cluster, making it ready for deployment of other Zarf packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. -During the initialization process, Zarf will seed your cluster with a container registry to store images that other packages may require. Additionally, the init package has the option to deploy other features to your cluster, such as a Git server to manage your repositories or a PLG logging stack that allows you to monitor the applications running on your cluster. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). +If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. To install a K8s distribution other than k3s, finding or creating a custom Zarf package is necessary. + +Typically, an init package is the first Zarf Package to be deployed on a cluster as other packages often rely on the services it installs or configures, however Zarf may be used to package and install the cluster distribution itself. In this scenario, the distribution package would be deployed first, followed by the init package, and then any other packages planned for deployment. + +:::tip + +Check out our [k3s cluster package](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) to see an example of a Zarf package which installs a kubernetes distribution + +::: + +During the initialization process, Zarf will seed the cluster with a container registry to store images that other packages may require. Additionally, the init package has the option to deploy other features to your cluster, such as a Git server to manage your repositories or a PLG logging stack that allows you to monitor the applications running on your cluster. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). #### Using the init-package From 27b05e74c46fd6317c36af1ed97a347d5d682f0f Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 13:54:28 +0000 Subject: [PATCH 12/18] reword --- site/src/content/docs/ref/create.mdx | 2 +- site/src/content/docs/ref/packages.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index 6ec7bddbde..c345198395 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -64,7 +64,7 @@ graph TD ## Package Templates -Templates are used during `zarf package create` to parameterize the `zarf.yaml` file. Templates are baked into the Zarf package meaning they cannot be changed post create. +Templates can be used during `zarf package create` to configure the `zarf.yaml` file. Templates are baked into the Zarf package meaning they cannot be changed post create. :::caution diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index 031e0ce1b1..b01105f921 100644 --- a/site/src/content/docs/ref/packages.mdx +++ b/site/src/content/docs/ref/packages.mdx @@ -28,7 +28,7 @@ Typically, an init package is the first Zarf Package to be deployed on a cluster :::tip -Check out our [k3s cluster package](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) to see an example of a Zarf package which installs a kubernetes distribution +Check out our [k3s cluster package](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) to see an example of a Zarf package that installs a kubernetes distribution ::: From 11c0842c17e849f010be3fd09d72cd0cfe4ce983 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 14:07:19 +0000 Subject: [PATCH 13/18] reword --- site/src/content/docs/ref/create.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index c345198395..a7c1acb4cb 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -64,7 +64,7 @@ graph TD ## Package Templates -Templates can be used during `zarf package create` to configure the `zarf.yaml` file. Templates are baked into the Zarf package meaning they cannot be changed post create. +Package configuration templates can be used during `zarf package create` to configure the `zarf.yaml` file. Templates are baked into the Zarf package so they cannot be changed post create. :::caution @@ -72,8 +72,9 @@ Templates can be used during `zarf package create` to configure the `zarf.yaml` ::: -You can specify `zarf.yaml` package configuration templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. These values are discovered during `zarf package create` and will always be prompted for if not using `--confirm` or not already pre-set. Templates be pre-set using [config files](/ref/config-files/) or the `--set` flag. An example of a package using templates is below: +You can specify `zarf.yaml` templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. Template values can be defined using [config files](/ref/config-files/) or the `--set` flag. If a template doesn't have a value on `zarf package create` if will always be prompted for unless `--confirm` is used. +An example of templates if below: ```yaml kind: ZarfPackageConfig metadata: From 7d45da75f1a20749f9a208bdadaf7e6cc7357c1f Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 14:11:18 +0000 Subject: [PATCH 14/18] wording --- site/src/content/docs/ref/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index a7c1acb4cb..7169aa6857 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -72,7 +72,7 @@ Package configuration templates can be used during `zarf package create` to conf ::: -You can specify `zarf.yaml` templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. Template values can be defined using [config files](/ref/config-files/) or the `--set` flag. If a template doesn't have a value on `zarf package create` if will always be prompted for unless `--confirm` is used. +You can specify `zarf.yaml` templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. Template values can be defined using [config files](/ref/config-files/) or the `--set` flag. If a template is undefined during `zarf package create` if will always be prompted for unless `--confirm` is used. An example of templates if below: ```yaml From 2b513b95ada129967a1884321311b7d17512345e Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 14:12:13 +0000 Subject: [PATCH 15/18] reword --- site/src/content/docs/ref/create.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/create.mdx b/site/src/content/docs/ref/create.mdx index 7169aa6857..8ce19e4e95 100644 --- a/site/src/content/docs/ref/create.mdx +++ b/site/src/content/docs/ref/create.mdx @@ -74,7 +74,7 @@ Package configuration templates can be used during `zarf package create` to conf You can specify `zarf.yaml` templates at package create time by including `###_ZARF_PKG_TMPL_*###` as the value for any string-type data in your package definition. Template values can be defined using [config files](/ref/config-files/) or the `--set` flag. If a template is undefined during `zarf package create` if will always be prompted for unless `--confirm` is used. -An example of templates if below: +An example of templates is below: ```yaml kind: ZarfPackageConfig metadata: From 5e4eb1c9d2e948c54624d4edc752362b113316e6 Mon Sep 17 00:00:00 2001 From: Austin Abro <37223396+AustinAbro321@users.noreply.github.com> Date: Wed, 24 Apr 2024 11:57:12 -0400 Subject: [PATCH 16/18] Apply suggestions from code review Co-authored-by: Lucas Rodriguez --- site/src/content/docs/ref/packages.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index b01105f921..ff9517a06d 100644 --- a/site/src/content/docs/ref/packages.mdx +++ b/site/src/content/docs/ref/packages.mdx @@ -22,13 +22,13 @@ Throughout the rest of the documentation, we will refer to the `ZarfInitConfig` The init package is used to initialize a cluster, making it ready for deployment of other Zarf packages. It must be executed once on each cluster that you want to deploy another package onto, even if multiple clusters share the same host. -If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. To install a K8s distribution other than k3s, finding or creating a custom Zarf package is necessary. +If there is no running cluster, the init package can be used to create one. It has a deployable K3s cluster component that can be optionally deployed on your machine. To install a K8s distribution other than K3s, finding or creating a custom Zarf Package is necessary. Typically, an init package is the first Zarf Package to be deployed on a cluster as other packages often rely on the services it installs or configures, however Zarf may be used to package and install the cluster distribution itself. In this scenario, the distribution package would be deployed first, followed by the init package, and then any other packages planned for deployment. :::tip -Check out our [k3s cluster package](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) to see an example of a Zarf package that installs a kubernetes distribution +Check out our [K3s cluster package](https://github.com/defenseunicorns/zarf/blob/main/packages/distros/k3s/zarf.yaml) to see an example of a Zarf Package that installs a Kubernetes distribution ::: From 8b420ac3cb50c771330d76d8027be52c21bd6083 Mon Sep 17 00:00:00 2001 From: Austin Abro <37223396+AustinAbro321@users.noreply.github.com> Date: Wed, 24 Apr 2024 15:54:51 -0400 Subject: [PATCH 17/18] Update site/src/content/docs/ref/packages.mdx Co-authored-by: schristoff <167717759+schristoff-du@users.noreply.github.com> --- site/src/content/docs/ref/packages.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index ff9517a06d..4cb1e4434c 100644 --- a/site/src/content/docs/ref/packages.mdx +++ b/site/src/content/docs/ref/packages.mdx @@ -32,7 +32,7 @@ Check out our [K3s cluster package](https://github.com/defenseunicorns/zarf/blob ::: -During the initialization process, Zarf will seed the cluster with a container registry to store images that other packages may require. Additionally, the init package has the option to deploy other features to your cluster, such as a Git server to manage your repositories or a PLG logging stack that allows you to monitor the applications running on your cluster. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). +During the initialization process, Zarf will seed the cluster with a container registry to store images that other packages may require. The init package has the option to deploy other features to your cluster, such as a Git server to manage your repositories or a PLG logging stack that allows you to monitor the applications running on your cluster. For additional information on the init package, we provide detailed documentation on the Zarf ['init' package page](/ref/init-package/). #### Using the init-package From a48bd5e5dc00814a9da3bc8c97a2194965802c35 Mon Sep 17 00:00:00 2001 From: Austin Abro Date: Wed, 24 Apr 2024 19:56:32 +0000 Subject: [PATCH 18/18] two spaces + quotes --- site/src/content/docs/ref/deploy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/src/content/docs/ref/deploy.mdx b/site/src/content/docs/ref/deploy.mdx index 2a19268c4c..f6b144c9bd 100644 --- a/site/src/content/docs/ref/deploy.mdx +++ b/site/src/content/docs/ref/deploy.mdx @@ -50,7 +50,7 @@ graph TD B12(prompt to confirm components)-->B13 B13(prompt to choose components in '.group')-->B14 - subgraph + subgraph "" B14(deploy each component)-->B14 B14 --> B15(run each '.actions.onDeploy.before'):::action-->B15 B15 --> B16(copy '.files')-->B17