Skip to content

Commit

Permalink
docs: update repo name across docs
Browse files Browse the repository at this point in the history
  • Loading branch information
salaxander committed Jul 18, 2024
1 parent 37aa79d commit 8bfc96a
Show file tree
Hide file tree
Showing 27 changed files with 68 additions and 68 deletions.
4 changes: 2 additions & 2 deletions site/astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ export default defineConfig({
SkipLink: "./src/components/SkipLink.astro",
},
social: {
github: "https://github.com/defenseunicorns/zarf",
github: "https://github.com/zarf-dev/zarf",
slack: "https://kubernetes.slack.com/archives/C03B6BJAUJ3",
},
favicon: "/favicon.svg",
editLink: {
baseUrl: "https://github.com/defenseunicorns/zarf/edit/main/site",
baseUrl: "https://github.com/zarf-dev/zarf/edit/main/site",
},
logo: {
src: "./src/assets/zarf-logo-header.svg",
Expand Down
2 changes: 1 addition & 1 deletion site/hack/copy-examples.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ async function copyExamples() {
}
const mdx = parsed.get("x-mdx").trim();
examples.push(dir);
const repo = "https://github.com/defenseunicorns/zarf";
const repo = "https://github.com/zarf-dev/zarf";
const link = new URL(`${repo}/edit/main/examples/${dir}/zarf.yaml`).toString();
const fm = `---
title: "${dir}"
Expand Down
2 changes: 1 addition & 1 deletion site/public/architecture.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion site/public/tutorials/package_create_wordpress.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
<b style="color:#ffffff;"> </b><b style="color:#55ffff;">sensitive</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_EMAIL</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The email that is used for the WordPress admin account</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> hello@defenseunicorns.com</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">default</b>:<b style="color:#ff55ff;"> hello@zarf-dev.com</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">prompt</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"></b>-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> WORDPRESS_FIRST_NAME</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> The first name that is used for the WordPress admin account</b>
Expand Down
6 changes: 3 additions & 3 deletions site/src/content/docs/commands/zarf_package_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ zarf package pull PACKAGE_SOURCE [flags]
```
# Pull a package matching the current architecture
$ zarf package pull oci://ghcr.io/defenseunicorns/packages/dos-games:1.0.0
$ zarf package pull oci://ghcr.io/zarf-dev/packages/dos-games:1.0.0
# Pull a package matching a specific architecture
$ zarf package pull oci://ghcr.io/defenseunicorns/packages/dos-games:1.0.0 -a arm64
$ zarf package pull oci://ghcr.io/zarf-dev/packages/dos-games:1.0.0 -a arm64
# Pull a skeleton package
$ zarf package pull oci://ghcr.io/defenseunicorns/packages/dos-games:1.0.0 -a skeleton
$ zarf package pull oci://ghcr.io/zarf-dev/packages/dos-games:1.0.0 -a skeleton
```

### Options
Expand Down
6 changes: 3 additions & 3 deletions site/src/content/docs/contribute/nerd-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Zarf is written entirely in [go](https://go.dev/), except for a single 868Kb bin

- All workloads are installed in the cluster via the [Helm SDK](https://helm.sh/docs/topics/advanced/#go-sdk)
- The OCI Registries used are both from [Docker](https://github.com/distribution/distribution)
- Currently, the Registry and Git servers _are not HA_, see [#375](https://github.com/defenseunicorns/zarf/issues/375) and [#376](https://github.com/defenseunicorns/zarf/issues/376) for discussion on this
- Currently, the Registry and Git servers _are not HA_, see [#375](https://github.com/zarf-dev/zarf/issues/375) and [#376](https://github.com/zarf-dev/zarf/issues/376) for discussion on this
- To avoid TLS issues, Zarf binds to `127.0.0.1:31999` on each node as a [NodePort](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) to allow all nodes to access the pod(s) in the cluster
- Zarf utilizes a [mutating admission webhook](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook) called the [`zarf-agent`](https://github.com/defenseunicorns/zarf/tree/main/src/internal/agent) to modify the image property within the `PodSpec`. The purpose is to redirect it to Zarf's configured registry instead of the the original registry (such as DockerHub, GCR, or Quay). Additionally, the webhook attaches the appropriate [ImagePullSecret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) for the seed registry to the pod. This configuration allows the pod to successfully retrieve the image from the seed registry, even when operating in an air-gapped environment.
- Zarf uses a custom injector system to bootstrap a new cluster. See the PR [#329](https://github.com/defenseunicorns/zarf/pull/329) and [ADR](https://github.com/defenseunicorns/zarf/blob/main/adr/0003-image-injection-into-remote-clusters-without-native-support.md) for more details on how we came to this solution. The general steps are listed below:
- Zarf utilizes a [mutating admission webhook](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook) called the [`zarf-agent`](https://github.com/zarf-dev/zarf/tree/main/src/internal/agent) to modify the image property within the `PodSpec`. The purpose is to redirect it to Zarf's configured registry instead of the the original registry (such as DockerHub, GCR, or Quay). Additionally, the webhook attaches the appropriate [ImagePullSecret](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) for the seed registry to the pod. This configuration allows the pod to successfully retrieve the image from the seed registry, even when operating in an air-gapped environment.
- Zarf uses a custom injector system to bootstrap a new cluster. See the PR [#329](https://github.com/zarf-dev/zarf/pull/329) and [ADR](https://github.com/zarf-dev/zarf/blob/main/adr/0003-image-injection-into-remote-clusters-without-native-support.md) for more details on how we came to this solution. The general steps are listed below:
- Get a list of images in the cluster
- Attempt to create an ephemeral pod using an image from the list
- A small rust binary that is compiled using [musl](https://www.musl-libc.org/) to keep the max binary size as minimal as possible
Expand Down
2 changes: 1 addition & 1 deletion site/src/content/docs/contribute/testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Running Tests
---

Currently, we primarily test Zarf through a series of [end-to-end tests](https://github.com/defenseunicorns/zarf/tree/main/src/test/e2e). These tests are called in the `test-*.yml` workflows and undergo automatic execution against several K8s distros whenever a pull request is created or updated.
Currently, we primarily test Zarf through a series of [end-to-end tests](https://github.com/zarf-dev/zarf/tree/main/src/test/e2e). These tests are called in the `test-*.yml` workflows and undergo automatic execution against several K8s distros whenever a pull request is created or updated.

In addition, Zarf implements unit tests for specific functions where edge cases prove difficult to cover through end-to-end testing alone. Unit tests follow standard Go convention and are `*_test.go` files.

Expand Down
12 changes: 6 additions & 6 deletions site/src/content/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@ title: FAQ

## Who is behind this project?

Zarf was built by the developers at [Defense Unicorns](https://www.defenseunicorns.com/) and an amazing community of contributors.
Zarf was built by the developers at [Defense Unicorns](https://www.zarf-dev.com/) and an amazing community of contributors.

Defense Unicorns' mission is to advance freedom and independence globally through Free and Open Source software.

## What license is Zarf under?

Zarf is under the [Apache License 2.0](https://github.com/defenseunicorns/zarf/blob/main/LICENSE). This is one of the most commonly used licenses for open-source software.
Zarf is under the [Apache License 2.0](https://github.com/zarf-dev/zarf/blob/main/LICENSE). This is one of the most commonly used licenses for open-source software.

## Is Zarf free to use?

Yes! Zarf is Free and Open-Source Software (FOSS). And will remain free forever. We believe Free and Open Source software changes the world and promotes freedom and security. Anyone who sees the value in our tool should be free to use it without fear of vendor locking or licensing fees.

## Do I have to use Homebrew to install Zarf?

No, the Zarf binary and init package can be downloaded from the [Releases Page](https://github.com/defenseunicorns/zarf/releases). Zarf does not need to be installed or available to all users on the system, but it does need to be executable for the current user (i.e. `chmod +x zarf` for Linux/Mac).
No, the Zarf binary and init package can be downloaded from the [Releases Page](https://github.com/zarf-dev/zarf/releases). Zarf does not need to be installed or available to all users on the system, but it does need to be executable for the current user (i.e. `chmod +x zarf` for Linux/Mac).

## What dependencies does Zarf have?

Zarf is statically compiled and written in [Go](https://golang.org/) and [Rust](https://www.rust-lang.org/), so it has no external dependencies. For Linux, Zarf can bring a Kubernetes cluster using [K3s](https://k3s.io/). For Mac and Windows, Zarf can leverage any available local or remote cluster the user has access to. Currently, the K3s installation Zarf performs does require a [Systemd](https://en.wikipedia.org/wiki/Systemd) based system and `root` (not just `sudo`) access.

## How can I improve the speed of loading large images from Docker on `zarf package create`?

Due to some limitations with how Docker provides access to local image layers, `zarf package create` has to rely on `docker save` under the hood which is [very slow overall](https://github.com/defenseunicorns/zarf/issues/1214) and also takes a long time to report progress. We experimented with many ways to improve this, but for now recommend leveraging a local docker registry to speed up the process.
Due to some limitations with how Docker provides access to local image layers, `zarf package create` has to rely on `docker save` under the hood which is [very slow overall](https://github.com/zarf-dev/zarf/issues/1214) and also takes a long time to report progress. We experimented with many ways to improve this, but for now recommend leveraging a local docker registry to speed up the process.

This can be done by running a local registry and pushing the images to it before running `zarf package create`. This will allow `zarf package create` to pull the images from the local registry instead of Docker. This can also be combined with [component actions](/ref/actions/) and [`--registry-override`](/commands/zarf_package_create/) to make the process automatic. Given an example image of `registry.enterprise.corp/my-giant-image:v2` you could do something like this:

Expand Down Expand Up @@ -74,8 +74,8 @@ metadata:
components:
repos:
- https://github.com/defenseunicorns/zarf.git
- ssh://git@github.com/defenseunicorns/zarf.git
- https://github.com/zarf-dev/zarf.git
- ssh://git@github.com/zarf-dev/zarf.git
- file:///home/zarf/workspace/zarf
- git://somegithost.com/zarf.git
```
Expand Down
16 changes: 8 additions & 8 deletions site/src/content/docs/getting-started/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ brew tap defenseunicorns/tap && brew install zarf

## 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.
All [Zarf releases](https://github.com/zarf-dev/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.

export const downloadScript = (os, arch) => `
ZARF_VERSION=$(curl -sIX HEAD https://github.com/defenseunicorns/zarf/releases/latest | grep -i ^location: | grep -Eo 'v[0-9]+.[0-9]+.[0-9]+')
ZARF_VERSION=$(curl -sIX HEAD https://github.com/zarf-dev/zarf/releases/latest | grep -i ^location: | grep -Eo 'v[0-9]+.[0-9]+.[0-9]+')
curl -sL "https://github.com/defenseunicorns/zarf/releases/download/\${ZARF_VERSION}/zarf_\${ZARF_VERSION}_${os}_${arch}" -o zarf
curl -sL "https://github.com/zarf-dev/zarf/releases/download/\${ZARF_VERSION}/zarf_\${ZARF_VERSION}_${os}_${arch}" -o zarf
chmod +x zarf
`

Expand Down Expand Up @@ -66,9 +66,9 @@ sudo mv zarf /usr/local/bin/zarf
To download Zarf on Windows you can run the following (replacing `$ZarfVersion` with any release version of Zarf):

export const downloadPowerShellScript = (arch) => `
$ZarfVersion = (Invoke-RestMethod https://api.github.com/repos/defenseunicorns/zarf/releases/latest).tag_name
$ZarfVersion = (Invoke-RestMethod https://api.github.com/repos/zarf-dev/zarf/releases/latest).tag_name
Start-BitsTransfer -Source "https://github.com/defenseunicorns/zarf/releases/download/$($ZarfVersion)/zarf_$($ZarfVersion)_Windows_${arch}.exe" -Destination zarf.exe
Start-BitsTransfer -Source "https://github.com/zarf-dev/zarf/releases/download/$($ZarfVersion)/zarf_$($ZarfVersion)_Windows_${arch}.exe" -Destination zarf.exe
`

<Tabs>
Expand All @@ -87,7 +87,7 @@ You can also install the binary onto your `$PATH` by moving the downloaded binar
The following are unofficial methods of installing Zarf that are maintained by the community:

- `apk add` on [Alpine Linux Edge](https://pkgs.alpinelinux.org/package/edge/testing/x86_64/zarf)
- `asdf install` with the [ASDF Version Manager](https://github.com/defenseunicorns/asdf-zarf)
- `asdf install` with the [ASDF Version Manager](https://github.com/zarf-dev/asdf-zarf)
- `nix-shell`/`nix-env` with [Nix Packages](https://search.nixos.org/packages?channel=23.05&show=zarf&from=0&size=50&sort=relevance&type=packages&query=zarf)
- `pkgx install` with [pkgx](https://pkgx.dev/pkgs/zarf.dev/)

Expand All @@ -96,7 +96,7 @@ The following are unofficial methods of installing Zarf that are maintained by t
If you want to build the CLI from scratch, you can do that too. Our local builds depend on [Go](https://golang.org/doc/install) and [make](https://www.gnu.org/software/make/).

```bash
git clone https://github.com/defenseunicorns/zarf
git clone https://github.com/zarf-dev/zarf
cd zarf
# build the CLI for your current OS and architecture
make
Expand Down Expand Up @@ -134,7 +134,7 @@ $ zarf tools download-init
$ zarf init --confirm
```

The default 'init' package can also be obtained 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`.
The default 'init' package can also be obtained by visiting the [Zarf releases](https://github.com/zarf-dev/zarf/releases) page and downloading it into your working directory or into `~/.zarf-cache/zarf-init-<amd64|arm64>-vX.X.X.tar.zst`.

:::tip

Expand Down
2 changes: 1 addition & 1 deletion site/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Zarf provides a way to package and deploy software in a way that is **repeatable
- Builtin Git server with [Gitea](https://gitea.com/)
- Builtin Docker registry
- Builtin [K9s Dashboard](https://k9scli.io/) for managing a cluster from the terminal
- [Mutating Webhook](https://github.com/defenseunicorns/zarf/blob/main/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
- [Mutating Webhook](https://github.com/zarf-dev/zarf/blob/main/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
- Builtin [command to find images](/commands/zarf_dev_find-images/) and resources from a Helm chart
- Tunneling capability to [connect to Kubernetes resources](/commands/zarf_connect/) without network routing, DNS, TLS or Ingress configuration required

Expand Down
8 changes: 4 additions & 4 deletions site/src/content/docs/ref/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,27 +162,27 @@ The [`podinfo-flux`](/ref/examples/podinfo-flux/) example showcases a simple Git

#### Tag-Based Git Repository Clone

Tag-based `git` repository cloning is the **recommended** way of cloning a `git` repository for air-gapped deployments because it wraps meaning around a specific point in git history that can easily be traced back to the online world. Tag-based clones are defined using the `scheme://host/repo@tag` format as seen in the example of the `defenseunicorns/zarf` repository (`https://github.com/defenseunicorns/zarf.git@v0.15.0`).
Tag-based `git` repository cloning is the **recommended** way of cloning a `git` repository for air-gapped deployments because it wraps meaning around a specific point in git history that can easily be traced back to the online world. Tag-based clones are defined using the `scheme://host/repo@tag` format as seen in the example of the `zarf-dev/zarf` repository (`https://github.com/zarf-dev/zarf.git@v0.15.0`).

A tag-based clone only mirrors the tag defined in the Zarf definition. The tag will be applied on the `git` mirror to a zarf-specific branch name based on the tag name (e.g. the tag `v0.1.0` will be pushed to the `zarf-ref-v0.1.0` branch). This ensures that this tag will be pushed and received properly by the airgap `git` server.

:::note

If you would like to use a protocol scheme other than http/https, you can do so with something like the following: `ssh://git@github.com/defenseunicorns/zarf.git@v0.15.0`. Using this you can also clone from a local repo to help you manage larger git repositories: `file:///home/zarf/workspace/zarf@v0.15.0`.
If you would like to use a protocol scheme other than http/https, you can do so with something like the following: `ssh://git@github.com/zarf-dev/zarf.git@v0.15.0`. Using this you can also clone from a local repo to help you manage larger git repositories: `file:///home/zarf/workspace/zarf@v0.15.0`.

:::

:::caution

Because Zarf creates long-lived mirrors of repositories in the air gap, it does not support shallow clones (i.e. `git clone --depth x`). These may be present in build environments (i.e. [GitLab runners](https://github.com/defenseunicorns/zarf/issues/1698)) and should be avoided. To learn more about shallow and partial clones see the [GitHub blog on the topic](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone).
Because Zarf creates long-lived mirrors of repositories in the air gap, it does not support shallow clones (i.e. `git clone --depth x`). These may be present in build environments (i.e. [GitLab runners](https://github.com/zarf-dev/zarf/issues/1698)) and should be avoided. To learn more about shallow and partial clones see the [GitHub blog on the topic](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone).

:::

<ExampleYAML src={import("../../../../../examples/git-data/zarf.yaml?raw")} component="specific-tag" />

#### SHA-Based Git Repository Clone

In addition to tags, Zarf also supports cloning and pushing a specific SHA hash from a `git` repository, but this is **not recommended** as it is less readable/understandable than tag cloning. Commit SHAs are defined using the same `scheme://host/repo@shasum` format as seen in the example of the `defenseunicorns/zarf` repository (`https://github.com/defenseunicorns/zarf.git@c74e2e9626da0400e0a41e78319b3054c53a5d4e`).
In addition to tags, Zarf also supports cloning and pushing a specific SHA hash from a `git` repository, but this is **not recommended** as it is less readable/understandable than tag cloning. Commit SHAs are defined using the same `scheme://host/repo@shasum` format as seen in the example of the `zarf-dev/zarf` repository (`https://github.com/zarf-dev/zarf.git@c74e2e9626da0400e0a41e78319b3054c53a5d4e`).

A SHA-based clone only mirrors the SHA hash defined in the Zarf definition. The SHA will be applied on the `git` mirror to a zarf-specific branch name based on the SHA hash (e.g. the SHA `c74e2e9626da0400e0a41e78319b3054c53a5d4e` will be pushed to the `zarf-ref-c74e2e9626da0400e0a41e78319b3054c53a5d4e` branch). This ensures that this tag will be pushed and received properly by the airgap `git` server.

Expand Down
2 changes: 1 addition & 1 deletion site/src/content/docs/ref/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ $ zarf connect [service name]

:::note

You can also specify a package locally, or via oci such as `zarf package deploy oci://defenseunicorns/dos-games:1.0.0-$(uname -m) --key=https://zarf.dev/cosign.pub`
You can also specify a package locally, or via oci such as `zarf package deploy oci://zarf-dev/dos-games:1.0.0-$(uname -m) --key=https://zarf.dev/cosign.pub`

:::

Expand Down
Loading

0 comments on commit 8bfc96a

Please sign in to comment.