From f5c527f522fe94f68a7a65295d5cdbdb635a57a7 Mon Sep 17 00:00:00 2001 From: Xander Grzywinski Date: Thu, 18 Jul 2024 11:29:42 -0400 Subject: [PATCH] docs: update repo name across docs Signed-off-by: Xander Grzywinski --- site/astro.config.ts | 4 ++-- site/hack/copy-examples.js | 2 +- site/public/architecture.drawio.svg | 2 +- .../tutorials/package_create_wordpress.html | 2 +- .../content/docs/commands/zarf_package_pull.md | 6 +++--- site/src/content/docs/contribute/nerd-notes.mdx | 6 +++--- site/src/content/docs/contribute/testing.mdx | 2 +- site/src/content/docs/faq.mdx | 12 ++++++------ .../src/content/docs/getting-started/install.mdx | 16 ++++++++-------- site/src/content/docs/index.mdx | 2 +- site/src/content/docs/ref/components.mdx | 8 ++++---- site/src/content/docs/ref/deploy.mdx | 2 +- site/src/content/docs/ref/deployment-ui.mdx | 4 ++-- site/src/content/docs/ref/dev.mdx | 8 ++++---- site/src/content/docs/ref/github-action.mdx | 6 +++--- site/src/content/docs/ref/init-package.mdx | 10 +++++----- site/src/content/docs/ref/packages.mdx | 2 +- site/src/content/docs/roadmap.mdx | 12 ++++++------ site/src/content/docs/support.mdx | 2 +- .../docs/tutorials/0-creating-a-zarf-package.mdx | 4 ++-- .../tutorials/1-initializing-a-k8s-cluster.mdx | 4 ++-- .../docs/tutorials/3-deploy-a-retro-arcade.mdx | 4 ++-- .../4-creating-a-k8s-cluster-with-zarf.mdx | 4 ++-- site/src/content/docs/tutorials/5-big-bang.mdx | 4 ++-- .../docs/tutorials/7-custom-init-packages.mdx | 2 +- .../tutorials/9-package-create-differential.mdx | 2 +- site/src/content/docs/tutorials/index.mdx | 4 ++-- 27 files changed, 68 insertions(+), 68 deletions(-) diff --git a/site/astro.config.ts b/site/astro.config.ts index d787bd08c6..d00b26b4af 100644 --- a/site/astro.config.ts +++ b/site/astro.config.ts @@ -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", diff --git a/site/hack/copy-examples.js b/site/hack/copy-examples.js index a3cda64641..77abf23104 100644 --- a/site/hack/copy-examples.js +++ b/site/hack/copy-examples.js @@ -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}" diff --git a/site/public/architecture.drawio.svg b/site/public/architecture.drawio.svg index 4fa51a8850..aced8942e9 100644 --- a/site/public/architecture.drawio.svg +++ b/site/public/architecture.drawio.svg @@ -1,4 +1,4 @@ -
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BlabelBorderColor%3Dnone%3BfillColor%3D%23bac8d3%3BstrokeColor%3D%2323445d%3BgradientColor%3Dnone%3Bglass%3D0%3Bshadow%3D0%3Bsketch%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22210%22%20y%3D%22-60%22%20width%3D%22770%22%20height%3D%22908%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
%3CmxGraphModel%3E%3Croot%3...
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BlabelBorderColor%3Dnone%3BfillColor%3D%23bac8d3%3BstrokeColor%3D%2323445d%3BgradientColor%3Dnone%3Bglass%3D0%3Bshadow%3D0%3Bsketch%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22210%22%20y%3D%22-60%22%20width%3D%22770%22%20height%3D%22908%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
%3CmxGraphModel%3E%3Croot%3...
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BlabelBorderColor%3Dnone%3BfillColor%3D%23bac8d3%3BstrokeColor%3D%2323445d%3BgradientColor%3Dnone%3Bglass%3D0%3Bshadow%3D0%3Bsketch%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22210%22%20y%3D%22-60%22%20width%3D%22770%22%20height%3D%22908%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
%3CmxGraphModel%3E%3Croot%3...
ns
ns
ns
ns
pod
pod
rs
rs
deploy
deploy
Zarf-Managed Deployments
Zarf-Managed Deployments
ns
ns
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BlabelBorderColor%3Dnone%3BfillColor%3D%23bac8d3%3BstrokeColor%3D%2323445d%3BgradientColor%3Dnone%3Bglass%3D0%3Bshadow%3D0%3Bsketch%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22210%22%20y%3D%22-60%22%20width%3D%22770%22%20height%3D%22908%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222...
pod
pod
pvc
pvc
nodeport
svc
nodeport...
rs
rs
deploy
deploy
Zarf Registry 
Zarf Registry 
clusterip
svc
clusteri...
rs
rs
deploy
deploy
Zarf Agent
(Mutating Webhook)
Zarf Agent...
pod
pod
pvc
pvc
clusterip
svc
clusteri...
rs
rs
deploy
deploy
Zarf Gitops Service
Zarf Gitops Service
pod
pod
ns
ns
zarf-state
zarf-sta...
NodePort
31999
NodePort...
zarf
zarf
pv
pv
sc
sc
nodeport
svc
nodeport...
Zarf Injector
Zarf Injector
pod
from existing
image
pod...
Dynamic configmaps:
n = tarball size / 512 KB
Dynamic configmaps:...
Dynamic
NodePort

Dynamic...
pv
pv
sc
sc
Zarf Resource
Zarf Resource
Zarf Temporary Resource
Zarf Temporary Resource
Zarf-Managed Resource
Zarf-Managed Resource
Zarf CLI to Cluster Comms
Zarf CLI to Cluster Comms
Image Pull From Zarf Registry
Image Pull From Zarf Registry
Standard K8s Comms
Standard K8s Comms
Standard K8s Controller Comms
Standard K8s Controller Comms
Initial image pulled from zarf-injector nodeport
Initial image pulled from zarf-injector nodep...
Post registry boot all images pull from the registry
Post registry boot all images pull from the regi...
POD Create / Flux GitRepository Create Webhook
POD Create / Flux GitRepository Create Webhook
https://github.com/defenseunicorns/zarf
https://github.com/defenseunicorns/zarf
   1. Create the Zarf State in the cluster
1. Create the Zarf State in the clu...
   2. Launch the injector system
   2. Launch the injector system
   3. Deploy the Zarf Registry
   3. Deploy the Zarf Registry
   4. Deploy the Zarf Agent
   4. Deploy the Zarf Agent
   5. (Optional) Deploy the Zarf Git Server
5. (Optional) Deploy the Zarf Git S...
   6. Push package assets to the cluster
6. Push package assets to the clust...
Text is not SVG - cannot display
+
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BlabelBorderColor%3Dnone%3BfillColor%3D%23bac8d3%3BstrokeColor%3D%2323445d%3BgradientColor%3Dnone%3Bglass%3D0%3Bshadow%3D0%3Bsketch%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22210%22%20y%3D%22-60%22%20width%3D%22770%22%20height%3D%22908%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
%3CmxGraphModel%3E%3Croot%3...
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BlabelBorderColor%3Dnone%3BfillColor%3D%23bac8d3%3BstrokeColor%3D%2323445d%3BgradientColor%3Dnone%3Bglass%3D0%3Bshadow%3D0%3Bsketch%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22210%22%20y%3D%22-60%22%20width%3D%22770%22%20height%3D%22908%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
%3CmxGraphModel%3E%3Croot%3...
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BlabelBorderColor%3Dnone%3BfillColor%3D%23bac8d3%3BstrokeColor%3D%2323445d%3BgradientColor%3Dnone%3Bglass%3D0%3Bshadow%3D0%3Bsketch%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22210%22%20y%3D%22-60%22%20width%3D%22770%22%20height%3D%22908%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
%3CmxGraphModel%3E%3Croot%3...
ns
ns
ns
ns
pod
pod
rs
rs
deploy
deploy
Zarf-Managed Deployments
Zarf-Managed Deployments
ns
ns
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222%22%20value%3D%22%22%20style%3D%22rounded%3D1%3BwhiteSpace%3Dwrap%3Bhtml%3D1%3BlabelBorderColor%3Dnone%3BfillColor%3D%23bac8d3%3BstrokeColor%3D%2323445d%3BgradientColor%3Dnone%3Bglass%3D0%3Bshadow%3D0%3Bsketch%3D0%3B%22%20vertex%3D%221%22%20parent%3D%221%22%3E%3CmxGeometry%20x%3D%22210%22%20y%3D%22-60%22%20width%3D%22770%22%20height%3D%22908%22%20as%3D%22geometry%22%2F%3E%3C%2FmxCell%3E%3C%2Froot%3E%3C%2FmxGraphModel%3E
%3CmxGraphModel%3E%3Croot%3E%3CmxCell%20id%3D%220%22%2F%3E%3CmxCell%20id%3D%221%22%20parent%3D%220%22%2F%3E%3CmxCell%20id%3D%222...
pod
pod
pvc
pvc
nodeport
svc
nodeport...
rs
rs
deploy
deploy
Zarf Registry 
Zarf Registry 
clusterip
svc
clusteri...
rs
rs
deploy
deploy
Zarf Agent
(Mutating Webhook)
Zarf Agent...
pod
pod
pvc
pvc
clusterip
svc
clusteri...
rs
rs
deploy
deploy
Zarf Gitops Service
Zarf Gitops Service
pod
pod
ns
ns
zarf-state
zarf-sta...
NodePort
31999
NodePort...
zarf
zarf
pv
pv
sc
sc
nodeport
svc
nodeport...
Zarf Injector
Zarf Injector
pod
from existing
image
pod...
Dynamic configmaps:
n = tarball size / 512 KB
Dynamic configmaps:...
Dynamic
NodePort

Dynamic...
pv
pv
sc
sc
Zarf Resource
Zarf Resource
Zarf Temporary Resource
Zarf Temporary Resource
Zarf-Managed Resource
Zarf-Managed Resource
Zarf CLI to Cluster Comms
Zarf CLI to Cluster Comms
Image Pull From Zarf Registry
Image Pull From Zarf Registry
Standard K8s Comms
Standard K8s Comms
Standard K8s Controller Comms
Standard K8s Controller Comms
Initial image pulled from zarf-injector nodeport
Initial image pulled from zarf-injector nodep...
Post registry boot all images pull from the registry
Post registry boot all images pull from the regi...
POD Create / Flux GitRepository Create Webhook
POD Create / Flux GitRepository Create Webhook
https://github.com/zarf-dev/zarf
https://github.com/zarf-dev/zarf
   1. Create the Zarf State in the cluster
1. Create the Zarf State in the clu...
   2. Launch the injector system
   2. Launch the injector system
   3. Deploy the Zarf Registry
   3. Deploy the Zarf Registry
   4. Deploy the Zarf Agent
   4. Deploy the Zarf Agent
   5. (Optional) Deploy the Zarf Git Server
5. (Optional) Deploy the Zarf Git S...
   6. Push package assets to the cluster
6. Push package assets to the clust...
Text is not SVG - cannot display
diff --git a/site/public/tutorials/package_create_wordpress.html b/site/public/tutorials/package_create_wordpress.html index abb216bb08..940bd94cc9 100644 --- a/site/public/tutorials/package_create_wordpress.html +++ b/site/public/tutorials/package_create_wordpress.html @@ -91,7 +91,7 @@ sensitive: true - name: WORDPRESS_EMAIL description: The email that is used for the WordPress admin account - default: hello@defenseunicorns.com + default: hello@zarf-dev.com prompt: true - name: WORDPRESS_FIRST_NAME description: The first name that is used for the WordPress admin account diff --git a/site/src/content/docs/commands/zarf_package_pull.md b/site/src/content/docs/commands/zarf_package_pull.md index 2bb98e5742..c458c9b8b2 100644 --- a/site/src/content/docs/commands/zarf_package_pull.md +++ b/site/src/content/docs/commands/zarf_package_pull.md @@ -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 diff --git a/site/src/content/docs/contribute/nerd-notes.mdx b/site/src/content/docs/contribute/nerd-notes.mdx index 6264dd5266..33dd73b35d 100644 --- a/site/src/content/docs/contribute/nerd-notes.mdx +++ b/site/src/content/docs/contribute/nerd-notes.mdx @@ -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 diff --git a/site/src/content/docs/contribute/testing.mdx b/site/src/content/docs/contribute/testing.mdx index c64c643aa6..6805190229 100644 --- a/site/src/content/docs/contribute/testing.mdx +++ b/site/src/content/docs/contribute/testing.mdx @@ -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. diff --git a/site/src/content/docs/faq.mdx b/site/src/content/docs/faq.mdx index e4bca91bba..6f404d33f5 100644 --- a/site/src/content/docs/faq.mdx +++ b/site/src/content/docs/faq.mdx @@ -4,13 +4,13 @@ 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? @@ -18,7 +18,7 @@ Yes! Zarf is Free and Open-Source Software (FOSS). And will remain free forever. ## 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? @@ -26,7 +26,7 @@ Zarf is statically compiled and written in [Go](https://golang.org/) and [Rust]( ## 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: @@ -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 ``` diff --git a/site/src/content/docs/getting-started/install.mdx b/site/src/content/docs/getting-started/install.mdx index 7c115d8cfb..c72a7e7756 100644 --- a/site/src/content/docs/getting-started/install.mdx +++ b/site/src/content/docs/getting-started/install.mdx @@ -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 ` @@ -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 ` @@ -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/) @@ -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 @@ -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--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--vX.X.X.tar.zst`. :::tip diff --git a/site/src/content/docs/index.mdx b/site/src/content/docs/index.mdx index 48ac086e1c..abf11bc393 100644 --- a/site/src/content/docs/index.mdx +++ b/site/src/content/docs/index.mdx @@ -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 diff --git a/site/src/content/docs/ref/components.mdx b/site/src/content/docs/ref/components.mdx index b8f85d6fc6..50be327f1b 100644 --- a/site/src/content/docs/ref/components.mdx +++ b/site/src/content/docs/ref/components.mdx @@ -162,19 +162,19 @@ 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). ::: @@ -182,7 +182,7 @@ Because Zarf creates long-lived mirrors of repositories in the air gap, it does #### 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. diff --git a/site/src/content/docs/ref/deploy.mdx b/site/src/content/docs/ref/deploy.mdx index 28e61f7114..c39180cabf 100644 --- a/site/src/content/docs/ref/deploy.mdx +++ b/site/src/content/docs/ref/deploy.mdx @@ -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` ::: diff --git a/site/src/content/docs/ref/deployment-ui.mdx b/site/src/content/docs/ref/deployment-ui.mdx index c560a4fc92..040fd5d4e1 100644 --- a/site/src/content/docs/ref/deployment-ui.mdx +++ b/site/src/content/docs/ref/deployment-ui.mdx @@ -20,11 +20,11 @@ The Zarf Web UI mirrors the functionality of the Zarf CLI commands, but with a m ## Open the Zarf Deployment Web UI -The Zarf Deployment Web UI can easily be downloaded from the [Zarf UI Github Project](https://github.com/defenseunicorns/zarf-ui/releases/latest). +The Zarf Deployment Web UI can easily be downloaded from the [Zarf UI Github Project](https://github.com/zarf-dev/zarf-ui/releases/latest). Follow these steps to get started using the Web UI -1. Step one: [Download the Zarf UI](https://github.com/defenseunicorns/zarf-ui/releases/latest) version that matches your system (i.e. `zarf-ui_v0.1.0-Darwin_arm64`) +1. Step one: [Download the Zarf UI](https://github.com/zarf-dev/zarf-ui/releases/latest) version that matches your system (i.e. `zarf-ui_v0.1.0-Darwin_arm64`) 2. Step two: (if applicable) Mark the file as executable with `chmod +x zarf-ui_v0.1.0-Darwin_arm64` 3. Step three: Run the binary with `./zarf-ui_v0.1.0-Darwin_arm64` or by double clicking the file in your file browser diff --git a/site/src/content/docs/ref/dev.mdx b/site/src/content/docs/ref/dev.mdx index 10fdf34a31..bdf0fe50f7 100644 --- a/site/src/content/docs/ref/dev.mdx +++ b/site/src/content/docs/ref/dev.mdx @@ -8,7 +8,7 @@ tableOfContents: ## Schema Validation -Zarf uses the [Zarf package schema](https://github.com/defenseunicorns/zarf/blob/main/zarf.schema.json) to define its configuration files. This schema is used to describe package configuration options and enable the validation of configuration files prior to their use in building a Zarf Package. +Zarf uses the [Zarf package schema](https://github.com/zarf-dev/zarf/blob/main/zarf.schema.json) to define its configuration files. This schema is used to describe package configuration options and enable the validation of configuration files prior to their use in building a Zarf Package. ### `zarf dev lint` @@ -28,7 +28,7 @@ zarf dev lint ```json "yaml.schemas": { - "https://raw.githubusercontent.com/defenseunicorns/zarf/main/zarf.schema.json": "zarf.yaml" + "https://raw.githubusercontent.com/zarf-dev/zarf/main/zarf.schema.json": "zarf.yaml" } ``` @@ -43,10 +43,10 @@ When successfully installed, the `yaml.schema` line will match the color of the To ensure consistent validation of the Zarf schema version in a `zarf.yaml` file, it can be beneficial to lock it to a specific version. This can be achieved by appending the following statement to the **first line** of any given `zarf.yaml` file: ```yaml -# yaml-language-server: $schema=https://raw.githubusercontent.com/defenseunicorns/zarf//zarf.schema.json +# yaml-language-server: $schema=https://raw.githubusercontent.com/zarf-dev/zarf//zarf.schema.json ``` -In the above example, `` should be replaced with the specific [Zarf release](https://github.com/defenseunicorns/zarf/releases). +In the above example, `` should be replaced with the specific [Zarf release](https://github.com/zarf-dev/zarf/releases). ![yaml schema](https://user-images.githubusercontent.com/92826525/226490465-1e6a56f7-41c4-45bf-923b-5242fa4ab64e.png) diff --git a/site/src/content/docs/ref/github-action.mdx b/site/src/content/docs/ref/github-action.mdx index 09afb82b6b..16c3fbd359 100644 --- a/site/src/content/docs/ref/github-action.mdx +++ b/site/src/content/docs/ref/github-action.mdx @@ -5,7 +5,7 @@ sidebar: tableOfContents: false --- -The [setup-zarf](https://github.com/defenseunicorns/setup-zarf) Github action is an officially supported action to install any version of Zarf and it's `init` package with zero added dependencies. +The [setup-zarf](https://github.com/zarf-dev/setup-zarf) Github action is an officially supported action to install any version of Zarf and it's `init` package with zero added dependencies. ## Example Usage - Creating a Package @@ -21,7 +21,7 @@ jobs: fetch-depth: 1 - name: Install Zarf - uses: defenseunicorns/setup-zarf@main # use action's main branch + uses: zarf-dev/setup-zarf@main # use action's main branch with: version: v0.32.2 # any valid zarf version, leave blank to use latest @@ -29,4 +29,4 @@ jobs: run: zarf package create --confirm ``` -More examples are located in the action's [README.md](https://github.com/defenseunicorns/setup-zarf#readme) +More examples are located in the action's [README.md](https://github.com/zarf-dev/setup-zarf#readme) diff --git a/site/src/content/docs/ref/init-package.mdx b/site/src/content/docs/ref/init-package.mdx index 8a8daa55de..1af8d3d18e 100644 --- a/site/src/content/docs/ref/init-package.mdx +++ b/site/src/content/docs/ref/init-package.mdx @@ -51,7 +51,7 @@ While there is no distro-agnostic method to inject images into a cluster, every But then we have another problem of how to reassemble the image on the other side, as we don't have any consistent image that exists in the cluster that would have such utilities. This is where the `zarf-injector` Rust binary comes in. -> For compiling the `zarf-injector` binary, refer to its [README.md](https://github.com/defenseunicorns/zarf/tree/main/src/injector/README.md). +> For compiling the `zarf-injector` binary, refer to its [README.md](https://github.com/zarf-dev/zarf/tree/main/src/injector/README.md). The `zarf-injector` binary is statically compiled and injected into the cluster as a `configmap` along with the chunks of the `registry:2` image. During the `zarf-seed-registry`'s deployment, the `zarf-injector` binary is run in a pod that mounts the `configmaps` and reassembles the `registry:2` image. It then hosts a temporary, pull-only Docker registry implemented in Rust so that a real registry can be deployed into the cluster from the hosted `registry:2` image. @@ -76,7 +76,7 @@ Doing this keeps Zarf cluster agnostic, however does require that the kubelet be :::note -The `registry:2` image and the Zarf Agent image can be configured with a custom init package using the `registry_image_*` and `agent_image_*` templates defined in the Zarf repo's [zarf-config.toml](https://github.com/defenseunicorns/zarf/blob/main/zarf-config.toml). This allows you to swap them for enterprise provided / hardened versions if desired such as those provided by [Iron Bank](https://repo1.dso.mil/dsop/opensource/defenseunicorns/zarf/zarf-agent). +The `registry:2` image and the Zarf Agent image can be configured with a custom init package using the `registry_image_*` and `agent_image_*` templates defined in the Zarf repo's [zarf-config.toml](https://github.com/zarf-dev/zarf/blob/main/zarf-config.toml). This allows you to swap them for enterprise provided / hardened versions if desired such as those provided by [Iron Bank](https://repo1.dso.mil/dsop/opensource/defenseunicorns/zarf/zarf-agent). ::: @@ -95,7 +95,7 @@ It leverages the same `docker-registry` chart used in `zarf-seed-registry` but w You can further customize how the registry behaves by setting variables such as `REGISTRY_PVC_SIZE` with a [config file](/ref/config-files/) or `--set` on `zarf init`. -To see a full list of `variables` you can view the [`zarf.yaml` that defines the registry](https://github.com/defenseunicorns/zarf/blob/main/packages/zarf-registry/zarf.yaml). +To see a full list of `variables` you can view the [`zarf.yaml` that defines the registry](https://github.com/zarf-dev/zarf/blob/main/packages/zarf-registry/zarf.yaml). ::: @@ -216,7 +216,7 @@ root@machine ~ # zarf init --components k3s --set K3S_ARGS="" --confirm You can further customize how the git-server behaves by setting variables such as `GIT_SERVER_PVC_SIZE` with a [config file](/ref/config-files/) or `--set` on `zarf init`. -To see a full list of `variables` you can view the [zarf.yaml that defines the git-server](https://github.com/defenseunicorns/zarf/blob/main/packages/gitea/zarf.yaml). +To see a full list of `variables` you can view the [zarf.yaml that defines the git-server](https://github.com/zarf-dev/zarf/blob/main/packages/gitea/zarf.yaml). ::: @@ -273,7 +273,7 @@ components: In order to reproduce / build the following example, you will need to have the Zarf repository cloned locally. ```bash -git clone https://github.com/defenseunicorns/zarf.git +git clone https://github.com/zarf-dev/zarf.git cd zarf mv zarf.yaml zarf.yaml.bak ``` diff --git a/site/src/content/docs/ref/packages.mdx b/site/src/content/docs/ref/packages.mdx index 723c6ed845..5a2e3562ad 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 that installs a Kubernetes distribution +Check out our [K3s cluster package](https://github.com/zarf-dev/zarf/blob/main/packages/distros/k3s/zarf.yaml) to see an example of a Zarf Package that installs a Kubernetes distribution ::: diff --git a/site/src/content/docs/roadmap.mdx b/site/src/content/docs/roadmap.mdx index 68878e6dbb..2d725ab90e 100644 --- a/site/src/content/docs/roadmap.mdx +++ b/site/src/content/docs/roadmap.mdx @@ -4,18 +4,18 @@ title: Roadmap ## Issue Tracking -The issue board for Zarf is hosted on a [GitHub Project Board](https://github.com/orgs/defenseunicorns/projects/1) that tracks the issues the Zarf team is working along with future work we are prioritizing. +The issue board for Zarf is hosted on a [GitHub Project Board](https://github.com/orgs/zarf-dev/projects/1) that tracks the issues the Zarf team is working along with future work we are prioritizing. -If you would like to add bug reports or feature requests, please [add an issue](https://github.com/defenseunicorns/zarf/issues) to the GitHub repository under the appropriate template. If you have a more general question about a feature, feel free to ask the team in the [Zarf Kubernetes Slack Channel](https://kubernetes.slack.com/archives/C03B6BJAUJ3). +If you would like to add bug reports or feature requests, please [add an issue](https://github.com/zarf-dev/zarf/issues) to the GitHub repository under the appropriate template. If you have a more general question about a feature, feel free to ask the team in the [Zarf Kubernetes Slack Channel](https://kubernetes.slack.com/archives/C03B6BJAUJ3). -We also accept contributions from the community (regardless of where a particular bug or feature is in the queue), so feel free to read our [contributing guidelines](/contribute/contributor-guide) and [submit a PR](https://github.com/defenseunicorns/zarf/pulls)! You can also ask any development related questions in the [Zarf Dev Kubernetes Slack Channel](https://kubernetes.slack.com/archives/C03BP9Z3CMA). +We also accept contributions from the community (regardless of where a particular bug or feature is in the queue), so feel free to read our [contributing guidelines](/contribute/contributor-guide) and [submit a PR](https://github.com/zarf-dev/zarf/pulls)! You can also ask any development related questions in the [Zarf Dev Kubernetes Slack Channel](https://kubernetes.slack.com/archives/C03BP9Z3CMA). ## 2024 General Roadmap ### Q1: Community Building and Refactoring -- [X] - Establish a [monthly community meetup](https://github.com/defenseunicorns/zarf/issues/2202) to engage members of the community and answer questions. -- [ ] - Refactor and add tests to library code shared with [UDS-CLI](https://github.com/defenseunicorns/uds-cli) and split into a new GitHub repository. +- [X] - Establish a [monthly community meetup](https://github.com/zarf-dev/zarf/issues/2202) to engage members of the community and answer questions. +- [ ] - Refactor and add tests to library code shared with [UDS-CLI](https://github.com/zarf-dev/uds-cli) and split into a new GitHub repository. - [ ] - Gather OpenSSF donation requirements and clear off pre-reqs (additional maintainers and sponsor working group). ### Q2 Consistency, Docs and Donation to OpenSSF @@ -81,6 +81,6 @@ Deprecated features are features that are no longer recommended for use and: ## General Availability (GA) Release -Right now, Zarf itself is still in its 'beta' phase. We are working on some final things before we release the official 1.0 General Availability (GA) release. The work still needed for the GA release can be found in our issues with [this filter](https://github.com/defenseunicorns/zarf/issues?q=is%3Aopen+is%3Aissue+label%3Aga). +Right now, Zarf itself is still in its 'beta' phase. We are working on some final things before we release the official 1.0 General Availability (GA) release. The work still needed for the GA release can be found in our issues with [this filter](https://github.com/zarf-dev/zarf/issues?q=is%3Aopen+is%3Aissue+label%3Aga). We are currently targeting Q4 2024 to have Zarf be generally available and will be pushing weekly releases until then to add necessary features and fix bugs as well as improve docs, architecture and test coverage behind the scenes. diff --git a/site/src/content/docs/support.mdx b/site/src/content/docs/support.mdx index 2cf650b416..b3d8aa75f1 100644 --- a/site/src/content/docs/support.mdx +++ b/site/src/content/docs/support.mdx @@ -8,4 +8,4 @@ title: Support - [Getting Started](/getting-started) 2. Look for an answer in the [Frequently Asked Questions](/faq). 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) +4. [Read issues, report a bug, or request a new feature](https://github.com/zarf-dev/zarf/issues) diff --git a/site/src/content/docs/tutorials/0-creating-a-zarf-package.mdx b/site/src/content/docs/tutorials/0-creating-a-zarf-package.mdx index 84634b4386..4300d8c72f 100644 --- a/site/src/content/docs/tutorials/0-creating-a-zarf-package.mdx +++ b/site/src/content/docs/tutorials/0-creating-a-zarf-package.mdx @@ -27,7 +27,7 @@ In order to create a Zarf package you first need to have an idea of what applica ### Creating the Package Definition -A `zarf.yaml` file follows the [Zarf Package Schema](https://github.com/defenseunicorns/zarf/blob/main/zarf.schema.json) and allows us to specify package metadata and a set of components for us to deploy. We start a package definition with the `kind` of package we are making and `metadata` that describes the package. You can start our WordPress package by creating a new `zarf.yaml` with the following content: +A `zarf.yaml` file follows the [Zarf Package Schema](https://github.com/zarf-dev/zarf/blob/main/zarf.schema.json) and allows us to specify package metadata and a set of components for us to deploy. We start a package definition with the `kind` of package we are making and `metadata` that describes the package. You can start our WordPress package by creating a new `zarf.yaml` with the following content: ```yaml kind: ZarfPackageConfig # ZarfPackageConfig is the package kind for most normal zarf packages @@ -40,7 +40,7 @@ metadata: :::tip -You can run [`zarf dev lint `](/commands/zarf_dev_lint/) to validate against the [`zarf.schema.json`](https://github.com/defenseunicorns/zarf/blob/main/zarf.schema.json), or setup [VSCode](/ref/dev/#vscode) to see errors in real-time. +You can run [`zarf dev lint `](/commands/zarf_dev_lint/) to validate against the [`zarf.schema.json`](https://github.com/zarf-dev/zarf/blob/main/zarf.schema.json), or setup [VSCode](/ref/dev/#vscode) to see errors in real-time. ::: diff --git a/site/src/content/docs/tutorials/1-initializing-a-k8s-cluster.mdx b/site/src/content/docs/tutorials/1-initializing-a-k8s-cluster.mdx index 006d3a5743..deb26aa0ce 100644 --- a/site/src/content/docs/tutorials/1-initializing-a-k8s-cluster.mdx +++ b/site/src/content/docs/tutorials/1-initializing-a-k8s-cluster.mdx @@ -12,9 +12,9 @@ In this tutorial, we will demonstrate how to initialize Zarf onto a K8s cluster. Before beginning this tutorial you will need the following: -- 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)) +- The [Zarf](https://github.com/zarf-dev/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: ([Installing Zarf](/getting-started/install/)) -- An init-package downloaded: ([init-package Build Instructions](/tutorials/0-creating-a-zarf-package/)) or ([Download Location](https://github.com/defenseunicorns/zarf/releases)) +- An init-package downloaded: ([init-package Build Instructions](/tutorials/0-creating-a-zarf-package/)) or ([Download Location](https://github.com/zarf-dev/zarf/releases)) - A local Kubernetes cluster ## Initializing the Cluster diff --git a/site/src/content/docs/tutorials/3-deploy-a-retro-arcade.mdx b/site/src/content/docs/tutorials/3-deploy-a-retro-arcade.mdx index 9364e98bbe..6b6a07f00f 100644 --- a/site/src/content/docs/tutorials/3-deploy-a-retro-arcade.mdx +++ b/site/src/content/docs/tutorials/3-deploy-a-retro-arcade.mdx @@ -16,13 +16,13 @@ In previous tutorials, we learned how to [create a package](/tutorials/0-creatin Before beginning this tutorial you will need the following: -- 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)) +- The [Zarf](https://github.com/zarf-dev/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: ([Installing Zarf](/getting-started/install/)) - [An initialized cluster](/tutorials/1-initializing-a-k8s-cluster/) ## Deploying the Arcade -1. The `dos-games` package is easily deployable via `oci://` by running `zarf package deploy oci://defenseunicorns/dos-games:1.0.0-$(uname -m) --key=https://zarf.dev/cosign.pub`. +1. The `dos-games` package is easily deployable via `oci://` by running `zarf package deploy oci://zarf-dev/dos-games:1.0.0-$(uname -m) --key=https://zarf.dev/cosign.pub`. :::tip diff --git a/site/src/content/docs/tutorials/4-creating-a-k8s-cluster-with-zarf.mdx b/site/src/content/docs/tutorials/4-creating-a-k8s-cluster-with-zarf.mdx index 81492468d7..2ca6056dbf 100644 --- a/site/src/content/docs/tutorials/4-creating-a-k8s-cluster-with-zarf.mdx +++ b/site/src/content/docs/tutorials/4-creating-a-k8s-cluster-with-zarf.mdx @@ -20,9 +20,9 @@ The 'k3s' component requires root access (not just `sudo`!) when deploying as it Before beginning this tutorial you will need the following: -- 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)) +- The [Zarf](https://github.com/zarf-dev/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: ([Installing Zarf](/getting-started/install/)) -- An init-package built/downloaded: ([init-package Build Instructions](/tutorials/0-creating-a-zarf-package/)) or ([Download Location](https://github.com/defenseunicorns/zarf/releases)) +- An init-package built/downloaded: ([init-package Build Instructions](/tutorials/0-creating-a-zarf-package/)) or ([Download Location](https://github.com/zarf-dev/zarf/releases)) ## Creating the Cluster diff --git a/site/src/content/docs/tutorials/5-big-bang.mdx b/site/src/content/docs/tutorials/5-big-bang.mdx index b239f73ea3..bf073df59a 100644 --- a/site/src/content/docs/tutorials/5-big-bang.mdx +++ b/site/src/content/docs/tutorials/5-big-bang.mdx @@ -36,7 +36,7 @@ To learn more about Big Bang's requirements in general, see their documentation: Before beginning this tutorial you will need the following: - A local copy of the Zarf repository - - `git clone https://github.com/defenseunicorns/zarf.git` + - `git clone https://github.com/zarf-dev/zarf.git` - A kubernetes cluster onto which you can deploy Zarf and Big Bang - The latest version of the Zarf `cli` - Follow instructions on https://docs.zarf.dev/getting-started/install/ @@ -208,4 +208,4 @@ See the Troubleshooting section of the Big Bang Quick Start for help troubleshoo Also, ensure that you have followed all of the steps required in the [pre-requisites](#prerequisites) section. -If you feel that the error you are encountering is one with Zarf feel free to [open an issue](https://github.com/defenseunicorns/zarf/issues/new/choose) or reach out via [slack](https://kubernetes.slack.com/archives/C03B6BJAUJ3). +If you feel that the error you are encountering is one with Zarf feel free to [open an issue](https://github.com/zarf-dev/zarf/issues/new/choose) or reach out via [slack](https://kubernetes.slack.com/archives/C03B6BJAUJ3). diff --git a/site/src/content/docs/tutorials/7-custom-init-packages.mdx b/site/src/content/docs/tutorials/7-custom-init-packages.mdx index e99c8f08b6..1f1e78cad9 100644 --- a/site/src/content/docs/tutorials/7-custom-init-packages.mdx +++ b/site/src/content/docs/tutorials/7-custom-init-packages.mdx @@ -20,7 +20,7 @@ When creating a Zarf 'init' package, you must have a network connection so that Before beginning this tutorial you will need the following: -- 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)) +- The [Zarf](https://github.com/zarf-dev/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: ([Installing Zarf](/getting-started/install/)) - (if building a local [`zarf-agent`](/faq#what-is-the-zarf-agent)) The [Docker CLI](https://docs.docker.com/desktop/) installed and the tools to [Build your own CLI](/getting-started/install/#building-from-source) diff --git a/site/src/content/docs/tutorials/9-package-create-differential.mdx b/site/src/content/docs/tutorials/9-package-create-differential.mdx index 176424805c..56207fab42 100644 --- a/site/src/content/docs/tutorials/9-package-create-differential.mdx +++ b/site/src/content/docs/tutorials/9-package-create-differential.mdx @@ -18,7 +18,7 @@ In this tutorial, you will create a differential package using Zarf. This is us For following along locally, please ensure the following prerequisites are met: - Zarf binary installed on your `$PATH`: ([Installing Zarf](/getting-started/install/)) -- 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)) +- The [Zarf](https://github.com/zarf-dev/zarf) repository cloned: ([`git clone` Instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)) ## Create a Differential Package diff --git a/site/src/content/docs/tutorials/index.mdx b/site/src/content/docs/tutorials/index.mdx index 9c0b43ef6d..c8db1f80e5 100644 --- a/site/src/content/docs/tutorials/index.mdx +++ b/site/src/content/docs/tutorials/index.mdx @@ -11,9 +11,9 @@ This section of the documentation has a collection of tutorials that will help y If a tutorial has any prerequisites, they will be listed at the beginning of the tutorial with instructions on how to fulfill them. Almost all tutorials 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. The [Zarf](https://github.com/zarf-dev/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: ([Installing Zarf](/getting-started/install)) -1. You have an init-package built/downloaded: ([init-package Build Instructions](/tutorials/0-creating-a-zarf-package)) or ([Download Location](https://github.com/defenseunicorns/zarf/releases)) +1. You have an init-package built/downloaded: ([init-package Build Instructions](/tutorials/0-creating-a-zarf-package)) or ([Download Location](https://github.com/zarf-dev/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)) ## Setting Up a Local Kubernetes Cluster