epamedp/keycloak-operator

Keycloak Operator

本文介绍Keycloak Operator的基本信息、安装流程、快速入门及本地开发指南。

概述

Keycloak Operator是KubeRocketCI的操作器，负责配置现有的Keycloak实例，可在OpenShift和Kubernetes上运行。

注意： 操作器是平台无关的，因此部署说明是统一的。

前提条件

1. Linux机器或Windows Subsystem for Linux实例，已安装Helm 3；
2. 集群管理员权限。

使用Helm Chart安装

安装Keycloak Operator请遵循以下步骤：

1. 运行以下命令为本地客户端添加Helm EPAMEDP Charts仓库：

   bash
   helm repo add epamedp https://epam.github.io/edp-helm-charts/stable
   

2. 选择可用的Helm chart版本：

   bash
   helm search repo epamedp/keycloak-operator -l
   NAME                           CHART VERSION   APP VERSION     DESCRIPTION
   epamedp/keycloak-operator      1.24.0          1.24.0          A Helm chart for EDP Keycloak Operator
   epamedp/keycloak-operator      1.23.0          1.23.0          A Helm chart for EDP Keycloak Operator
   

   注意： 强烈建议使用最新稳定版本。

3. 完整的chart参数可在deploy-templates/README.md中查看。

4. 使用helm命令在命名空间中安装操作器，安装命令示例如下：

   bash
   helm install keycloak-operator epamedp/keycloak-operator --version <chart_version> --namespace <edp-project> --set name=keycloak-operator
   

5. 检查命名空间中是否存在状态为运行中的操作器Deployment。

快速入门

1. 在Keycloak的Master领域中创建用户，并分配create-realm角色。

2. 将新创建的用户凭据插入Kubernetes Secret：

   yaml
   apiVersion: v1
   kind: Secret
   metadata:
     name:  keycloak-access
   type: Opaque
   data:
     username: dXNlcg==   # "user"的base64编码值
     password: cGFzcw==   # "pass"的base64编码值
   

3. 创建kind: Keycloak自定义资源，包含Keycloak实例URL和上一步创建的secret：

   yaml
   apiVersion: v1.edp.epam.com/v1
   kind: Keycloak
   metadata:
     name: keycloak-sample
   spec:
     secret: keycloak-access             # Secret名称
     url: https://keycloak.example.com   # Keycloak URL
   

   等待.status字段出现status.connected: true。

4. 使用自定义资源创建Keycloak领域和组：

   yaml
   apiVersion: v1.edp.epam.com/v1
   kind: KeycloakRealm
   metadata:
    name: keycloakrealm-sample
   spec:
    realmName: realm-sample
    keycloakRef:
      name: keycloak-sample
      kind: Keycloak
   

   yaml
   apiVersion: v1.edp.epam.com/v1
   kind: KeycloakRealmGroup
   metadata:
     name: argocd-admins
   spec:
     name: ArgoCDAdmins
     realmRef:
       name: keycloakrealm-sample
       kind: KeycloakRealm
   

   更多示例请查看可用自定义资源和CR模板文件夹。

防止操作器删除资源

要防止操作器从Keycloak中删除资源，可向资源添加edp.epam.com/preserve-resources-on-deletion: "true"注解：

yaml
apiVersion: v1.edp.epam.com/v1
kind: KeycloakRealm
metadata:
 name: keycloakrealm-sample
 annotations:
   edp.epam.com/preserve-resources-on-deletion: "true"
spec:
 realmName: realm-sample
 keycloakRef:
    name: keycloak-sample
    kind: Keycloak

本地开发

要开发操作器，请先设置本地环境，并参考https://epam.github.io/edp-install/developer-guide/local-development/%E9%A1%B5%E9%9D%A2%E3%80%82

开发版本也可从https://epam.github.io/edp-helm-charts/snapshot/%E8%8E%B7%E5%8F%96%E3%80%82

相关文章

• 安装KubeRocketCI