forked from acowles-redhat/rh1-hcp-lab-2025
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README, summary, review for grammar/spelling
- Loading branch information
1 parent
f2b884c
commit d7a665b
Showing
11 changed files
with
69 additions
and
96 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,103 +1,39 @@ | ||
=== Getting Started | ||
== Introduction | ||
|
||
This template is designed to be used as a base for your showroom lab guides. | ||
This repository hosts the lab guide for the OpenShift on OpenShift with Hosted Control Planes lab, which will be delivered by Red Hat Associates at the Red Hat One event in Spring 2025. | ||
|
||
The content is built using Antora, a static site generator for creating documentation sites from AsciiDoc documents. | ||
It is designed to work with the Showroom lab environment provided by the Red Hat Demo Platform (RHDP) team. | ||
|
||
This git repo template was created to make it easy for you to start developing your lab instructions. | ||
This lab is organized to allow you to have a hands-on experience with Red Hat OpenShift Virtualization. | ||
|
||
Features: | ||
OpenShift Virtualization enables you to bring virtual machines onto a modern, Kubernetes-based infrastructure. It enables the development and delivery of new applications as well as the modernization of existing ones and can create applications that consist of virtual machines, containers, and serverless functions - all managed together using Kubernetes-native tools and paradigms. | ||
|
||
. 0% cruft | ||
. Red Hat Demo Platform UI Bundle default | ||
. Dev Mode extension that displays the asciidoc attributes you have to work with | ||
. Content is generated using Antora, a static site generator for creating documentation sites from AsciiDoc documents. | ||
In this event we will explore many common management activities that virtual administrators often encounter in their day to day workflows. | ||
|
||
== Getting Started | ||
|
||
=== Using Containers (Recommended) | ||
== Lab Content | ||
|
||
In order to test and develop on your local machine, you can use a specially built container with Podman or Docker as follows. | ||
These are the four main sections that will be covered: | ||
|
||
. Create a git repo from this template | ||
.. Suggested naming: `showroom_<lab-name>` | ||
. Clone your new repo and `cd` into it | ||
. When you make changes to the content, all you need is to kill the container and run it again. | ||
+ | ||
[source,sh] | ||
---- | ||
podman run --rm --name antora -v $PWD:/antora -p 8080:8080 -i -t ghcr.io/juliaaano/antora-viewer | ||
---- | ||
*Deployment:* Using Red Hat Advanced Cluster Management for Kubernetes (RHACM) to deploy a virtual OpenShift on OpenShift cluster using Red Hat OpenShift Virtualization. This section also explores the environment once it's deployed. | ||
|
||
Live-reload is not supported. | ||
*Configuration:* Performing operations on the *hosting* cluster to enact configuration changes on the *hosted* cluster. | ||
|
||
=== Using Local Files (Less Recommended) | ||
*Scaling:* NodePools in a Hosted Control Planes environment can be configured to autoscale when resources are unavaialable to meet application requests. We will deploy an application and scale it up, requiring the cluster to scale up dynamically to meet application needs. | ||
|
||
. Create a git repo from this template | ||
. Clone the repo and `cd` into it | ||
. Run ./utilities/lab-serve | ||
. Open http://localhost:8080 in your browser | ||
. Run ./utilities/lab-build to build your html | ||
*Cluster Upgrades:* A demonstration of centralized fleet management by exploring cluster upgrade processes, and a walkthrough of the cluster upgrade process using Red Hat Advanced Cluster Management for Kubernetes. | ||
|
||
To rebuild your html, run `./utilites/build`. | ||
|
||
== Editing Files | ||
== Version Information | ||
|
||
Now you are ready to go! | ||
You can start editing the files in the `content/modules/ROOT/pages/` directory. | ||
This edition of the lab has been developed using the following software versions: | ||
|
||
Many modern editors such as Visual Studio Code offer live Asciidoc Preview extensions. | ||
Red Hat Advanced Cluster Management for Kubernetes 2.12 | ||
|
||
=== Understanding the Basic Template Directory Structure | ||
Red Hat OpenShift 4.17.4 | ||
|
||
[source,sh] | ||
---- | ||
./content/modules/ROOT/ | ||
├── assets | ||
│ └── images # Images used in your content | ||
│ └── example-image.png | ||
├── examples # You can add downloadable assets here | ||
│ └── example-bash-script.sh # e.g. an example bash script | ||
├── nav.adoc # Navigation for your lab | ||
├── pages # Your content goes here | ||
│ ├── index.adoc # First page of your lab, e.g. overview etc | ||
│ ├── module-01.adoc | ||
│ └── module-02.adoc # Sample lab has 2 modules including index.adoc | ||
└── partials # You can add partials here, reusable content inserted inline into your modules | ||
└── example_partial.adoc | ||
---- | ||
Red Hat OpenShift Virtualization 4.17.1 | ||
|
||
== Adding Additional Links | ||
Red Hat OpenShift Data Foundation 4.16.3 | ||
|
||
You can add links to external content in the convenient "Links" drop-down on the upper-right of the Showroom Summit 2024 UI. | ||
|
||
../content/antora.yml | ||
[source,yaml] | ||
---- | ||
asciidoc: | ||
attributes: | ||
page-links: | ||
- url: https://redhat.com | ||
text: Red Hat | ||
---- | ||
|
||
image::ui-links.png[] | ||
|
||
== Dev Mode | ||
|
||
As a convenience to developers, the Dev Mode Extention (disabled by default) displays the asciidoc attributes you have to work with while writing your lab instructions. | ||
|
||
. Disable/Enable Dev Mode by changing `enabled: true` or `enabled: false` | ||
+ | ||
.default-site.yml | ||
[source,yaml] | ||
---- | ||
extensions: | ||
- id: dev-mode | ||
require: ./content/lib/dev-mode.js | ||
enabled: false | ||
---- | ||
|
||
. Produces | ||
+ | ||
image::dev-mode.png[] | ||
Multicluster Engine for Kubernetes 2.7.1 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+22.6 KB
(120%)
content/modules/ROOT/assets/images/intro/hosted_control_planes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,24 @@ | ||
== Lab Summary | ||
== Lab Wrap-up and Summary | ||
|
||
In completing this lab you will have performed the following tasks: | ||
|
||
.*Hosted Cluster Deployment:* | ||
.. We reviewed the prerequisites required to deploy an OpenShift on OpenShift cluster with Hosted Control Planes. | ||
.. We made use of Red Hat Advanced Cluster Management for Kubernetes to deploy our OpenShift on OpenShfit cluster. | ||
.. We explored our deployed cluster, including the control plane pods and node pools that it is composed of. | ||
|
||
.*Configuration:* | ||
.. We configured authentication for our cluster from the hosting cluster environment. | ||
.. We tested our authentication method, and applied authorization configurations to our hosted cluster environment. | ||
|
||
. *Scaling:* | ||
.. We deployed an application in our hosted cluster, demonstrating that processes are the same as any other OpenShift deployment. | ||
.. We configured our node pools to autoscale when resources are unavaialable to meet application requests. | ||
.. We scaled our application up to multiple replicas, triggering an autoscale event. | ||
.. We deleted our deployment and observed the cluster autoscale back down once extra resources weren't required. | ||
|
||
. *Cluster Upgrades:* | ||
.. We explored the different methods available to us to upgrade our hosted cluster, or our entire fleet of clusters. | ||
.. We performed a cluster upgrade using Red Hat Advanced Cluster Management for Kubernetes. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters