Skip to content

Commit

Permalink
Zarf walkthrough update (#1601)
Browse files Browse the repository at this point in the history 
## Description

- Updated the 'Using zarf package create' walkthrough
- Changed both the 'Using zarf package create' and 'Deploying zarf
packages' walkthroughs to use the helm-oci-chart example
- Abstracted the dos games example from the 'create' and 'deploy'
walkthroughs to create a full start to finish walkthrough
- Fixed some grammar
- Standardized some styling 
- Changed order of some pages (I wanted the full dos games walkthrough
to come right after the 'deploying zarf packages' one. That seemed to
make the most sense to me)

*See comments section for some questions/requested feedback*
...

## Related Issue

Fixes #
<!-- or -->
Relates to #

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Wayne Starr <[email protected]>
  • Loading branch information
@laurenmengert @Racer159
laurenmengert and Racer159 committed Apr 28, 2023
1 parent 7994d89 commit 52f9ddd
Show file tree
Hide file tree
Showing 34 changed files with 1,412 additions and 76 deletions.
2 changes: 1 addition & 1 deletion adr/0014-oci-publish.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ zarf-package-adr-arm64.tar.zst

With this new structure in place, we can now publish Zarf packages as OCI artifacts. Under the hood this implements the `oras` Go library using Docker's authentication system. For interacting with these packages, the `oci://` package path prefix has been added (ex. `zarf package publish oci://...`).

For an example of this in action, please see the [walkthrough](./docs/../../docs/13-walkthroughs/6-publish-and-deploy.md).
For an example of this in action, please see the [walkthrough](./docs/../../docs/13-walkthroughs/7-publish-and-deploy.md).

## Consequences

Expand Down
71 changes: 71 additions & 0 deletions docs-website/static/docs/walkthroughs/dos_games_components.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<!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>

<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"> 📦 BASELINE 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:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Loading 2 K8s manifests</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:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Loading metadata for 1 images.</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Pulling 1 images (24.89 MBs)</b>
<b style="color:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Creating SBOMs for 1 images and 0 components with files.</b>
</pre>
</body>
</html>
68 changes: 68 additions & 0 deletions docs-website/static/docs/walkthroughs/dos_games_create.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<!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 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;"> dos-games</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">description</b>:<b style="color:#ff55ff;"> Simple example to load classic DOS games into K8s in the airgap</b>
<b style="color:#ff55ff;"></b><b style="color:#55ffff;">components</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> baseline</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;">manifests</b>:
-<b style="color:#55ffff;"> name</b>:<b style="color:#ff55ff;"> multi-games</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">namespace</b>:<b style="color:#ff55ff;"> zarf</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">files</b>:
-<b style="color:#ff55ff;"> manifests/deployment.yaml</b>
<b style="color:#ff55ff;"> </b>-<b style="color:#ff55ff;"> manifests/service.yaml</b>
<b style="color:#ff55ff;"> </b><b style="color:#55ffff;">images</b>:
-<b style="color:#ff55ff;"> defenseunicorns/zarf-game:multi-tile-dark</b>
<b class="HIG"> ? </b><b class="HIW">Create this Zarf package? </b>(y/N) <span style="color:#55ffff;">Yes</span>
</pre>
</body>
</html>
56 changes: 56 additions & 0 deletions docs-website/static/docs/walkthroughs/dos_games_size.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!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 style="color:#ff55ff;">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 class="BOLD FONT HIG"> ? </b><b class="BOLD FONT HIW">Please provide a value for "Maximum Package Size"</b>(0)<b class="BOLD FONT HIW"> 0</b>

</pre>
</body>
</html>
2 changes: 1 addition & 1 deletion docs-website/static/docs/walkthroughs/logging_remove.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<b class="WHI">$ zarf package remove init --components="logging" --confirm</b><br/>
<b class=YEL>Saving log file to</b>
<b class=YEL>/var/folders/bk/rz1xx2sd5zn134c0_j1s2n5r0000gp/T/zarf-2023-03-22-13-17-09-3967112348.log</b>
<b class=YEL></b> • <b style="color:#55ffff;"></b><b style="color:#55ffff;">Removing zarf package init</b>
<b class=YEL></b><b style="color:#55ffff;"></b><b style="color:#55ffff;">Removing zarf package init</b>
</pre>
</body>
</html>
Loading

0 comments on commit 52f9ddd

Please sign in to comment.