-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: promote quick start page in docs (#2182)
## Description This PR promotes the Quick Start page in the docs to allow easier discovery and linking from other sources. ## Related Issue Fixes #N/A ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [X] Other (security config, docs update, etc) ## Checklist before merging - [X] Test, docs, adr added or updated as needed - [X] [Contributor Guide Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow) followed
- Loading branch information
Showing
7 changed files
with
219 additions
and
210 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| import TabItem from "@theme/TabItem"; | ||
| import Tabs from "@theme/Tabs"; | ||
|
|
||
| # Installing Zarf | ||
|
|
||
| Depending on your operating system and specific setup there are a few ways you can get the Zarf CLI onto your machine: | ||
|
|
||
| - [Install from Homebrew](#installing-from-the-defense-unicorns-homebrew-tap). | ||
| - [Download a prebuilt binary](#downloading-a-prebuilt-binary-from-our-github-releases). | ||
| - [Build the CLI](#building-the-cli-from-scratch) from scratch. | ||
|
|
||
| [Post-Install](#post-install-steps), you can verify that Zarf is correctly on your `$PATH` and that you have an 'init' package for your environment and Zarf version. | ||
|
|
||
| ## Installing the CLI with Homebrew | ||
|
|
||
| [Homebrew](https://brew.sh/) is an open-source software package manager that simplifies the installation of software on macOS and Linux. | ||
|
|
||
|
|
||
| <Tabs> | ||
| <TabItem value="macOS"> | ||
|
|
||
| With Homebrew on macOS, installing Zarf is as simple as: | ||
|
|
||
| ```bash | ||
| brew tap defenseunicorns/tap && brew install zarf | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="Linux"> | ||
|
|
||
| With Homebrew on Linux, installing Zarf is as simple as: | ||
|
|
||
| ```bash | ||
| brew tap defenseunicorns/tap && brew install zarf | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| :::note | ||
|
|
||
| The above command detects your OS and system architecture and installs the correct Zarf CLI binary for your machine. Once the above command is entered, the CLI should be installed on your `$PATH` and is ready for immediate use. | ||
|
|
||
| ::: | ||
|
|
||
| ## Downloading the CLI from GitHub Releases | ||
|
|
||
| All [Zarf releases](https://github.com/defenseunicorns/zarf/releases) on GitHub include prebuilt binaries that you can download and use. We offer range of combinations of OS and architecture for you to choose from. | ||
|
|
||
| <Tabs> | ||
| <TabItem value="Linux"> | ||
|
|
||
| To download Zarf on Linux you can run the following (replacing `<zarf-version>` with a version of Zarf): | ||
|
|
||
| ```bash | ||
| ZARF_VERSION=<zarf-version> | ||
| ZARF_ARCH=$([ $(uname -m) == "x86_64" ] && echo "amd64" || echo "arm64";) | ||
|
|
||
| curl -sL https://github.com/defenseunicorns/zarf/releases/download/${ZARF_VERSION}/zarf_${ZARF_VERSION}_Linux_${ZARF_ARCH} -o zarf | ||
| chmod +x zarf | ||
| ``` | ||
|
|
||
| On most Linux distributions, you can also install the binary onto your `$PATH` by simply moving the downloaded binary to the `/usr/local/bin` directory: | ||
|
|
||
| ```bash | ||
| sudo mv zarf /usr/local/bin/zarf | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="macOS"> | ||
|
|
||
| To download Zarf on macOS you can run the following (replacing `<zarf-version>` with a version of Zarf): | ||
|
|
||
| ```bash | ||
| ZARF_VERSION=<zarf-version> | ||
| ZARF_ARCH=$([ $(uname -m) == "x86_64" ] && echo "amd64" || echo "arm64";) | ||
|
|
||
| curl -sL https://github.com/defenseunicorns/zarf/releases/download/${ZARF_VERSION}/zarf_${ZARF_VERSION}_Darwin_${ZARF_ARCH} -o zarf | ||
| chmod +x zarf | ||
| ``` | ||
|
|
||
| You can also install the binary onto your `$PATH` by simply moving the downloaded binary to the `/usr/local/bin` directory: | ||
|
|
||
| ```bash | ||
| sudo mv zarf /usr/local/bin/zarf | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="Windows"> | ||
|
|
||
|
|
||
| To download Zarf on Windows you can run the following (replacing `<zarf-version>` with a version of Zarf and `<zarf-arch>` with either `amd64` or `arm64` depending on your system): | ||
|
|
||
| ```bash | ||
| $ZarfVersion="<zarf-version>" | ||
| $ZarfArch="<zarf-arch>" | ||
|
|
||
| Start-BitsTransfer -Source "https://github.com/defenseunicorns/zarf/releases/download/$($ZarfVersion)/zarf_$($ZarfVersion)_Windows_$($ZarfArch).exe" -Destination zarf.exe | ||
| ``` | ||
|
|
||
| You can also install the binary onto your `$PATH` by moving the downloaded binary to the desired directory and modifying the `$PATH` environment variable to include that directory. | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ## Building the CLI from Scratch | ||
|
|
||
| If you want to build the CLI from scratch, you can do that too. Our local builds depend on [Go 1.19.x](https://golang.org/doc/install) and [Node 18.x](https://nodejs.org/en) and are built using [make](https://www.gnu.org/software/make/). | ||
|
|
||
| :::note | ||
|
|
||
| The `make build-cli` command builds a binary for each combination of OS and architecture. If you want to shorten the build time, you can use an alternative command to only build the binary you need: | ||
|
|
||
| - `make build-cli-mac-intel` | ||
| - `make build-cli-mac-apple` | ||
| - `make build-cli-linux-amd` | ||
| - `make build-cli-linux-arm` | ||
| - `make build-cli-windows-amd` | ||
| - `make build-cli-windows-arm` | ||
|
|
||
| For additional information, see the [Building Your Own Zarf CLI](../2-the-zarf-cli/0-building-your-own-cli.md) page. | ||
|
|
||
| ::: | ||
|
|
||
| ## Post-Install Steps | ||
|
|
||
| Once you have installed Zarf with one of the above methods, you can verify it is working with the following: | ||
|
|
||
| ```bash | ||
| $ zarf version | ||
|
|
||
| vX.X.X # X.X.X is replaced with the version number of your specific installation | ||
| ``` | ||
|
|
||
| :::info | ||
|
|
||
| If you are not seeing this then Zarf was not installed onto your `$PATH` correctly. [This $PATH guide](https://zwbetz.com/how-to-add-a-binary-to-your-path-on-macos-linux-windows/) should help with that. | ||
|
|
||
| ::: | ||
|
|
||
| In most usage scenarios ([but not all](../../examples/yolo/README.md)) you will also need an ['init' package](../3-create-a-zarf-package/3-zarf-init-package.md) to be initialized before you deploy your own packages. This is a special Zarf package that initializes a cluster with services that are used to store package resources while in the air gap. | ||
|
|
||
| You can get the default 'init' package for your version of Zarf by visiting the [Zarf releases](https://github.com/defenseunicorns/zarf/releases) page and downloading it into your working directory or into `~/.zarf-cache/zarf-init-<amd64|arm64>-vX.X.X.tar.zst`. | ||
|
|
||
| If you are online on the machine with cluster access you can also run `zarf init` without the `--confirm` flag to be given the option to download the matching version of the default 'init' package or you can use the `zarf tools download-init` command to download a copy to your machine. | ||
|
|
||
| :::tip | ||
|
|
||
| You can build your own custom 'init' package too if you'd like. For this you should check out the [Creating a Custom 'init' Package Tutorial](../5-zarf-tutorials/8-custom-init-packages.md). | ||
|
|
||
| ::: |
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/1-getting-started/1-core-concepts.md → docs/1-getting-started/2-core-concepts.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.