From 6e461d998fa9d16db1c9ff185f2c5df1b17da203 Mon Sep 17 00:00:00 2001 From: Madeline <92826525+Madeline-UX@users.noreply.github.com> Date: Tue, 28 Feb 2023 15:50:55 -0600 Subject: [PATCH 1/2] Content edits to Docs Overview - Made list formatting consistent with Docs Style Guide - Added new feature to feature list ( Convert SBOM JSON file into other formats (.xpdx or .cyclone.dx) to meet government compliance.) --- docs/0-zarf-overview.md | 51 +++++++++++++++++++++-------------------- 1 file changed, 26 insertions(+), 25 deletions(-) diff --git a/docs/0-zarf-overview.md b/docs/0-zarf-overview.md index c537079ebf..0a208bdcb9 100644 --- a/docs/0-zarf-overview.md +++ b/docs/0-zarf-overview.md @@ -30,11 +30,11 @@ A typical Zarf deployment is made up of three parts - a statically compiled Go binary that can be run on any machine, server, or operating system with or without connectivity. - creates packages containing numerous software types/updates into a single distributable package (while on an internet-accessible network) - declaratively deploys package contents "into place" for use on production systems (while on an internet-isolated network). -2. A Zarf init package +2. A Zarf init package: - compressed tarball package that contains the configuration needed to instantiate an environment without connectivity - Automatically seeds your cluster with a container registry - Provide additional capabilities such as (logging, git server, and K8s cluster) -3. A Zarf Package +3. A Zarf Package: - compressed tarball package that contains all of the files, manifests, source repositories, and images needed to deploy your infrastructure, application, and resources in a disconnected environment. :::note @@ -57,9 +57,9 @@ Given Zarf's being a "k8s cluster to serve _other_ k8s clusters", the following - Container images: to serve images for the Zarf & downstream clusters to run containers from. - Repositories: to serve as the git-based "source of truth" for downstream "GitOps"ed k8s clusters to watch. - Pre-compiled binaries: to provide the software necessary to start & support the Zarf cluster. -- [Component actions](4-user-guide/7-github-action.md): to support scripts and commands that run at various stages of the Zarf [component lifecycle](4-user-guide/4-package-command-lifecycle.md) -- Helm charts, kustomizations, and other k8s manifests: to apply in a Kubernetes cluster -- [Data injections](../examples/data-injection/README.md): to declaratively inject data into running containers in a Kubernetes cluster +- [Component actions](4-user-guide/7-github-action.md): to support scripts and commands that run at various stages of the Zarf [component lifecycle](4-user-guide/4-package-command-lifecycle.md). +- Helm charts, kustomizations, and other k8s manifests: to apply in a Kubernetes cluster. +- [Data injections](../examples/data-injection/README.md): to declaratively inject data into running containers in a Kubernetes cluster. ## How To Use Zarf @@ -87,9 +87,9 @@ When it comes to remote, constrained, independent, air-gapped systems, everyone' Once your package has landed you will need to: -- install the binary onto the system, -- run the zarf init package -- deploy your package to your cluster. +1. install the binary onto the system, +2. run the zarf init package +3. deploy your package to your cluster. ## Cluster Configuration Options @@ -122,29 +122,30 @@ In the more complex use case, your package consists of updates for many apps/sys ### 📦 Out of the Box Features -- Automates Kubernetes deployments in disconnected environments -- Automates [Software Bill of Materials (SBOM)](https://www.linuxfoundation.org/tools/the-state-of-software-bill-of-materials-sbom-and-cybersecurity-readiness/) generation -- Provides an [SBOM dashboard UI](dashboard-ui/sbom-dashboard) -- Deploys a new cluster while fully disconnected with [K3s](https://k3s.io/) or into any existing cluster using a [Kube config](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) -- Built-in logging stack with [Loki](https://grafana.com/oss/loki/) -- Built-in git server with [Gitea](https://gitea.com/) -- Built-in docker registry -- Built-in [K9s Dashboard](https://k9scli.io/) for managing a cluster from the terminal -- [Mutating Webhook](adr/0005-mutating-webhook.md) to automatically update Kubernetes pod's image path and pull secrets as well as [Flux Git Repository](https://fluxcd.io/docs/components/source/gitrepositories/) URLs and secret references -- Built-in [command to find images](user-guide/the-zarf-cli/cli-commands/zarf_prepare_find-images) and resources from a helm chart -- Tunneling capability to [connect to Kubernetes resources](user-guide/the-zarf-cli/cli-commands/zarf_connect) without network routing, DNS, TLS, or Ingress configuration required +- Automates Kubernetes deployments in disconnected environments. +- Automates [Software Bill of Materials (SBOM)](https://www.linuxfoundation.org/tools/the-state-of-software-bill-of-materials-sbom-and-cybersecurity-readiness/) generation. +- Provides an [SBOM dashboard UI](dashboard-ui/sbom-dashboard). +- Convert SBOM JSON file into other formats (.xpdx or .cyclone.dx) to meet goverment compliance. +- Deploys a new cluster while fully disconnected with [K3s](https://k3s.io/) or into any existing cluster using a [Kube config](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/). +- Built-in logging stack with [Loki](https://grafana.com/oss/loki/). +- Built-in git server with [Gitea](https://gitea.com/). +- Built-in docker registry. +- Built-in [K9s Dashboard](https://k9scli.io/) for managing a cluster from the terminal. +- [Mutating Webhook](adr/0005-mutating-webhook.md) to automatically update Kubernetes pod's image path and pull secrets as well as [Flux Git Repository](https://fluxcd.io/docs/components/source/gitrepositories/) URLs and secret references. +- Built-in [command to find images](user-guide/the-zarf-cli/cli-commands/zarf_prepare_find-images) and resources from a helm chart. +- Tunneling capability to [connect to Kubernetes resources](user-guide/the-zarf-cli/cli-commands/zarf_connect) without network routing, DNS, TLS, or Ingress configuration required. ### 🛠️ Configurable Features -- Customizable [packages variables](examples/package-variables/README.md) with defaults and user prompting -- [Composable packages](user-guide/zarf-packages/zarf-components#composing-package-components) to include multiple sub-packages/components -- Filters to select the correct architectures/operating systems for packages +- Customizable [packages variables](examples/package-variables/README.md) with defaults and user prompting. +- [Composable packages](user-guide/zarf-packages/zarf-components#composing-package-components) to include multiple sub-packages/components. +- Filters to select the correct architectures/operating systems for packages. ## Quick Start -1. 💻 Select your system's OS below -2. ❗ Ensure you have the pre-requisite applications running -3. `$` Enter the commands into your terminal +1. 💻 Select your system's OS below. +2. ❗ Ensure you have the pre-requisite applications running. +3. `$` Enter the commands into your terminal. From 2e174674d384a76121d417108470cf3bdb3b72e9 Mon Sep 17 00:00:00 2001 From: Madeline <92826525+Madeline-UX@users.noreply.github.com> Date: Tue, 28 Feb 2023 15:58:03 -0600 Subject: [PATCH 2/2] Update 0-zarf-overview.md --- docs/0-zarf-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/0-zarf-overview.md b/docs/0-zarf-overview.md index 0a208bdcb9..cd0d071fa7 100644 --- a/docs/0-zarf-overview.md +++ b/docs/0-zarf-overview.md @@ -125,7 +125,7 @@ In the more complex use case, your package consists of updates for many apps/sys - Automates Kubernetes deployments in disconnected environments. - Automates [Software Bill of Materials (SBOM)](https://www.linuxfoundation.org/tools/the-state-of-software-bill-of-materials-sbom-and-cybersecurity-readiness/) generation. - Provides an [SBOM dashboard UI](dashboard-ui/sbom-dashboard). -- Convert SBOM JSON file into other formats (.xpdx or .cyclone.dx) to meet goverment compliance. +- Convert SBOM JSON file into government compliant format (.xpdx or .cyclone.dx). - Deploys a new cluster while fully disconnected with [K3s](https://k3s.io/) or into any existing cluster using a [Kube config](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/). - Built-in logging stack with [Loki](https://grafana.com/oss/loki/). - Built-in git server with [Gitea](https://gitea.com/).