Skip to content

Commit

Permalink
refactored doc
Browse files Browse the repository at this point in the history
  • Loading branch information
lgchiaretto committed Nov 14, 2024
1 parent f1b42ee commit c98f1ea
Show file tree
Hide file tree
Showing 9 changed files with 38 additions and 13 deletions.
1 change: 1 addition & 0 deletions content/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ asciidoc:
page-links:
- url: https://redhat.com
text: Red Hat
login_command: "oc login --insecure-skip-tls-verify=false -u user2 -p 4GK0Iuskmp0ezjdX https://api.cluster-z5hvw.dynamic.redhatworkshops.io:6443"
4 changes: 2 additions & 2 deletions content/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
* xref:lab-environment.adoc[Lab Environment]
* xref:exercise1-break.adoc[1. Virtual Machine is with status ErrorUnschedulable]
* xref:exercise1-break.adoc[1. Virtual Machine is not scheduling - part 1]
** xref:exercise1-break.adoc#break[Break the exercise]
** xref:exercise1-check.adoc#check[Check your work]
* xref:exercise2-break.adoc[2. Virtual Machine is with status Pending]
* xref:exercise2-break.adoc[2. Virtual Machine is not scheduling - part 2]
** xref:exercise2-break.adoc#break[Break the exercise]
** xref:exercise2-check.adoc#check[Check your work]
Expand Down
16 changes: 12 additions & 4 deletions content/modules/ROOT/pages/exercise1-break.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[#scenario]
= Virtual Machine is with status status
= Virtual Machine is not scheduling - part 1

== Scenario

Expand All @@ -8,15 +8,23 @@ Your task is to identify the root cause and resolve the issue.

== Executing the lab script

In this exercise setup, you first need to access the bastion trough `bastion_url` to gain entry into the lab environment. From the terminal, access SSH the node `bastion_url` using `userX` (where X is the number of your user)
In this exercise setup, you first need to access the bastion trough `{bastion_public_hostname}` to gain entry into the lab environment. From the terminal on right side, access SSH the node bastion.

[source,sh,role=execute]
```
ssh userX@bastion_url
ssh {user}@{bastion_public_hostname} -p {bastion_ssh_port}
```

Once connected to the bastion host run the command lab to break the lab.
Once connected to the bastion host log in OCP cluster

[source,sh,role=execute]
```
{login_command}
```

run the command lab to break the lab

[source,sh,role=execute]
```
lab break exercise1
```
1 change: 1 addition & 0 deletions content/modules/ROOT/pages/exercise1-check.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

To check you work exercute the `grade` lab.

[source,sh,role=execute]
```
lab grade exercise1
```
11 changes: 9 additions & 2 deletions content/modules/ROOT/pages/exercise1-guided.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ Your task is to identify the root cause and resolve the issue.

== Executing the lab script

In this exercise setup, you first need to access the bastion trough `bastion_url` to gain entry into the lab environment. From the terminal, access SSH the node `bastion_url` using `userX` (where X is the number of your user)
In this exercise setup, you first need to access the bastion trough `{bastion_public_hostname}` to gain entry into the lab environment. From the terminal, access SSH the node `{bastion_public_hostname}` using `userX` (where X is the number of your user)

[source,sh,role=execute]
```
ssh userX@bastion_url
{login_command}
```

[source,sh,role=execute]
```
ssh {user}@{bastion_public_hostname} -p {bastion_ssh_port}
```

Once connected to the bastion host run the command lab to break the lab.

[source,sh,role=execute]
```
lab break exercise1
```
11 changes: 7 additions & 4 deletions content/modules/ROOT/pages/exercise2-break.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[#scenario]
= Virtual Machine is with status Pending
= Virtual Machine is not scheduling - part 2

== Scenario

Expand All @@ -8,13 +8,16 @@ Your task is to identify the root cause and resolve the issue.

== Executing the lab script

In this exercise setup, you first need to access the bastion trough `bastion_url` to gain entry into the lab environment. From the terminal, access SSH the node `bastion_url` using `userX` (where X is the number of your user)
In this exercise setup, you first need to access the bastion trough `{bastion_public_hostname}` to gain entry into the lab environment. From the terminal, access SSH the node bastion if you are not connected.

[source,sh,role=execute]
```
ssh userX@bastion_url
ssh {user}@{bastion_public_hostname} -p {bastion_ssh_port}
```

Once connected to the bastion host run the command lab to break the lab.

[source,sh,role=execute]
```
lab break exercise2
lab break exercise2
```
1 change: 1 addition & 0 deletions content/modules/ROOT/pages/exercise2-check.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

To check you work exercute the `grade` lab.

[source,sh,role=execute]
```
lab grade exercise2
```
6 changes: 5 additions & 1 deletion content/modules/ROOT/pages/lab-environment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@

This lab is designed to simulate real problems in OpenShift Virtualization, providing hands-on experience with troubleshooting and resolving common issues.

== Bastion

All scripts and commands in this lab environment must be executed exclusively via SSH through the bastion host. Check if you are connected on bastion before executing any `lab` script.

== lab script

The `lab` script is the tool used in this lab with four main possible options: `break`, `fix`, `grade`, and `clean`, each acting on a specific `<exercise>`.
The `lab` script is the tool used in this lab with four possible options: `break`, `fix`, `grade`, and `clean`, each acting on a specific `<exercise>`.

=== Usage:

Expand Down

0 comments on commit c98f1ea

Please sign in to comment.