Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Full IA Update #1639

Merged
merged 9 commits into from
May 2, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ Zarf eliminates the [complexity of air gap software delivery](https://www.itopst

_<https://www.youtube.com/watch?v=WnOYlFVVKDE>_

## Getting Started
## Getting Started

To try Zarf out for yourself, visit the ["Try It Now"](https://zarf.dev/install) section on our website, and if you want to learn more about Zarf and its use cases visit [docs.zarf.dev](https://docs.zarf.dev/docs/zarf-overview).

From the docs you can learn more about [installation](https://docs.zarf.dev/docs/operator-manual/set-up-and-install), [using the CLI](https://docs.zarf.dev/docs/user-guide/the-zarf-cli/), [making packages](https://docs.zarf.dev/docs/user-guide/zarf-packages/), and the [Zarf package schema](https://docs.zarf.dev/docs/user-guide/zarf-schema).
From the docs you can learn more about [installation](docs/3-getting-started/0-set-up-and-install.md), [using the CLI](https://docs.zarf.dev/docs/user-guide/the-zarf-cli/), [making packages](https://docs.zarf.dev/docs/user-guide/zarf-packages/), and the [Zarf package schema](https://docs.zarf.dev/docs/user-guide/zarf-schema).
Racer159 marked this conversation as resolved.
Show resolved Hide resolved

Using Zarf in Github workflows? Check out the [setup-zarf](https://github.com/defenseunicorns/setup-zarf) action. Install any version of Zarf and its `init` package with zero added dependencies.

Expand Down
6 changes: 3 additions & 3 deletions docs/0-zarf-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ It also simplifies the installation, updating, and maintenance of DevSecOps capa

:::note

Check out our [glossary](1-understand-the-basics.md) for an explanation of common terms used in the project.
Check out our [glossary](3-getting-started/1-understand-the-basics.md) for an explanation of common terms used in the project.

:::

Expand Down Expand Up @@ -165,7 +165,7 @@ This quick start requires you to already have:
- [Homebrew](https://brew.sh/) package manager installed on your machine.
- [Docker](https://www.docker.com/) installed and running on your machine.

For more install options please visit our [Getting Started page](3-getting-started.md).
For more install options please visit our [Getting Started page](./3-getting-started/index.md).

</Admonition>

Expand Down Expand Up @@ -203,7 +203,7 @@ This quick start requires you to already have:
- [Homebrew](https://brew.sh/) package manager installed on your machine.
- [Docker](https://www.docker.com/) installed and running on your machine.

For more install options please visit our [Getting Started page](3-getting-started.md).
For more install options please visit our [Getting Started page](./3-getting-started/index.md).

</Admonition>

Expand Down
4 changes: 2 additions & 2 deletions docs/12-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

1. Make sure you've read the guides in:
- [Zarf Overview](./0-zarf-overview.md)
- [Understanding the Basics](./1-understand-the-basics.md)
- [Getting Started](./3-getting-started.md)
- [Understanding the Basics](3-getting-started/1-understand-the-basics.md)
- [Getting Started](./3-getting-started/index.md)
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 request a new feature](https://github.com/defenseunicorns/zarf/issues)
2 changes: 1 addition & 1 deletion docs/13-walkthroughs/0-using-zarf-package-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ When creating a Zarf package, you must have an Internet connection so that Zarf
## Walkthrough Prerequisites

- The [Zarf](https://github.com/defenseunicorns/zarf) repository cloned: ([git clone instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
- Zarf binary installed on your $PATH: ([install instructions](../3-getting-started.md#installing-zarf))
- Zarf binary installed on your $PATH: ([install instructions](../3-getting-started/index.md#installing-zarf))
Racer159 marked this conversation as resolved.
Show resolved Hide resolved
- The [Docker CLI](https://docs.docker.com/desktop/) installed for building the [`zarf-agent`](../9-faq.md#what-is-the-zarf-agent) image.

## Building the init-package
Expand Down
2 changes: 1 addition & 1 deletion docs/13-walkthroughs/1-initializing-a-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In this walkthrough, we will demonstrate how to initialize Zarf onto a K8s clust
## Prerequisites

- The [Zarf](https://github.com/defenseunicorns/zarf) repository cloned: ([`git clone` Instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
- Zarf binary installed on your $PATH: ([Install Instructions](../3-getting-started.md#installing-zarf))
- Zarf binary installed on your $PATH: ([Install Instructions](../3-getting-started/index.md#installing-zarf))
Racer159 marked this conversation as resolved.
Show resolved Hide resolved
- An init-package built/downloaded: ([init-package Build Instructions](./0-using-zarf-package-create.md)) or ([Download Location](https://github.com/defenseunicorns/zarf/releases))
- A Kubernetes cluster to work with: ([Local k8s Cluster Instructions](./#setting-up-a-local-kubernetes-cluster))

Expand Down
6 changes: 3 additions & 3 deletions docs/13-walkthroughs/2-deploying-zarf-packages.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Deploying Zarf Packages
# Deploying Zarf Packages

## Introduction

In this walkthrough, we are going to deploy the Helm OCI chart package onto your cluster. In previous walkthroughs, we learned how to [create a package](./0-using-zarf-package-create.md) and [initialize a cluster](./1-initializing-a-k8s-cluster.md). We will be leveraging all that past work and then go the extra step of deploying an application onto our cluster with the `zarf package deploy` command.
In this walkthrough, we are going to deploy the Helm OCI chart package onto your cluster. In previous walkthroughs, we learned how to [create a package](./0-using-zarf-package-create.md) and [initialize a cluster](./1-initializing-a-k8s-cluster.md). We will be leveraging all that past work and then go the extra step of deploying an application onto our cluster with the `zarf package deploy` command.

## System Requirements

Expand All @@ -11,7 +11,7 @@ In this walkthrough, we are going to deploy the Helm OCI chart package onto your
## Prerequisites

Prior to this walkthrough you'll want to have a working cluster with Zarf initialized
1. Zarf binary installed on your $PATH: ([Installing Zarf](../3-getting-started.md#installing-zarf))
1. Zarf binary installed on your $PATH: ([Installing Zarf](../3-getting-started/index.md#installing-zarf))
Racer159 marked this conversation as resolved.
Show resolved Hide resolved
2. [An initialized cluster](./1-initializing-a-k8s-cluster.md)
3. The [Helm OCI chart package created](./0-using-zarf-package-create.md)

Expand Down
4 changes: 2 additions & 2 deletions docs/13-walkthroughs/3-deploy-a-retro-arcade.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Deploying a Retro Arcade
# Deploying a Retro Arcade

## Introduction

Expand All @@ -11,7 +11,7 @@ In previous walkthroughs, we learned how to [create a package](./0-using-zarf-pa
## Prerequisites

1. The [Zarf](https://github.com/defenseunicorns/zarf) repository cloned: ([git clone instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
2. Zarf binary installed on your $PATH: ([Installing Zarf](../3-getting-started.md#installing-zarf))
2. Zarf binary installed on your $PATH: ([Installing Zarf](../3-getting-started/index.md#installing-zarf))
Racer159 marked this conversation as resolved.
Show resolved Hide resolved
3. [An initialized cluster](./1-initializing-a-k8s-cluster.md)

## YouTube Walkthrough
Expand Down
6 changes: 3 additions & 3 deletions docs/13-walkthroughs/4-add-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ More specifically, you'll be adding a [Promtail / Loki / Grafana (PLG)](https://
## Prerequisites

Prior to this walkthrough you'll want to have a working cluster with Zarf initialized
1. Zarf binary installed on your $PATH: ([Installing Zarf](../3-getting-started.md#installing-zarf))
1. Zarf binary installed on your $PATH: ([Installing Zarf](../3-getting-started/index.md#installing-zarf))
2. [Initialize a cluster](./1-initializing-a-k8s-cluster.md).
3. Perform the [Retro Arcade Walkthrough](./3-deploy-a-retro-arcade.md).

Expand All @@ -26,7 +26,7 @@ Prior to this walkthrough you'll want to have a working cluster with Zarf initia
$ zarf init
```

2. When prompted to deploy the package select `y` for Yes, then hit the `enter`
2. When prompted to deploy the package select `y` for Yes, then hit the `enter`
key. <br/> When prompted to deploy the logging component select `y` for Yes, then hit the `enter` key.

<iframe src="/docs/walkthroughs/logging_init_manual.html" height="800px" width="100%"></iframe>
Expand Down Expand Up @@ -108,4 +108,4 @@ If you need to setup a cluster, you can perform the following.
1. Deploy a Kubernetes cluster with the [Creating a K8s Cluster with Zarf](./5-creating-a-k8s-cluster-with-zarf.md) walkthrough.
2. Perform the [Initialize a cluster](./1-initializing-a-k8s-cluster.md) walkthrough.

After that you can try deploying the package again.
After that you can try deploying the package again.
6 changes: 3 additions & 3 deletions docs/13-walkthroughs/5-creating-a-k8s-cluster-with-zarf.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The 'k3s' component requires root access (not just `sudo`!) when deploying as it

## Prerequisites
- The [Zarf](https://github.com/defenseunicorns/zarf) repository cloned: ([`git clone` Instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
- Zarf binary installed on your $PATH: ([Install Instructions](../3-getting-started.md#installing-zarf))
- Zarf binary installed on your $PATH: ([Install Instructions](../3-getting-started/index.md#installing-zarf))
Racer159 marked this conversation as resolved.
Show resolved Hide resolved
- An init-package built/downloaded: ([init-package Build Instructions](./0-using-zarf-package-create.md)) or ([Download Location](https://github.com/defenseunicorns/zarf/releases))

## Walkthrough
Expand All @@ -22,7 +22,7 @@ The 'k3s' component requires root access (not just `sudo`!) when deploying as it
# zarf init
```

2. Confirm Package Deployment: <br/>
2. Confirm Package Deployment: <br/>
- When prompted to deploy the package select `y` for Yes, then hit the `enter` key. <br/>

3. Confirm k3s Component Deployment: <br/>
Expand Down Expand Up @@ -63,4 +63,4 @@ The [`zarf destroy`](../4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_destro

```sh
zarf destroy --confirm
```
```
4 changes: 2 additions & 2 deletions docs/13-walkthroughs/7-publish-and-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In this walkthrough, we are going to run through how to publish a Zarf package t

For following along locally, please ensure the following prerequisites are met:

1. Zarf binary installed on your `$PATH`: ([Install Instructions](../3-getting-started.md#installing-zarf))
1. Zarf binary installed on your `$PATH`: ([Install Instructions](../3-getting-started/index.md#installing-zarf))
Racer159 marked this conversation as resolved.
Show resolved Hide resolved
2. Access to a [Registry supporting the OCI Distribution Spec](https://oras.land/implementors/#registries-supporting-oci-artifacts), this walkthrough will be using Docker Hub
3. Access to a cluster that has been [initialized with zarf](./1-initializing-a-k8s-cluster.md).

Expand Down Expand Up @@ -151,7 +151,7 @@ If you receive this error, either you don't have a Kubernetes cluster, your clus

If you need to setup a cluster, you can perform the following.

1. Deploy a Kubernetes cluster with the [Creating a K8s Cluster with Zarf](./4-creating-a-k8s-cluster-with-zarf.md) walkthrough.
1. Deploy a Kubernetes cluster with the [Creating a K8s Cluster with Zarf](./5-creating-a-k8s-cluster-with-zarf.md) walkthrough.
2. Perform the [Initialize a cluster](./1-initializing-a-k8s-cluster.md) walkthrough.

After that you can try deploying the package again.
Expand Down
2 changes: 1 addition & 1 deletion docs/13-walkthroughs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If a walkthrough has any prerequisites, they will be listed at the beginning of
Almost all walkthroughs will have the following prerequisites/assumptions:

1. The [Zarf](https://github.com/defenseunicorns/zarf) repository cloned: ([git clone instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
1. You have a Zarf binary installed on your $PATH: ([Zarf Install Instructions](../3-getting-started.md#installing-zarf))
1. You have a Zarf binary installed on your $PATH: ([Zarf Install Instructions](../3-getting-started/index.md#installing-zarf))
Racer159 marked this conversation as resolved.
Show resolved Hide resolved
1. You have an init-package built/downloaded: ([init-package Build Instructions](./0-using-zarf-package-create.md)) or ([Download Location](https://github.com/defenseunicorns/zarf/releases))
1. Have a kubernetes cluster running/available (ex. [k3s](https://k3s.io/)/[k3d](https://k3d.io/v5.4.1/)/[Kind](https://kind.sigs.k8s.io/docs/user/quick-start#installation))

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ For macOS or Linux, you may also install the Zarf CLI by using [brew](https://za

<!-- TODO: Some duplicated information from the 'Common CLI Uses' page incoming... -->

Once the Zarf CLI is installed, you can create a cluster using the built-in K3s cluster available in the init package (if another cluster isnt already available). You can find the relevant [init package release](https://github.com/defenseunicorns/zarf/releases) from the GitHub releases page.
Once the Zarf CLI is installed, you can create a cluster using the built-in K3s cluster available in the init package (if another cluster isn't already available). You can find the relevant [init package release](https://github.com/defenseunicorns/zarf/releases) from the GitHub releases page.

Once downloaded, you can install the init package by navigating to the directory containing the package and execute the command [zarf init](../4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_init.md) to install it. Zarf will prompt you with a question, asking if you want to deploy the K3s component. Respond by typing "y" and pressing "Enter" to startup a local single node K3s cluster on your current machine. Additional information regarding initializing a cluster with Zarf is provided in the [Initializing a Cluster](./0-set-up-and-install.md#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](#initializing-a-cluster) 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. To accomplish this, you can:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Core Concepts

Now, assuming you're familiar with Kubernetes, AirGap, and GitOps from [Understanding the Basics](./1-understand-the-basics.md), we can get started on the core concepts of Zarf.
Now, assuming you're familiar with Kubernetes, AirGap, and GitOps from [Understanding the Basics](../3-getting-started/1-understand-the-basics.md), we can get started on the core concepts of Zarf.

## Zarf Concepts

Expand Down
3 changes: 3 additions & 0 deletions docs/3-getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Getting Started"
}
Racer159 marked this conversation as resolved.
Show resolved Hide resolved
12 changes: 6 additions & 6 deletions docs/3-getting-started.md → docs/3-getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

Welcome to the Zarf documentation! This section will list the various ways to install Zarf onto your machine. It will also demonstrate how to verify the installation. Choose the installation type that best suits your needs in accordance with your operating system. Lets get started.
Welcome to the Zarf documentation! This section will list the various ways to install Zarf onto your machine. It will also demonstrate how to verify the installation. Choose the installation type that best suits your needs in accordance with your operating system. Let's get started.

## Installing Zarf

Expand Down Expand Up @@ -41,7 +41,7 @@ The `make` build-cli` command builds a binary for each combination of OS and arc
- `make build-cli-linux-amd`
- `make build-cli-linux-arm`

For additional information, see the [Building Your Own Zarf CLI](./4-user-guide/1-the-zarf-cli/1-building-your-own-cli.md) page.
For additional information, see the [Building Your Own Zarf CLI](../4-user-guide/1-the-zarf-cli/1-building-your-own-cli.md) page.
:::

---
Expand All @@ -64,10 +64,10 @@ If you are not seeing this then Zarf was not installed onto your $PATH correctly

Depending on how familiar you are with Kubernetes, DevOps, and Zarf, let's find what set of information would be most useful to you.

- If you want to become more familiar with Zarf and it's features, see the [Walkthroughs](./13-walkthroughs/index.md) page.
- If you want to become more familiar with Zarf and it's features, see the [Walkthroughs](../13-walkthroughs/index.md) page.

- More information about the Zarf CLI is available on 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 Zarf CLI is available on 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 creates and deploys is available in the [Understanding Zarf Packages](./4-user-guide/2-zarf-packages/1-zarf-packages.md) page.
- More information about the packages that Zarf creates and deploys 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 on the [Understand the Basics](./1-understand-the-basics.md) and [Core Concepts](./2-core-concepts.md) pages.
- If you want to take a step back and better understand the problem Zarf is trying to solve, you can find more context on the [Understand the Basics](../1-understand-the-basics.md) and [Core Concepts](../2-core-concepts.md) pages.
2 changes: 1 addition & 1 deletion docs/4-user-guide/1-the-zarf-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Zarf is a command line interface (CLI) tool that enables secure software deliver
<!-- TODO: @JPERRY Is it better to link to 'Installing Zarf' or should we repeat the information here? (check w/ Madeline) -->
<!-- TODO: @JPERRY Make sure the 'Installing Zarf' section if fully up to date with all the installation methods -->

You can get the Zarf CLI on your machine in a few different ways. You can use the Defense Unicorns Homebrew Tap, download a prebuilt binary from our GitHub releases, or build the CLI from scratch on your own. We provide instructions for all of these methods in the [Installing Zarf](../../3-getting-started.md#installing-zarf) section of the Getting Started guide. If you're eager to start using Zarf and you already have Homebrew installed, you can quickly install it by copying and pasting the relevant commands for your operating system into your terminal:
You can get the Zarf CLI on your machine in a few different ways. You can use the Defense Unicorns Homebrew Tap, download a prebuilt binary from our GitHub releases, or build the CLI from scratch on your own. We provide instructions for all of these methods in the [Installing Zarf](../../3-getting-started/index.md#installing-zarf) section of the Getting Started guide. If you're eager to start using Zarf and you already have Homebrew installed, you can quickly install it by copying and pasting the relevant commands for your operating system into your terminal:

<!-- NOTE: The empty line after the '<TabItem ...>' lines are important for the rendering... -->
<Tabs>
Expand Down
Loading