This is a workshop on enabling operators through OperatorHub, as well as the process for creating, building and testing your own operator.
This workshop grants the user cluster admin access. It also uses buildah inside of a container in the OpenShift cluster to build images. Using buildah in a container currently requires that it be run as root and inside of a privileged container.
Because of the elevated access rights, only use this workshop on an expendable cluster which is going to be destroyed when the workshop is finished.
To deploy the workshop, first clone this Git repository to your own machine. Use the command:
git clone --recurse-submodules https://github.com/openshift-labs/lab-build-an-operator.git
The --recurse-submodules option ensures that Git submodules are checked out. If you forget to use this option, after having clone the repository, run:
git submodule update --recursive --remote
Next create a project in OpenShift into which the workshop is to be deployed.
oc new-project workshops
From within the top level of the Git repository, now run:
./.workshop/scripts/deploy-spawner.sh
The name of the deployment will be lab-build-an-operator.
You can determine the hostname for the URL to access the workshop by running:
oc get route lab-build-an-operator
When the URL for the workshop is accessed you will be prompted for a user name and password. Use your email address or some other unique identifier for the user name. This is only used to ensure you get a unique session and can attach to the same session from a different browser or computer if need be. The password you must supply is openshift.
The deployment created above will use an image from quay.io for this workshop based on the master branch of the repository.
To make changes to the workshop content and test them, edit the files in the Git repository and then run:
./.workshop/scripts/build-workshop.sh
This will replace the existing image used by the active deployment.
If you are running an existing instance of the workshop, if you want to start over with a fresh project, first delete the project used for the session.
oc delete project $PROJECT_NAMESPACE
Then select "Restart Workshop" from the menu top right of the workshop environment dashboard.
When you are happy with your changes, push them back to the remote Git repository.
If you need to change the RBAC definitions, or what resources are created when a project is created, change the definitions in the templates directory. You can then re-run:
./.workshop/scripts/deploy-spawner.sh
and it will update the active definitions.
Note that if you do this, you will need to re-run:
./.workshop/scripts/build-workshop.sh
to have any local content changes be used once again as it will revert back to using the image on quay.io.
To delete the spawner and any active sessions, including projects, run:
./.workshop/scripts/delete-spawner.sh
To delete the build configuration for the workshop image, run:
./.workshop/scripts/delete-workshop.sh
To delete any global resources which may have been created, run:
./.workshop/scripts/delete-resources.sh
To build the workshop image locally using docker you would run:
docker build -t lab-sample-workshop .To run the image, you would then use:
docker run --rm -p 10080:10080 lab-sample-workshopYou can then access the workshop environment using http://localhost:10080.
If you want to be able to do iterative changes and test them without needing to rebuild the image each time, you can run:
docker run --rm -p 10080:10080 -v `pwd`:/opt/app-root/src lab-sample-workshop
```
This will mount your local Git repository directory into the container and the local files will be used. Each time you change the content of a page, refresh the web browser to view the latest version. You will only need to stop and restart the container if you make changes to the YAML configuration files or the config.js file if you are using it.