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

Jump to bottom

[doc] Add a page for inject failure demo #1144

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[doc] Add a page for inject failure demo #1144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43853b9
[doc] Update menu
wzshiming Jun 27, 2024
43c0f75
[doc] Add a page for inject failure demo
wzshiming Jun 27, 2024
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
28 changes: 20 additions & 8 deletions site/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,10 +152,14 @@ menu:
weight: 1060
parent: user-guide

- identifier: examples
title: Examples
parent: user-guide

- identifier: kwokctl-advanced-usage
title: "`kwokctl` Advanced Usage"
weight: 200010
parent: user-guide
parent: examples
- identifier: snapshots
pageRef: "/docs/user/kwokctl-snapshot"
parent: kwokctl-advanced-usage
Expand All @@ -172,24 +176,32 @@ menu:
pageRef: "/docs/user/kwokctl-platform-specific-binaries"
parent: kwokctl-advanced-usage

- identifier: examples
title: Examples
parent: kwokctl-advanced-usage
- identifier: kwokctl-integration
title: "`kwokctl` Integration"
weight: 200020
parent: examples
- identifier: argo
pageRef: "/docs/examples/argo"
parent: examples
parent: kwokctl-integration
- identifier: linkerd
pageRef: "/docs/examples/linkerd"
parent: examples
parent: kwokctl-integration
- identifier: istio
pageRef: "/docs/examples/istio"
parent: examples
parent: kwokctl-integration
- identifier: metrics-server
pageRef: "/docs/examples/metrics-server"
parent: examples
parent: kwokctl-integration
- identifier: metrics
pageRef: "/docs/examples/prometheus"
parent: kwokctl-integration

- identifier: chaos
title: Chaos
parent: examples
- identifier: injectfailure
pageRef: "/docs/user/examples/injectfailure"
parent: chaos

- identifier: tools
title: Tools
Expand Down
31 changes: 31 additions & 0 deletions site/content/en/docs/user/examples/injectfailure/_index.md
View file
Open in desktop
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Preview page https://deploy-preview-1144--k8s-kwok.netlify.app/docs/user/examples/injectfailure/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks nice.

Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Inject Failure
---

# Inject Failure Demo

{{< hint "info" >}}

This is a demo that introduces how to inject fault to initContainer in an existing minikube cluster.

{{< /hint >}}

<img width="700px" src="init-container-error-injection.svg">

{{< expand "Demo Detail Steps" >}}

{{< code-sample file="init-container-error-injection.demo" language="bash" >}}

{{< /expand >}}

{{< expand "virtual-gpu-node.yaml" >}}

{{< code-sample file="virtual-gpu-node.yaml" >}}

{{< /expand >}}

{{< expand "failed-pod.yaml" >}}

{{< code-sample file="failed-pod.yaml" >}}

{{< /expand >}}
Comment on lines +25 to +31
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So are you saying I can reference each file this way?

If yes, do I specify the file path to any file I want to reference?

For example, on the simulation.md file I can add the below to reference the node.yaml file:

{{< /expand >}}

{{< expand "demo/technical-outcomes/simulation/scenario-1/node.yaml" >}}

{{< code-sample file="demo/technical-outcomes/simulation/scenario-1/node.yaml" >}}

{{< /expand >}}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is because it is the same directory, so it can omit the path.

https://github.com/kubernetes-sigs/kwok/tree/main/site/content/en/docs/user/examples/injectfailure

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lovely. Will this PR be merged today?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I'll merge this #1145

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet

Loading