This repository is intended to be a public one-stop resource for various use-case based demonstrations. This will be broken up into various use-case "patterns". A lot of these guides will be based on OpenShift, but this will also include patterns for OpenStack and Ansible as well.
The repository will be broken up into two primary formats.
Use cases will be one-and-done demonstrations for a given use case. These are quick formatted guides to demonstrate a very targeted action item. An example of could be something like "pod autoscaling". With a "pod autoscaling" demonstration, a use-case for scaling pods is documented along with instructions for implementing that functionality, finishing with sample output from the demonstrated use case.
A "progressive guide" takes a collection of "use cases", and expands this for a full end-to-end implementation reference guide. A small example of this is user management. You may want to take several use case guides such as configuring an IDP integration, assigning users to groups, assigning those groups to roles (with associated role-bindings), removing the kube-admin password, and then demonstrating an end to end application deployment with multi-team engagement during an example SDLC. "Use cases" are narrow in focus, whereas a "progressive guide" tells a complete story.
For questions, please open an Issue. Pull requests will be reviewed and accepted, but please see our contributing guidelines (more to come soon).
Progressive guides are full, end-to-end demonstrations that target specific end-users or use cases.
| Section | Title/Goal | |
|---|---|---|
| ✔️ | N/A | Overview |
Installation guides go above and beyond our official Red Hat documentation. Examples of this could be setting up Zero Touch Provisioning, or installation of upstream or new operators.
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 000.000 | Overview |
These guides should be focused on demonstrating OpenShift and Kubernetes parity.
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 100.000 | Overview |
| ✔️ | 100.100 | Implement pod autoscaling on a given workload with test workload with custom metrics |
Infrastructure guides will be focused on hardware-specific deployments, such as performance add-on operator, NVIDIA DPU (when used as an OpenShift endpoint), etc.
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 200.000 | Overview |
Unlike the infrastructure guides, networking is specifically focused on network-specific hardware like Intel 810/710 feature enablement, SR-IOV operator, or NVIDIA DPUs (when used for networking acceleration).
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 300.000 | Overview |
| ✔️ | 300.100 | Create a service type LoadBalancer for bare metal (MetalLB) |
These guides will be focused on storage deployments, integration, and operation.
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 400.000 | Overview |
Security guides will focus on many areas of security. This could be RHCOS security, ACS, ACM, native Kubernetes security features, or general OpenShift security enhancements.
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 500.000 | Overview |
Anything related to self-service within the OpenShift platform should be included in this section.
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 600.000 | Overview |
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 700.000 | Overview |
Developer-focused use cases and overall developer experience.
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 800.000 | Overview |
| Section | Title/Goal | |
|---|---|---|
| ✔️ | 900.000 | Overview |
| ✔️ | 900.100 | Install Red Hat OpenShift Logging Operator for in-cluster logging (not related to remote forwarding) |