rht-labs / tech-exercise Goto Github PK

Quality Gates

• Module: OWASP Zap Scanning

📝 Description

Add OWASP ZAP scanning for front end and API (Jenkins & Tekton)

🥤 Additional Info

Docs:
OWASP Zap Scanning - General Info
Jenkins
Tekton

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

How-Now-Wow Prioritization

• Module: How-Now-Wow Prioritization

Create content for this practice showed in Content Loop

📝 Description

How-Now-Wow Prioritization (Experiments Prioritization)

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - How-Now-Wow Prioritization (Matrix)

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Observability

• Module: aggregated logs

📝 Description

assume the workload logging operator is deployed as part of the enablement-framework. Attendees should login to kibana, create a search index and query their logs from pet-battle. Delete a pod and find results from old container logs or something to that affect 🤷

🥤 Additional Info

OpenShift cluster logging is here

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Emerging Architecture

• Module: Emerging Architecture

📝 Description

Emerging Architecture

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Quality Gates

• Module:Load testing

📝 Description

Introduce Load testing for front end and API (Jenkins & Tekton)

🥤 Additional Info

load testing

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Non-Functional Requirements Map

• Module: Non-Functional Requirements Map

📝 Description

Non-Functional Requirements Map - A collaborative approach for capturing non-functional requirements

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Non-Functional Requirements Map

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

📝 Description

Following the instructions described here to create the Jenkins pipeline of the pet-battle application, I cannot get the new pipeline be created.

I executed the seed-multibranch-pipelines pipeline manually, the following exceptions are showed in the Jenkins' pod logs:

2021-11-29 07:52:02 WARNING hudson.model.listeners.RunListener report RunListener failed
java.lang.NoClassDefFoundError: org/junit/rules/ExternalResource
	at org.jvnet.hudson.test.BuildWatcher$Listener.onStarted(BuildWatcher.java:89)
	at hudson.model.listeners.RunListener.fireStarted(RunListener.java:237)
	at hudson.model.Run.execute(Run.java:1886)
	at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:43)
	at hudson.model.ResourceController.execute(ResourceController.java:99)
	at hudson.model.Executor.run(Executor.java:431)

🚶 Steps to reproduce

Basically follow the instructions of the technical exercise. This is a blocker to follow other exercises using Jenkins, instead of Tekton.

🧙‍♀️ Suggested solution

Accentance Criteria

• Module: Accentance Criteria

📝 Description

Accentance Criteria

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Design of Experiments

• Module: Design of Experiments

📝 Description

Design of Experiments - Learn Fast, Move Even Faster

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Design of Experiments

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Blue Green Deployments

• Module: Blue Green Deployments

📝 Description

Blue Green Deployments - Always have a fall back solution

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Blue Green Deployments

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Design Sprint

• Module: Design Sprint

📝 Description

Design Sprint - A five-day process for testing new ideas

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Design Sprint

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Guerilla Testing

• Module: Guerilla Testing

📝 Description

Guerilla Testing - Lean, agile and low-cost method of quickly capturing user feedback

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Guerilla Testing

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Feature Flags

• Module: Feature Flags

📝 Description

Feature Toggles - AKA Feature Flags/Bits/Flipping/Controls

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Feature Flags

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Team Sentiment

• Module: Team Sentiment

📝 Description

Team Sentiment - Track the mood of a team with visible feedback

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Team Sentiment

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Quality Gates

• Module: StackRox

📝 Description

Introduce StackRox for container and hist security for front end and API (Jenkins & Tekton)

🥤 Additional Info

Docs:
StackRox - General Info
Jenkins
Tekton

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Observability

• Module: User Workload Monitoring

📝 Description

Learners should extend their pet-battle infra with the grafana chart. This is done for each team as it is namespaced. Probs need one for test & stage. Then via argocd override, we can enable ServiceMonitor. Teams should discuss what are important measures eg api response time or uptime etc and build a simple query for their dashboard to show this.

🥤 Additional Info

grafana from pb-infra here
service monitor on chart is here

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

SCRUM

• Module: SCRUM

📝 Description

Scrum Framework to acelerate delivery loop. This practice could cover the following entries in the content loop:

• Sprint Planning
• Daily Standup
• Showcase

It could be great to add a new image in the content loop for Scrum, as there is already for Kanban

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• Slides
• OPL - Sprint Planning
• OPL - Daily Standup
• OPL - Showcase

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

📝 Description

ADD - some branding for TL500 to make this more downstream "producty"

🧙‍♀️ Suggested solution

@christusa to add brand guidelines

Add Licence to the repo & pages

Add PDF to docsify [epub for bonus points]

A/B Testing

• Module: A/B Testing

📝 Description

Split Testing - A/B Testing -Quantitative testing of two alternative designs to learn which better leads to a specific goal

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - A/B Testing

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Quality Gates

• Module: Image Signing

📝 Description

Add image signing step for front end and API (Jenkins & Tekton)

🥤 Additional Info

Docs:
Image Signing - General Info
Jenkins
Tekton

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Observability

• Module: Alerting

📝 Description

Use PrometheusRule to fire alerts when specific events happen.
As a team, come up with new metric to alert on... Extend the base alerts to include this new alert

🥤 Additional Info

alerting for pet-battle stuff here

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Observability

• Module: Information Radiators

📝 Description

Radiate ALL THE THINGS!! 💪

• small exercise to build Jenkins dashboards showing key stats & same same for tekkers.

🥤 Additional Info

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Canary Release

• Module: Canary Release

📝 Description

Canary Release - Exposing a small number of real users to a new version

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Canary Release

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Quality Gates Exercise

• Module: Sonar-scanning

📝 Description

Add sonar scanning for the application code quality. This should run independently of any other Quality Gate module in order to maintain executing the exercise in any order.

🥤 placeholder

https://github.com/rht-labs/tech-exercise/blob/main/docs/3-revenge-of-the-automated-testing/1-sonar-scanning.md

✅ A/Cs

• Big Picture Updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Advanced deployments

• Module: Autoscaling

📝 Description

ArgoCD config to enable hpa in stage or test
Add the HPA yaml to the pet-battle api charts.
Fire some load, watch it scale up / down.
come up with good metrics to scale on and tweak via argocd override or app change

🥤 Additional Info

hpa for pb is disabled by default. chart is here

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Advanced Deployment

• Module: A/B Deployment

📝 Description

Simulate an A/B deployment for the frontend. Update the pet-battle applications with Matomo chart and update the frontend overwrites to point to this new instance. Update arogcd config to house an a and b deployment for the front end. configure the weights using config as code. Show results of experiment in the matomo ui.

🥤 Additional Info

matomo lives here
pb-config change is here

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Definition of Ready

• Module: Definition of Ready

📝 Description

Definition of Ready

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Network Mapping

• Module: Network Mapping

📝 Description

Network Mapping - Build a network of relationships in your organization or team

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Network Mapping

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Dark Launches

• Module: Dark Launches

📝 Description

Dark Launches - Letting a small group of interested users test features before others

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Dark Launches

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Example Mapping

• Module: Example Mapping

📝 Description

Example Mapping - Involving stakeholders in defining acceptance criteria

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Example Mapping

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Containers

• Module: Containers

📝 Description

Containers

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

North Star

• Module: North Star

📝 Description

North Star

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Stop the World

• Module: Stop the World

📝 Description

Stop the World

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

📝 Description

The <pre></pre> blocks in the markdown are not syntax highlighted. They should be to make it easier for the learner to see what need changing

🚶 Steps to reproduce

... if applicable

🧙‍♀️ Suggested solution

Look into prism or highlightjs. I know Docsify loads prismjs so perhaps we could / should be able to use it without if affecting the copy plugin....

Here's a thought....

there are sections of the docs that have yaml like this:

source: "https://gitlab-ce.apps.<CLUSTER_DOMAIN>/<TEAM_NAME>/tech-exercise.git"
team: <TEAM_NAME>

we have the attendees do a find and replace, but Im just thinking, we could probs write a docsify plugin or something along those lines to parse the page before it's rendered and replace these with the values used by a team. Im thinking, something lightweight with just two text boxes or something that you fill in when you open the docs and can set the values in local storage so refreshes etc are still good. I think this will help some of the typo issues we have seen historically and also mean we don't maintain forks of the repo for each team. What do you guys think?
@philipdouble - i see that docsify has lifecycle hooks perhaps we can use these to our advantage? https://docsify.js.org/#/write-a-plugin

FYI @eformat / @philipdouble / @Rileyi / @ckavili

Big Picture

• Module: Big Picture

📝 Description

Big Picture

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Quality Gates

• Module: Automated Testing

📝 Description

Add tests to the pipeline for front end & api (Jenkins & Tekkers)
Add extension to the pipeline to automatically promote image from test to stage when pipeline successful.

🥤 Additional Info

docs go here

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Definition of Done

• Module: Definition of Done

📝 Description

Definition of Done

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

discsuss ....

Usability Testing

• Module: Usability Testing

📝 Description

Usability Testing - Observe and learn from real users

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Usability Testing

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Quality Gates

• Module: Image Security

📝 Description

Add image security steps for front end and API (Jenkins & Tekton)

🥤 Additional Info

Docs:
Image Security - General Info
Jenkins
Tekton

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Weighted Shortest Job First

• Module: Weighted Shortest Job First

📝 Description

Weighted Shortest Job First - Practice for quantitatively assessing and agreeing backlog prioritisation

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Weighted Shortest Job First

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Each module should be independent of the previous one... etc

Quality Gates

• Module: Code coverage and linting

📝 Description

Introduce Code coverage and linting for front end and API (Jenkins & Tekton)

🥤 Additional Info

Docs:
Code coverage and linting - General Info
Jenkins
Tekton

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Advanced Deployments

• Module: Blue/Green Deployments

📝 Description

Introduce Blue/Green deployment for pet-battle-api.
Update pipelines (Jenkins & Tekton) and pet-battle helm charts accordingly.
Run the pipeline and see it switches the traffic (from blue to green) after the green one passes the tests.

🥤 Additional Info

suggested blue/green approach for pipeline (swapping labels from active/ inactive once smoke test has been successful)

✅ A/Cs

• Big Picture Updated (if applicable)
• Facilitator notes updated (if applicable)
• Exercise peer reviewed / tested with one other region member
• Addition of new exercise does not affect previous exercise (maintain modularity)

Product Backlog Refinement

• Module: Product Backlog Refinement

📝 Description

Understand, prioritise, and clarify items in the backlog to ensure they're ready to work on.

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Backlog Refinement

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

Impact Efford priorization

• Module: Impact Efford priorization

Create content for this practice showed in content loop.

📝 Description

Prioritization of Experiments

🥤 Additional Info

...link to the docs where the slides content should be added or links to blogs etc that form the basis of the content.

• OPL - Impact & Effort Prioritization (Matrix)

✅ A/Cs

• Content
• Facilitator notes updated (if applicable)
• Slides content peer reviewed with one other region member
• Content loop image updated (if applicable)
• Slides content linked in content loop image

📝 Description

Following instrucctions of Exercise 1 to deploy ArgoCD I found an exception related with RBAC policies for my user.

Error: rendered manifests contain a resource that already exists. Unable to continue with install: could not get information about the resource: clusterrolebindings.rbac.authorization.k8s.io "team8-ci-cd-argocd-application-controller" is forbidden: User "team8" cannot get resource "clusterrolebindings" in API group "rbac.authorization.k8s.io" at the cluster scope

🚶 Steps to reproduce

Output of the command with the error:

sh-4.4$ helm upgrade --install argocd \
>   --namespace ${TEAM_NAME}-ci-cd \
>   -f /projects/tech-exercise/argocd-values.yaml \
>   redhat-cop/argocd-operator
Release "argocd" does not exist. Installing it now.
Error: rendered manifests contain a resource that already exists. Unable to continue with install: could not get information about the resource: clusterrolebindings.rbac.authorization.k8s.io "team8-ci-cd-argocd-application-controller" is forbidden: User "team8" cannot get resource "clusterrolebindings" in API group "rbac.authorization.k8s.io" at the cluster scope

This is a OCP 4.6 cluster deployed automatically by LodeStar, as part of a coming DO500 Enablement, and I am connected using a developer user (e.g: team8) with the default capabilities of a DO500 developer user.

Should my user has more capabilities? Is it missed something in the cluster to execute this step?