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.

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 logging walkthrough #1462

Merged
merged 35 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
42c5708
Reorganize walkthrough and add a video
JasonvanBrackel Mar 20, 2023
45a652c
Merge branch 'defenseunicorns:main' into master
JasonvanBrackel Mar 20, 2023
a159c9c
Update docs/13-walkthroughs/2-deploying-doom.md
JasonvanBrackel Mar 21, 2023
f485b36
Update docs/13-walkthroughs/2-deploying-doom.md
JasonvanBrackel Mar 21, 2023
b66c1f5
Update docs/13-walkthroughs/2-deploying-doom.md
JasonvanBrackel Mar 21, 2023
ce9c678
Merge branch 'main' into master
JasonvanBrackel Mar 21, 2023
93f2a06
standardizing prompt formats
JasonvanBrackel Mar 21, 2023
569fcb7
Update logging walkthrough to fit the new format
JasonvanBrackel Mar 21, 2023
df3f694
Merge branch 'main' into update-logging-walkthrough
JasonvanBrackel Mar 21, 2023
43114c0
remove the DOCTYPE tag
JasonvanBrackel Mar 21, 2023
e7e8324
Remove tags that are choking netlify
JasonvanBrackel Mar 21, 2023
d3d579d
Deal with inline styles
JasonvanBrackel Mar 21, 2023
e9e08e6
Change pre tag to single line.
JasonvanBrackel Mar 21, 2023
a7b5a05
Remove all pre tag styles
JasonvanBrackel Mar 21, 2023
759c505
WIP: docusaurus issues
JasonvanBrackel Mar 21, 2023
c037a23
Try an iframe for code examplees
JasonvanBrackel Mar 22, 2023
aae6f2c
Merge branch 'main' into update-logging-walkthrough
JasonvanBrackel Mar 22, 2023
b9cb7ef
standardize troubleshooting
JasonvanBrackel Mar 22, 2023
675b7ec
Cleaning up example look and feel using div tags
JasonvanBrackel Mar 22, 2023
0a2978b
Merge branch 'main' into update-logging-walkthrough
Noxsios Mar 22, 2023
adfd17b
Merge branch 'main' into update-logging-walkthrough
JasonvanBrackel Mar 22, 2023
f55c2ae
Merge branch 'main' into update-logging-walkthrough
Racer159 Mar 22, 2023
9f6e4a9
Merge branch 'main' into update-logging-walkthrough
Racer159 Mar 22, 2023
34646ea
Update docs/13-walkthroughs/2-deploying-doom.md
JasonvanBrackel Mar 23, 2023
d6ff8f6
Update docs/13-walkthroughs/3-add-logging.md
JasonvanBrackel Mar 23, 2023
b732127
Update docs/13-walkthroughs/3-add-logging.md
JasonvanBrackel Mar 23, 2023
43bc0f2
Update docs/13-walkthroughs/3-add-logging.md
JasonvanBrackel Mar 23, 2023
4c117ec
Update docs/13-walkthroughs/3-add-logging.md
JasonvanBrackel Mar 23, 2023
39a2054
Update docs/13-walkthroughs/3-add-logging.md
JasonvanBrackel Mar 23, 2023
73be118
Update docs/13-walkthroughs/3-add-logging.md
JasonvanBrackel Mar 23, 2023
b608a91
Update docs/13-walkthroughs/3-add-logging.md
JasonvanBrackel Mar 23, 2023
5ae4324
Swap screenshots for ansi2html where appropriate.
JasonvanBrackel Mar 23, 2023
8f1abbb
resolve merge from PR
JasonvanBrackel Mar 23, 2023
5cf7d28
Update docs/13-walkthroughs/3-add-logging.md
JasonvanBrackel Mar 23, 2023
a887858
Merge branch 'main' into update-logging-walkthrough
JasonvanBrackel Mar 23, 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
337 changes: 337 additions & 0 deletions docs-website/static/docs/walkthroughs/logging_init.html

Large diffs are not rendered by default.

58 changes: 58 additions & 0 deletions docs-website/static/docs/walkthroughs/logging_list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<!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 list</b><br/>
<b class=YEL>Saving log file to</b>
<b class=YEL>/var/folders/bk/rz1xx2sd5zn134c0_j1s2n5r0000gp/T/zarf-2023-03-22-13-13-47-3918845089.log</b>
<b class=YEL></b><b style="color:#55ffff;"></b><b style="color:#55ffff;"> Package </b><b style="color:#555555;"></b><b style="color:#555555;"> | </b><b style="color:#55ffff;"></b><b style="color:#55ffff;">Components </b>
dos-games<b style="color:#555555;"></b><b style="color:#555555;"> | </b>[baseline]
init <b style="color:#555555;"></b><b style="color:#555555;"> | </b>[zarf-injector zarf-seed-registry zarf-registry zarf-agent logging]
</pre>
</body>
</html>
56 changes: 56 additions & 0 deletions docs-website/static/docs/walkthroughs/logging_remove.html
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 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>
</pre>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<!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:#55ff55;"></b><b style="color:#55ff55;"> ✔ </b> <b style="color:#55ff55;"></b><b style="color:#55ff55;">Deploy Zarf package confirmed</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"> 📦 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:#55ffff;"></b><b style="color:#55ffff;">Loading the Zarf State from the Kubernetes cluster</b>
<b class=BLK style="background-color:#ff5555"></b><b class=BLK style="background-color:#ff5555"> ERROR: </b> <b style="color:#ff5555;"></b><b style="color:#ff5555;">Failed to deploy package: unable to deploy all components in this Zarf Package: unable to deploy</b>
<b class=BLK style="background-color:#ff5555"></b><b class=BLK style="background-color:#ff5555"> </b> <b style="color:#ff5555;"></b><b style="color:#ff5555;">component baseline: unable to get the updated value template: unable to load the Zarf State from the</b>
<b class=BLK style="background-color:#ff5555"></b><b class=BLK style="background-color:#ff5555"> </b> <b style="color:#ff5555;"></b><b style="color:#ff5555;">Kubernetes cluster: secrets "zarf-state" not found</b>
</pre>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!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"> 📦 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;">Copying 1 files</b>
• <b style="color:#55ffff;"></b><b style="color:#55ffff;">Copying 1 files</b>
<b class=BLK style="background-color:#ff5555"></b><b class=BLK style="background-color:#ff5555"> ERROR: </b> <b style="color:#ff5555;"></b><b style="color:#ff5555;">unable to deploy all components in this Zarf Package: unable to deploy component zarf-seed-registry: unable to connect to the Kubernetes cluster: timed out waiting for cluster to report healthy</b>
</pre>
</body>
</html>
Binary file added docs/.images/walkthroughs/logging_login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.images/walkthroughs/logging_logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.images/walkthroughs/logging_prompts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.images/walkthroughs/logging_query.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.images/walkthroughs/logging_thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 3 additions & 26 deletions docs/13-walkthroughs/2-deploying-doom.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,18 +224,7 @@ The dos-games package has now been removed from your cluster.

#### Example

```sh
JasonvanBrackel marked this conversation as resolved.
Show resolved Hide resolved
? Deploy this Zarf package? Yes


📦 BASELINE COMPONENT


ERROR: Failed to deploy package: unable to deploy all components in this Zarf Package: unable to deploy
component baseline: unable to connect to the Kubernetes cluster: timed out waiting for cluster to
report healthy
$
```
<iframe src="/docs/walkthroughs/troubleshoot_unreachable.html" width="100%" height="200px"></iframe>

#### Remediation

Expand All @@ -254,23 +243,11 @@ After that you can try deploying the package again.

#### Example

```sh
? Deploy this Zarf package? Yes


📦 BASELINE COMPONENT


⠋ Loading the Zarf State from the Kubernetes cluster (0s)
ERROR: Failed to deploy package: unable to deploy all components in this Zarf Package: unable to deploy
component baseline: unable to get the updated value template: unable to load the Zarf State from the
Kubernetes cluster: secrets "zarf-state" not found
$
```
<iframe src="/docs/walkthroughs/troubleshoot_uninitialized.html" width="100%" height="250px"></iframe>

#### Remediation

If you receive this error when zarf is attempting to deploy the `BASELINE COMPONENT`, this means you have not initialized the kubernetes cluster. This is one of the prerequisites for this walkthrough. Perform the [Initialize a cluster](./1-initializing-a-k8s-cluster.md) walkthrough, then try again.
If you receive this error when zarf is attempting to deploy the a component, this means you have not initialized the kubernetes cluster. This is one of the prerequisites for this walkthrough. Perform the [Initialize a cluster](./1-initializing-a-k8s-cluster.md) walkthrough, then try again.
JasonvanBrackel marked this conversation as resolved.
Show resolved Hide resolved

## Credits

Expand Down
Loading