Google Git
Sign in
apache / incubator-kie-kogito-serverless-operator / da1a9605b9f9cc69332598af9813749b696a4a3f
commitda1a9605b9f9cc69332598af9813749b696a4a3f[log] [tgz]
authorspolti <fspolti@redhat.com>Mon Oct 24 11:25:17 2022 -0300
committerspolti <fspolti@redhat.com>Mon Oct 24 11:36:09 2022 -0300
treeeb9cba9621437ff3122f7efea89624ad7e8e4c32
parentd6118b3012d0bb946202c513c3d1908956424d1f [diff]
update pr job to re-trigger when PR is updated
1 file changed
tree: eb9cba9621437ff3122f7efea89624ad7e8e4c32
  1. .github/
  2. api/
  3. builder/
  4. bundle/
  5. config/
  6. constants/
  7. controllers/
  8. converters/
  9. hack/
  10. test/
  11. utils/
  12. .gitignore
  13. CONTRIBUTING.md
  14. Dockerfile
  15. go.mod
  16. go.sum
  17. LICENSE
  18. main.go
  19. Makefile
  20. operator.yaml
  21. PROJECT
  22. README.md
README.md

Kogito Serverless Operator

The Kogito Serverless Operator is built in order to help the Kogito Serverless users to build and deploy easily on Kubernetes/Knative/OpenShift a service based on Kogito that it will be able to execute a workflow.

The CustomResources defined and managed by this operator are the following:

  • Workflow
  • Platform
  • Build`

Getting Started

You’ll need a Kubernetes cluster to run against. You can use

to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Running on the cluster

  1. Install Instances of Custom Resources:
kubectl apply -f config/samples/
  1. Build and push your image to the location specified by IMG:
make docker-build docker-push IMG=<some-registry>/kogito-serverless-operator:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/kogito-serverless-operator:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Test the Greeting workflow on Minikube

A good starting point to check that everything is working well, it is the Greeting workflow.

Follow these steps to create a container that you can than deploy as a Service on Kubernetes or KNative.

  1. Start Minikube
minikube start --cpus 4 --memory 4096 --addons registry --insecure-registry "10.0.0.0/24"
  1. Create a namespace for the building phase
kubectl create namespace kogito-builder
  1. Create a secret
kubectl create secret docker-registry regcred --docker-server=<registry_url> --docker-username=<registry_username> --docker-password=<registry_password> --docker-email=<registry_email> -n kogito-builder
  1. Build and push your image to the location specified by IMG:
make container-build container-push IMG=<some-registry>/kogito-serverless-operator:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/kogito-serverless-operator:tag
  1. Create a dedicated Namespace for the test:
kubectl create namespace greeting-workflow
  1. Install Instances of Custom Resources:
kubectl apply -f config/samples/sw.kogito.kie.org__v08_kogitoserverlessworkflow.yaml -n greeting-workflow
  1. Default configuration

A configmap called kogito-serverless-operator-builder-config will be created under the kogito-serverless-operator-system namespace when the Operator will be installed, and it contains:

  • DEFAULT_BUILDER_RESOURCE = kogito_builder_dockerfile.yaml
  • DEFAULT_WORKFLOW_DEXTENSION = .sw.json
  • DEFAULT_KANIKO_SECRET_DEFAULT = regcred
  • DEFAULT_REGISTRY_REPO = quay.io/kiegroup
  • kogito_builder_dockerfile.yaml = dockerfile content

For the local development the DEFAULT_REGISTRY_REPO must be changed

Test It Out

  1. Install the CRDs into the cluster:
make install
  1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run

NOTE: You can also run this in one step by running: make install run

NOTE: Run make help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

Development and Contributions

Contributing is easy, just take a look at our contributors'guide.

License

Copyright 2022.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.