Keycloak

1
<#import "/templates/guide.adoc" as tmpl>
2
<#import "/templates/kc.adoc" as kc>
3
<#import "/templates/options.adoc" as opts>
4
<#import "/templates/links.adoc" as links>
5
<#import "/templates/profile.adoc" as profile>
6

7
<@tmpl.guide
8
title="{project_name} Operator Installation"
9
priority=10
10
summary="How to install the {project_name} Operator on Kubernetes and OpenShift">
11

12
== Installing the {project_name} Operator
13
This {section} describes how to install the {project_name} Operator in a Kubernetes or OpenShift cluster.
14

15
=== Installing by using the Operator Lifecycle Manager
16

17
The recommended way to install the {project_name} Operator in Kubernetes environments is to use the Operator Lifecycle Manager (OLM).
18

19
==== Prerequisites
20
*  Make sure OLM is installed in your environment. For details, see https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/install/install.md#install-a-release[Installing OLM].
21

22
* Be sure that you have cluster-admin permission or an equivalent level of permissions granted by an administrator.
23

24
==== Using the OpenShift web console
25

26
The following procedure describes how to install the {project_name} Operator. However, for general instructions on installing Operators using OLM, see https://olm.operatorframework.io/docs/tasks/install-operator-with-olm/[Install your operator with OLM]. In the default Catalog, the Keycloak Operator is named `keycloak-operator`. Make sure to use the `fast` channel to find the operator.
27

28
Perform this procedure on an OpenShift cluster.
29

30
. Open the OpenShift Container Platform web console.
31

32
. In the left column, click *Home*, *Operators*, *OperatorHub*.
33

34
. Search for "keycloak" on the search input box.
35
+
36
image::select-operator.jpeg["Select the {project_name} Operator in the UI"]
37

38
. Select the {project_name} Operator from the list of results.
39
. Follow the instructions on the screen.
40
+
41
Make sure you are installing from the *fast* channel:
42
+
43
image::configure-operator.png["Configure {project_name} Operator"]
44

45
<@profile.ifCommunity>
46
=== Installing by using kubectl without Operator Lifecycle Manager
47

48
You can install the Operator on a vanilla Kubernetes cluster by using `kubectl` commands:
49

50
. Install the CRDs by entering the following commands:
51
+
52
[source,bash,subs="attributes+"]
53
----
54
kubectl apply -f https://raw.githubusercontent.com/keycloak/keycloak-k8s-resources/{version}/kubernetes/keycloaks.k8s.keycloak.org-v1.yml
55
kubectl apply -f https://raw.githubusercontent.com/keycloak/keycloak-k8s-resources/{version}/kubernetes/keycloakrealmimports.k8s.keycloak.org-v1.yml
56
----
57

58
. Install the {project_name} Operator deployment by entering the following command:
59
+
60
[source,bash,subs="attributes+"]
61
----
62
kubectl apply -f https://raw.githubusercontent.com/keycloak/keycloak-k8s-resources/{version}/kubernetes/kubernetes.yml
63
----
64

65
Currently the Operator watches only the namespace where the Operator is installed.
66
</@profile.ifCommunity>
67

68
</@tmpl.guide>
69