Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[KOGITO-7840] - Add validation on Workflow Metadata with admission we… #361

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@
:description: Install the operator on Kubernetes clusters
:keywords: kogito, sonataflow, workflow, serverless, operator, kubernetes, minikube, openshift, containers
// links

:openshift_operator_install_url: https://docs.openshift.com/container-platform/4.13/operators/admin/olm-adding-operators-to-cluster.html
:openshift_operator_uninstall_url: https://docs.openshift.com/container-platform/4.13/operators/admin/olm-deleting-operators-from-cluster.html
:kubernetes_operator_install_url: https://operatorhub.io/how-to-install-an-operator
:kubernetes_operator_uninstall_url: https://olm.operatorframework.io/docs/tasks/uninstall-operator/
:operatorhub_url: https://operatorhub.io/
:cert_manager_installer_url: https://github.com/cert-manager/cert-manager/releases/download/v1.12.0/cert-manager.yaml
spolti marked this conversation as resolved.
Show resolved Hide resolved
:kubebuilder_webhooks_url: https://book.kubebuilder.io/cronjob-tutorial/running.html

This guide describes how to install the {operator_name} in a Kubernetes or OpenShift cluster. The operator is in an xref:/cloud/operator/known-issues.adoc[early development stage] (community only) and has been tested on OpenShift 4.11+, Kubernetes 1.22+, and link:{minikube_url}[Minikube].

Expand Down Expand Up @@ -79,14 +80,35 @@ minikube start [...] --driver podman

=== Install

To install the {product_name} Operator, you can use the following command:
To install the {product_name} Operator, you can use one of the following methods:

==== Install with Webhooks

The Cert Manager is recommended in order to help abstract the certificate configuration, If, for some reason, it cannot be installed, you must verify that the certificates needed by the Webhooks are correctly configured or not. You can find more information link:{kubebuilder_webhooks_url}[here].

.Install Cert Manager Operator
spolti marked this conversation as resolved.
Show resolved Hide resolved
[source,shell,subs="attributes+"]
----
kubectl apply -f {cert_manager_installer_url}
----

.Install {product_name} Operator on Kubernetes
[source,shell,subs="attributes+"]
----
kubectl create -f https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/{operator_version}/operator.yaml
----

==== Install without Webhooks

The webhooks are enabled by default. If you want to disable them, you can install the operator using the `operator-no-webhooks.yaml` and skip the `Install Cert Manager Operator` step.

.Install {product_name} Operator on Kubernetes with no Webhooks
[source,shell]
----
kubectl create -f https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/{operator_version}/operator-no-webhooks.yaml
----


You can follow the deployment of the {product_name} Operator:

.Watch the {product_name} Operator pod
Expand Down Expand Up @@ -155,6 +177,12 @@ kubectl delete -f https://raw.githubusercontent.com/kiegroup/kogito-serverless-o
If you're running a snapshot version, use this URL instead `https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/main/operator.yaml`.
====

.Uninstalling Cert Manager Operator
[source,shell,subs="attributes+"]
----
kubectl delete -f {cert_manager_installer_url}
----

== Additional resources

* xref:cloud/operator/known-issues.adoc[]
Expand Down