Skip to content

Commit

Permalink
Merge pull request #16 from ruivieira/k8s
Browse files Browse the repository at this point in the history
Add vanilla Kubernetes installation notes
  • Loading branch information
ruivieira authored Feb 12, 2024
2 parents d13eeac + 2c27d4a commit a78a4b5
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion docs/modules/ROOT/pages/trustyai-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,41 @@

The TrustyAI Kubernetes Operator aims at simplifying the deployment and management of the xref:trustyai-service.adoc[TrustyAI service] on Kubernetes and OpenShift clusters by watching for custom resources of kind `TrustyAIService` in the `trustyai.opendatahub.io` API group and manages deployments, services, and optionally, routes and `ServiceMonitors` corresponding to these resources.

The operator ensures the service is properly configured, is discoverable by Prometheus for metrics scraping (on both Kubernetes and OpenShift), and is accessible via a `Route` on OpenShift.
The operator ensures the service is properly configured, is discoverable by Prometheus for metrics scraping (on both Kubernetes and OpenShift), and is accessible via a `Route` on OpenShift.

== Installation

=== OpenShift installation

Please refer to the xref:installing-opendatahub.adoc[] page.

=== Kubernetes installation

[NOTE]
====
TrustyAI's operator is designed and supported for OpenShift.
Although _not officially supported_, it is however possible to install it on Kubernetes with a few modifications.
====

If installing the TrustyAI operator in Kubernetes, you will need to create the secrets necessary for each TrustyAI's service authenticated `Service`.

OpenShift will automatically create the required secrets for you, whereas in Kubernetes you will need to create them manually.

Assuming you have the TrustyAI operator already installed and wanted to install a TrustyAI service, called `$TRUSTYAI_SERVICE` in an already existing namespace `$NAMESPACE`, you'll need to:

. (Optional) If you don't have the certificate and key in a file, you can create them (just an example):
+
[source,shell]
----
openssl req -x509 -newkey rsa:4096 -keyout trustyai.pem -out trustyai.pem -days 365 -nodes -subj "/CN=example.com"
----
+
. Create the secret in the destination namespace:
+
[source,shell]
----
kubectl create secret tls ${TRUSTYAI_SERVICE}-tls --cert=trustyai.pem --key=trustyai.pem --namespace $NAMESPACE
----

The TrustyAI service can now be created as usual.

0 comments on commit a78a4b5

Please sign in to comment.