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.

Sign up for GitHub

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

Update OCI walkthrough to match the new template #1517

Merged
merged 14 commits into from
Apr 28, 2023
Merged

Update OCI walkthrough to match the new template #1517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3dfbb15
Update OCI walkthrough to match the new template
JasonvanBrackel Mar 30, 2023
8f1540d
Merge branch 'main' into oci-walkthrough-improvements
Racer159 Apr 18, 2023
cb8ed0c
Merge branch 'main' into oci-walkthrough-improvements
Racer159 Apr 24, 2023
3841019
Update docs/13-walkthroughs/6-publish-and-deploy.md
JasonvanBrackel Apr 25, 2023
a312543
Update docs/13-walkthroughs/6-publish-and-deploy.md
JasonvanBrackel Apr 25, 2023
4597fdc
Update docs-website/static/docs/walkthroughs/publish_and_deploy_docke…
JasonvanBrackel Apr 25, 2023
82d56d2
Update docs/13-walkthroughs/6-publish-and-deploy.md
JasonvanBrackel Apr 25, 2023
6ab2a53
Update docs/13-walkthroughs/6-publish-and-deploy.md
JasonvanBrackel Apr 25, 2023
8483a6a
Update docs-website/static/docs/walkthroughs/publish_and_deploy_setup…
JasonvanBrackel Apr 25, 2023
deb5078
Add OCI Link
JasonvanBrackel Apr 25, 2023
e562b31
Merge branch 'main' into oci-walkthrough-improvements
JasonvanBrackel Apr 25, 2023
5bd914d
Merge branch 'main' into oci-walkthrough-improvements
JasonvanBrackel Apr 25, 2023
c6d7ac3
Merge branch 'main' into oci-walkthrough-improvements
Racer159 Apr 28, 2023
97614cd
Fixup other merge issues
Racer159 Apr 28, 2023
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
102 changes: 102 additions & 0 deletions docs-website/static/docs/walkthroughs/publish_and_deploy_create.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<!DOCTYPE html>
<html>
<head>
<style type="text/css">
body {background-color: black;}
pre {
font-weight: normal;
color: #bbb;
white-space: -moz-pre-wrap;
white-space: -o-pre-wrap;
white-space: -pre-wrap;
white-space: pre-wrap;
word-wrap: break-word;
overflow-wrap: break-word;
}
b {font-weight: normal}
b.BOLD {color: #fff}
b.ITA {font-style: italic}
b.UND {text-decoration: underline}
b.STR {text-decoration: line-through}
b.UNDSTR {text-decoration: underline line-through}
b.BLK {color: #000000}
b.RED {color: #aa0000}
b.GRN {color: #00aa00}
b.YEL {color: #aa5500}
b.BLU {color: #0000aa}
b.MAG {color: #aa00aa}
b.CYN {color: #00aaaa}
b.WHI {color: #aaaaaa}
b.HIK {color: #555555}
b.HIR {color: #ff5555}
b.HIG {color: #55ff55}
b.HIY {color: #ffff55}
b.HIB {color: #5555ff}
b.HIM {color: #ff55ff}
b.HIC {color: #55ffff}
b.HIW {color: #ffffff}
b.BBLK {background-color: #000000}
b.BRED {background-color: #aa0000}
b.BGRN {background-color: #00aa00}
b.BYEL {background-color: #aa5500}
b.BBLU {background-color: #0000aa}
b.BMAG {background-color: #aa00aa}
b.BCYN {background-color: #00aaaa}
b.BWHI {background-color: #aaaaaa}
</style>
</head>
<body>
<pre>
<b>$ zarf package create .</b>
<b class=YEL>Saving log file to</b>
<b class=YEL>/var/folders/bk/rz1xx2sd5zn134c0_j1s2n5r0000gp/T/zarf-2023-03-30-11-01-47-3104819928.log</b>
<b class=YEL></b>
<b class=YEL>Using build directory .</b>
<b class=YEL></b>
<b style="color:#55ffff;">kind</b>:<b style="color:#ff55ff;"> ZarfPackageConfig</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">metadata</b>:<b style="color:#55ffff;"></b>
<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> helm-oci-chart</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> Deploy podinfo using a Helm OCI chart</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">version</b>:<b style="color:#ff55ff;"> 0.0.1</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">components</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> helm-oci-chart</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">required</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"> </b><b style="color:#55ffff;">charts</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> podinfo</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">url</b>:<b style="color:#ff55ff;"> oci://ghcr.io/stefanprodan/charts/podinfo</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">version</b>:<b style="color:#ff55ff;"> 6.3.3</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">namespace</b>:<b style="color:#ff55ff;"> helm-oci-demo</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">images</b>:
-<b style="color:#ff55ff;"> ghcr.io/stefanprodan/podinfo:6.3.3</b>

<b style="color:#55ff55;">?</b> <b>Create this Zarf package?</b> (y/N) <span style="color:#00aaaa">Yes</span>

<b class="MAG">Specify a maximum file size for this package in Megabytes. Above this size, the package will be
split into multiple files. 0 will disable this feature.</b>
<b style="color:#55ff55;">?</b> Please provide a value for "Maximum Package Size" (0) <span style="color:#00aaaa">0</span>

<div style="background-color:#555555">
<b style="background-color:#555555"></b><b style="background-color:#555555"> </b>
<b style="background-color:#555555"></b><b style="background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"> 📦 HELM-OCI-CHART COMPONENT </b><b style="background-color:#555555"></b><b style="background-color:#555555"></b>
<b style="background-color:#555555"></b><b style="background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"> </b><b style="background-color:#555555"></b><b style="background-color:#555555"></b>
<b style="background-color:#555555"></b><b style="background-color:#555555"> </b>
</div>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Processing helm chart podinfo:6.3.3 from repo oci://ghcr.io/stefanprodan/charts/podinfo</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Processing helm chart podinfo:6.3.3 from repo oci://ghcr.io/stefanprodan/charts/podinfo</b>

<div style="background-color:#555555">
<b style="background-color:#555555"></b><b style="background-color:#555555"> </b>
<b style="background-color:#555555"></b><b style="background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"> 📦 COMPONENT IMAGES </b><b style="background-color:#555555"></b><b style="background-color:#555555"></b>
<b style="background-color:#555555"></b><b style="background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"> </b><b style="background-color:#555555"></b><b style="background-color:#555555"></b>
<b style="background-color:#555555"></b><b style="background-color:#555555"> </b>
</div>

• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Loading metadata for 1 images.</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Loading metadata for 1 images.</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Pulling Zarf package data (0.00 Byte of 26.10 MBs)</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Pulling 1 images (26.10 MBs)</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Creating SBOMs for 1 images and 0 components with files.</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Creating SBOMs for 1 images and 0 components with files.</b>
</pre>
</body>
</html>
128 changes: 128 additions & 0 deletions docs-website/static/docs/walkthroughs/publish_and_deploy_deploy.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
<!DOCTYPE html>
<html>
<head>
<style type="text/css">
body {background-color: black;}
pre {
font-weight: normal;
color: #bbb;
white-space: -moz-pre-wrap;
white-space: -o-pre-wrap;
white-space: -pre-wrap;
white-space: pre-wrap;
word-wrap: break-word;
overflow-wrap: break-word;
}
b {font-weight: normal}
b.BOLD {color: #fff}
b.ITA {font-style: italic}
b.UND {text-decoration: underline}
b.STR {text-decoration: line-through}
b.UNDSTR {text-decoration: underline line-through}
b.BLK {color: #000000}
b.RED {color: #aa0000}
b.GRN {color: #00aa00}
b.YEL {color: #aa5500}
b.BLU {color: #0000aa}
b.MAG {color: #aa00aa}
b.CYN {color: #00aaaa}
b.WHI {color: #aaaaaa}
b.HIK {color: #555555}
b.HIR {color: #ff5555}
b.HIG {color: #55ff55}
b.HIY {color: #ffff55}
b.HIB {color: #5555ff}
b.HIM {color: #ff55ff}
b.HIC {color: #55ffff}
b.HIW {color: #ffffff}
b.BBLK {background-color: #000000}
b.BRED {background-color: #aa0000}
b.BGRN {background-color: #00aa00}
b.BYEL {background-color: #aa5500}
b.BBLU {background-color: #0000aa}
b.BMAG {background-color: #aa00aa}
b.BCYN {background-color: #00aaaa}
b.BWHI {background-color: #aaaaaa}
</style>
</head>
<body>
<pre>
<b>$ zarf package deploy oci://$REPOSITORY_URL/helm-oci-chart:0.0.1-arm64</b>

<b class=YEL>Saving log file to</b>
<b class=YEL>/var/folders/bk/rz1xx2sd5zn134c0_j1s2n5r0000gp/T/zarf-2023-03-30-12-09-38-2083571763.log</b>
<b class=YEL></b> • <b style="color:#55ffff;"></b><b style="color:#55ffff;">Pulling Zarf package from $REPOSITORY_URL/helm-oci-chart:0.0.1-arm64</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Pulling Zarf package data (0.00 Byte of 26.90 MBs)</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">d8399f7b56ca [application/vnd.unknown.config.v1+json]</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">fd143c92d486 zarf.yaml</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">515aceaacb8d images/index.json</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">b66dbb27a733 images/oci-layout</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">42c097bd02de components/helm-oci-chart.tar</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">46564f0eff85 images/blobs/sha256/46564f0...06008f762391a7bb7d58f339ee</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">4f4fb700ef54 images/blobs/sha256/4f4fb70...b5577484a6d75e68dc38e8acc1</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">932a2288fd3a sboms.tar</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">74eae207aa23 images/blobs/sha256/74eae20...fcb007d3da7b842313f80d2c33</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">a9eaa45ef418 images/blobs/sha256/a9eaa45...6789c52a87ba5a9e6483f2b74f</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">ab67ffd6e92e images/blobs/sha256/ab67ffd...f8c9d93c0e719f6350e99d3aea</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">6ff8f4799d50 images/blobs/sha256/6ff8f47...4bc00ec8b988d28cef78ea9a5b</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">e2b45cdcd8bf images/blobs/sha256/e2b45cd...000f1bc1695014e38821dc675c</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">b95c82728c36 images/blobs/sha256/b95c827...042a9c5d84426c1674044916d4</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">8c5b695f4724 images/blobs/sha256/8c5b695...014f94c8d4ea62772c477c1e03</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">cf79ae90993d [application/vnd.oci.image.manifest.v1+json]</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Pulling Zarf package data (26.90 MBs)</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Pulled $REPOSITORY_URL/helm-oci-chart:0.0.1-arm64</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Loading Zarf Package /var/folders/bk/rz1xx2sd5zn134c0_j1s2n5r0000gp/T/zarf-3635611772</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Loading Zarf Package /var/folders/bk/rz1xx2sd5zn134c0_j1s2n5r0000gp/T/zarf-3635611772</b>

<b style="color:#55ffff;">kind</b>:<b style="color:#ff55ff;"> ZarfPackageConfig</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">metadata</b>:<b style="color:#55ffff;"></b>
<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> helm-oci-chart</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> Deploy podinfo using a Helm OCI chart</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">version</b>:<b style="color:#ff55ff;"> 0.0.1</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">architecture</b>:<b style="color:#ff55ff;"> arm64</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">build</b>:<b style="color:#55ffff;"></b>
<b style="color:#55ffff;"> terminal</b>:<b style="color:#ff55ff;"> JvBUnicornMBP5</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">user</b>:<b style="color:#ff55ff;"> jason</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">architecture</b>:<b style="color:#ff55ff;"> arm64</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">timestamp</b>:<b style="color:#ff55ff;"> Thu, 30 Mar 2023 11:04:19 -0400</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">version</b>:<b style="color:#ff55ff;"> v0.25.0</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">migrations</b>:
-<b style="color:#ff55ff;"> scripts-to-actions</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">components</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> helm-oci-chart</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">required</b>:<b style="color:#ffffff;"> true</b>
<b style="color:#ffffff;"> </b><b style="color:#55ffff;">charts</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> podinfo</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">url</b>:<b style="color:#ff55ff;"> oci://ghcr.io/stefanprodan/charts/podinfo</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">version</b>:<b style="color:#ff55ff;"> 6.3.3</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">namespace</b>:<b style="color:#ff55ff;"> helm-oci-demo</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">images</b>:
-<b style="color:#ff55ff;"> ghcr.io/stefanprodan/podinfo:6.3.3</b>
<b class=YEL>This package has 1 artifacts with software bill-of-materials (SBOM) included. You can view them now</b>
<b class=YEL>in the zarf-sbom folder in this directory or to go directly to one, open this in your browser:</b>
<b class=YEL>/Users/jason/src/github.com/jasonvanbrackel/zarf/docs-website/static/docs/walkthroughs/zarf-sbom/sbom-viewer-ghcr.io_stefanprodan_podinfo_6.3.3.html</b>
<b class=YEL></b>
<b class=YEL>* This directory will be removed after package deployment.</b>
<b class=YEL></b>
<b style="color:#55ff55;">?</b><b class="WHI">Deploy this Zarf package?</b> (y/N) <span style="color:#00aaaa">Yes</span>

<div style="background-color:#555555">
<b style="background-color:#555555"></b><b style="background-color:#555555"> </b>
<b style="background-color:#555555"></b><b style="background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"> 📦 HELM-OCI-CHART COMPONENT </b><b style="background-color:#555555"></b><b style="background-color:#555555"></b>
<b style="background-color:#555555"></b><b style="background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"></b><b style="color:#ffffff;background-color:#555555"> </b><b style="background-color:#555555"></b><b style="background-color:#555555"></b>
<b style="background-color:#555555"></b><b style="background-color:#555555"> </b>
</div>

• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Loading the Zarf State from the Kubernetes cluster</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Loading the Zarf State from the Kubernetes cluster</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Opening tunnel 55523 -&gt; 5000 for svc/zarf-docker-registry in namespace zarf</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Creating port forwarding tunnel at http://127.0.0.1:55523/v2/_catalog</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Storing images in the zarf registry</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Storing images in the zarf registry</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Processing helm chart podinfo:6.3.3 from oci://ghcr.io/stefanprodan/charts/podinfo</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Processing helm chart podinfo:6.3.3 from oci://ghcr.io/stefanprodan/charts/podinfo</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Zarf deployment complete</b>

</pre>
</body>
</html>
64 changes: 64 additions & 0 deletions docs-website/static/docs/walkthroughs/publish_and_deploy_docker_config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<!DOCTYPE html>
<html>
<head>
<style type="text/css">
body {background-color: black;}
pre {
font-weight: normal;
color: #bbb;
white-space: -moz-pre-wrap;
white-space: -o-pre-wrap;
white-space: -pre-wrap;
white-space: pre-wrap;
word-wrap: break-word;
overflow-wrap: break-word;
}
b {font-weight: normal}
b.BOLD {color: #fff}
b.ITA {font-style: italic}
b.UND {text-decoration: underline}
b.STR {text-decoration: line-through}
b.UNDSTR {text-decoration: underline line-through}
b.BLK {color: #000000}
b.RED {color: #aa0000}
b.GRN {color: #00aa00}
b.YEL {color: #aa5500}
b.BLU {color: #0000aa}
b.MAG {color: #aa00aa}
b.CYN {color: #00aaaa}
b.WHI {color: #aaaaaa}
b.HIK {color: #555555}
b.HIR {color: #ff5555}
b.HIG {color: #55ff55}
b.HIY {color: #ffff55}
b.HIB {color: #5555ff}
b.HIM {color: #ff55ff}
b.HIC {color: #55ffff}
b.HIW {color: #ffffff}
b.BBLK {background-color: #000000}
b.BRED {background-color: #aa0000}
b.BGRN {background-color: #00aa00}
b.BYEL {background-color: #aa5500}
b.BBLU {background-color: #0000aa}
b.BMAG {background-color: #aa00aa}
b.BCYN {background-color: #00aaaa}
b.BWHI {background-color: #aaaaaa}
</style>
</head>
<body>
<pre>
$ mkdir -p ~/.docker
$ AUTH=$(echo -n "$REGISTRY_USERNAME:$REGISTRY_SECRET" | base64)
<b class="GRN"># Note: If using Docker Hub, the registry URL is `https://index.docker.io/v1/` for the auth config</b>
$ cat <<EOF > ~/.docker/config.json
{
"auths": {
"$REGISTRY": {
"auth": "$AUTH"
}
}
}
EOF
</pre>
</body>
</html>
Loading