Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thoth-station/meteor-operator
Project Meteor Operator for OpenShift
https://github.com/thoth-station/meteor-operator
hacktoberfest kubernetes meteor opendatahub openshift operator
Last synced: 6 days ago
JSON representation
Project Meteor Operator for OpenShift
- Host: GitHub
- URL: https://github.com/thoth-station/meteor-operator
- Owner: thoth-station
- License: gpl-3.0
- Created: 2021-07-23T13:58:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-30T14:29:01.000Z (over 1 year ago)
- Last Synced: 2024-11-02T07:14:01.694Z (13 days ago)
- Topics: hacktoberfest, kubernetes, meteor, opendatahub, openshift, operator
- Language: Go
- Homepage:
- Size: 750 KB
- Stars: 4
- Watchers: 9
- Forks: 11
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Meteor Operator
## Prerequisites
The cluster where the operator will be working on must have these components already deployed and available:
- Tekton / Openshift Pipelines
- [cert-manager](https://github.com/cert-manager/cert-manager)
- A default storage class with dynamic PV provisioning
## Custom Resources
### Meteor
Meteor represents a repository that is built and deployed by this Operator.
```yaml
apiVersion: meteor.zone/v1alpha1
kind: Meteor
metadata:
name: demo
spec:
url: github.com/aicoe-aiops/meteor-demo
ref: main
ttl: 100000 # Time to live in seconds, defaults to 24h
```
## Development
General pre-requisites:
1. A Kubernetes or OpenShift cluster, with the local `KUBECONFIG` configured to access it in the preferred target namespace.
- for OpenShift: `oc login`, and use `oc project XXX` to switch to the `XXX` target namespace
- for a quick local Kubernetes cluster deployment, see the `kind` instructions below
2. The cluster must meet the prerequisites mentioned above (tekton, etc)
The script `script_nfs.bash` can install the necessary storage class if you use Quicklab
as your development environment (see the script header for requirements)
3. To deploy the tekton pipelines and tasks CRE Operator depends on: `make install-pipelines`
## Run operator locally
### Interactive debugging
To debug/run the operator locally, while it's still connected to a cluster and listens to events from this cluster use these steps.
#### Setup
Prerequisites: `dlv` and `VSCode`
Install `dlv` via `go get -u github.com/go-delve/delve/cmd/dlv`
#### Launch
1. Log in to your cluster via `oc login`
2. Install CRDs via `make install`
3. Start VSCode debugging session by selecting `Meteor Operator` profile
## Quick build and deploy to a cluster
The following commands will build the image, push it to the container registry, and deploy the operator to the `aicoe-meteor` namespace of your currently configured cluster (as per your `$KUBECONFIG`):
If you want to use a custom image name/version:
```sh
export IMAGE_TAG_BASE=quay.io/myorg/meteor-operator
export VERSION=0.0.7
```
To build, push and deploy:
```sh
podman login ... # to make sure you can push the image to the public registry
make docker-build
make docker-push
make install-pipelines
make deploy
```
## Testing locally with `envtest`
see for details, extract:
```sh
export K8S_VERSION=1.21.2
curl -sSLo envtest-bins.tar.gz "https://go.kubebuilder.io/test-tools/${K8S_VERSION}/$(go env GOOS)/$(go env GOARCH)"
sudo mkdir /usr/local/kubebuilder
sudo chown $(whoami) /usr/local/kubebuilder
tar -C /usr/local/kubebuilder --strip-components=1 -zvxf envtest-bins.tar.gz
make test SKIP_FETCH_TOOLS=1 KUBEBUILDER_ASSETS=/usr/local/kubebuilder ENABLE_WEBHOOKS=false
```
## Deploying a local cluster with `kind`
Using `make kind-create` will set up a local Kubernetes cluster for testing, using [kind](https://kind.sigs.k8s.io/).
`make kind-load-img` will build and load the operator container image into the cluster.
`export T=$(kubectl -n kubernetes-dashboard create token admin-user)` will get the admin user token for the
Kubernetes dashboard.
Run `kubectl proxy` to expose 8001 and access for the kubernetes dashboard.
Use `kubectl port-forward -n tekton-pipelines service/tekton-dashboard 9097:9097` to expose the tekton dashboard, visit it at
## Deploying a local cluster with `microshift`
### A note on MicroShift versions
At the time of this writing (2022-09-07):
- upstream/published versions of [microshift](https://github.com/openshift/microshift) have not been updated for a while, and they are based on a relatively old version of Kubernetes, v1.21.
- current versions of the Tekton operator require Kubernetes v1.22 or later ([apparently inheriting the requirement from knative](https://github.com/tektoncd/operator/blob/f09e32ac1e238aa1d235923735ea3db2f02f66fe/vendor/knative.dev/pkg/version/version.go#L36)?)
- the development version of MicroShift is based on OpenShift 4.10, which meets the version requirements:
```shell
$ oc version
Client Version: 4.10.0-202207291637.p0.ge29d58e.assembly.stream-e29d58e
Kubernetes Version: v1.23.1
```
### Creating a MicroShift cluster
Follow the instructions of the [MicroShift development environment on RHEL 8](https://github.com/openshift/microshift/blob/main/docs/devenv_rhel8.md) documentation to set up MicroShift on a virtual machine.
#### Known issues
- As of 2022-09-07, an existing [bug on microshift](https://github.com/openshift/microshift/issues/880) assumes a pre-existing, hardcoded, LVM Volume Group available on the VM, named `rhel`. One quick way to get that is to add an additional virtual disk to your VM (say, `/dev/vdb`) and create the volume group on top of it:
```sh
sudo lvm pvcreate /dev/vdb
sudo lvm vgcreate rhel /dev/vdb
```
#### Getting access to the MicroShift cluster from the host
Assuming that your VM is `cre.example.com` and that the `cloud-user` user already has its client configured, you just need to copy the kubeconfig file locally:
```shell
scp [email protected]:.kube/config /tmp/microshift.config
sed -i -e s/127.0.0.1/cre.example.net/ /tmp/microshift.config
export KUBECONFIG=/tmp/microshift.config
```
### Deploying the required components on MicroShift
```sh
# Install cert-manager
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.8.0/cert-manager.yaml
# Install tekton-pipelines
oc create ns tekton-pipelines
oc adm policy add-scc-to-user anyuid -z tekton-pipelines-controller
oc adm policy add-scc-to-user anyuid -z tekton-pipelines-webhook
# FIXME: ugly workaround for fixed UID and version pin due to deprecations in kube 1.25+
curl -s https://storage.googleapis.com/tekton-releases/pipeline/previous/v0.39.0/release.notags.yaml | grep -vw 65532 | oc apply -f-
# FIXME: should deploy standard ClusterTasks properly
curl -s https://api.hub.tekton.dev/v1/resource/tekton/task/openshift-client/0.2/raw | sed -e s/Task/ClusterTask/ | oc apply -f-
```
## Testing the operator against an existing cluster
1. `make install-pipelines` will deploy the Tekton pipelines' manifests
1. `make install` will deploy all our CRD
1. `make run` will run the controller locally but connected to the cluster.