Developer Experience Workshop Setup

This repository contains the setup instructions to build the Developer Experience Workshop. Refer to this link for workshop module content.

Introduction

Bring Your Own Cluster

This workshop is deployed via the cluster-bootstrapper which supports both building new clusters and bringing your own cluster. For ease of deployment with this workshop, we will bring our own OpenShift 4 cluster by ordering "AWS with ROSA Open Environment" from demo.redhat.com.

Architecture

The workshop is deployed in two phases:

1. Workshop Infrastructure

Terraform and Ansible automation deploy Red Hat OpenShift GitOps (ArgoCD) which in turn deploys an app of apps pattern:

• At the root is infrastructure-orchestrator
• ... which deploys infrastructure-rollout-controller
• ... which deploys the workshop infrastructure Helm charts

The workshop infrastructure Helm charts deploy the following operators:

• Red Hat Single Sign-On (Keycloak)
• Vault
• External Secrets
• GitLab (self-hosted)
• Red Hat Developer Hub

2. Workshop Template

Launching a one-time setup Developer Hub template for the workshop will deploy another app of app pattern:

• GitLab cloned copy of workshop-orchestrator
• ... which deploys workshop-rollout-controller
• ... which deploys the operators required for the workshop module content:
  • Red Hat OpenShift Dev Spaces
  • Streams for Apache Kafka
  • Red Hat OpenShift Serverless
  • Red Hat build of OpenTelemetry
  • Minio (for S3 storage for OpenTelemetry)

Deployment

Deploy Workshop Infrastructure

1. Clone this Git repository: https://github.com/poc-examples/cluster-bootstrapper

2. Replace config.yaml in the cloned repository with this example config.yaml.

For ROSA and HCP installations, the name is the domain prefix of your cluster in Hybrid Cloud Console

  - name: rosa-abcde

The domain is name of your cluster domain (i.e. your OpenShift API endpoint is https://api.rosa-abcde.subdomain.openshiftapps.com)

    domain: rosa-abcde.subdomain.openshiftapps.com

You will need to obtain a ROSA token. If you are using "AWS with ROSA Open Environment", you can log into the provided bastion which is set up for rosa cli:

rosa token --generate

Update the AWS and ROSA credentials:

    providerCredentials:
      aws_access_key_id: ""
      aws_secret_access_key: ""
      region: "us-east-2"
      rosa_token: ""

Update the version of the chart as needed. The latest published version can be found in Chart.yaml

    workshop:
      chart:
        enabled: true
        name: orchestrator
        version: 0.0.90

To install the workshop infrastructure components and configure Developer Hub plugins to access those components (i.e. GitLab, OpenShift GitOps, ...), run:

make configure

The setup files can be found here and toggling on/off individual operators can be found here.

Deploy Workshop Template

Now that the infrastructure components have been installed, log into Developer Hub as an administrator. Import the workshop template in Developer Hub by navigating to Catalog -> Self-service -> Register Existing Component and using this template

Using the newly imported template will deploy the workshop by writing files to the internal GitLab where OpenShift GitOps will sync to the repository and build out the operators required. The template will also ask the user whether extra capacity for Dev Spaces and Kafka need to be provisioned. Kicking off off the template writes towards the self-hosted GitLab, and OpenShift GitOps will sync changes and build out the operators required for end users to use the workshop module content.

The template obsoletes the following alternative instructions to build and host workshop content.

Adding Cluster Admins

If you are using ROSA hosted control planes, the OpenShift Cluster Manager manages users of the cluster-admins and dedicated-admins group. To add a cluster-admin, log onto the provided ROSA bastion and run the following commands, substituting the cluster ID with your own:

rosa list cluster
ID                                NAME        STATE  TOPOLOGY
2lm4hsaqidq67ne30i1q279jlml981vi  rosa-77mtr  ready  Hosted CP

rosa grant user cluster-admin --user=admin --cluster=2lm4hsaqidq67ne30i1q279jlml981vi

Workshop Modules

The workshop module library is hosted in its own GitHub organization and contains prebuilt module content for the developers. The workshop administrators should clone from the public GitHub organization to the self-hosted GitLab instance in the workshop cluster.

Adding Module Content

The workshop modules can be hosted in Developer Hub's TechDocs for end users to view. These modules are imported into GitLab as follows:

1. The GitLab repository that was deployed contains a root user that can import Git repositories from external GitHub. Log in with the root GitLab user (the password can be found in oc get secret gitlab-gitlab-initial-root-password -n gitlab-system -o yaml)
2. Configure GitHub as an allowed import source to GitLab self-managed.
3. In GitLab, navigate to the developers group which is an appropriate RBAC role for end users to view but not merge module content to the main branch. Create a new project -> Import project -> Import from GitHub. Import any of the modules from the content library above.
4. Developer Hub automatically detects valid catalog-info.yaml files from the accompanying repositories and imports them and their TechDocs content.

Updates

Updating Helm Charts

For each Helm chart that needs to be updated, follow the instructions below:

1. Fork the repository, update the content in the relevant chart, and bump the chart version.
2. Push to main branch (or open a pull request, and the maintainers will accept and merge) which will kick off a chart build job.
3. In your deployed ArgoCD, go to the infrastructure-orchestrator application, go to parameters, and override the chart version.

Updating Dev Spaces RBAC

Users in Dev Spaces are granted the developers role via the configured CheCluster CR from the dev-spaces Helm chart. Depending on workshop content and other operators that are installed, the developers role RBAC may need to be configured, which can be done from the system_roles Helm chart. The workflow to update this Helm chart is the same as above.

Updating Workshop Content in Developer Hub

The workshop content is built in mkdocs format. To update the website, fork this Git repository, update the docs and upload the new software template.