hawtio/operator

Hawtio Operator

Hawtio Operator是一个基于Operator SDK的Kubernetes Operator，用于操作和管理https://github.com/hawtio/hawtio-online%E3%80%82

升级

升级Hawtio Operator安装时，请参考升级指南。

资源定义

Hawtio自定义资源定义（CRD）定义了Operator用于配置Hawtio Online实例的资源，例如：

yaml
apiVersion: hawt.io/v1alpha1
kind: Hawtio
metadata:
  name: hawtio-online
spec:
  # 部署类型，可选"cluster"或"namespace"：
  # - cluster：Hawtio能够发现和管理经过身份验证的用户有权访问的所有命名空间中的应用
  # - namespace：Hawtio仅能发现和管理部署所在命名空间内的应用
  type: cluster
  # 期望的副本数
  replicas: 1
  # 暴露Hawtio服务的路由的边缘主机名。若未指定，将自动生成，格式为：
  #   <name>[-<namespace>].<suffix>
  # 其中<suffix>是集群配置的默认路由子域。
  # 注意：若清空该字段，Operator将重新创建路由以重新生成主机名。
  routeHostName: hawtio-online.hawt.io
  # 版本（默认"latest"）
  version: latest
  # 部署所需的计算资源
  resources:
    limits:
      cpu: "1"
      memory: 100Mi
    requests:
      cpu: 200m
      memory: 32Mi

核心功能

Operator支持以下功能场景：

创建

• 创建Deployment、ConfigMap、Service和Route资源
• 在namespace部署模式下创建作为OAuth客户端的服务账户
• 在cluster部署模式下创建OAuth客户端
• 创建包含用于认证Jolokia端点的客户端证书的Secret

更新

• 根据version字段协调Deployment容器镜像
• 根据routeHostName字段协调Route主机名
• 支持清空routeHostName字段（重新创建Route以生成主机名）
• 将replicas字段协调到Deployment
• 将resources字段协调到Deployment
• 支持在namespace和cluster部署类型之间切换
• 在cluster部署模式下从OAuth客户端移除先前的Route主机
• 在ConfigMap变更时触发部署滚动更新

删除

• 移除Deployment、ConfigMap、Service和Route资源
• 在namespace部署模式下移除作为OAuth客户端的服务账户
• 在cluster部署模式下从OAuth客户端的授权重定向URI中移除路由URL
• 移除生成的客户端证书Secret

部署

要创建Operator所需的资源（如CRD、服务账户、角色、角色绑定、部署等），运行以下命令：

console
$ make deploy

上述命令必须由特权用户执行，因为创建自定义资源定义和集群角色需要cluster-admin权限。

使用测试

要创建和操作Hawtio资源，可运行以下命令：

console
# 创建Hawtio
$ kubectl apply -f deploy/crs/hawtio_v1alpha1_hawtio_cr.yaml
hawtio.hawt.io/hawtio-online created

# 获取Hawtio信息
$ kubectl get hawtio
NAME             AGE   URL                                           IMAGE
hawtio-online   16s   https://hawtio-online.192.168.64.38.nip.io   docker.io/hawtio/online:latest

# 扩展Hawtio
$ kubectl scale hawtio hawtio-online --replicas=3
hawtio.hawt.io/hawtio-online scaled

# 编辑Hawtio资源
$ kubectl patch hawtio hawtio-online --type='merge' -p '{"spec":{"routeHostName":"hawtio.192.168.64.38.nip.io"}}'
hawtio.hawt.io/hawtio-online patched
# 检查状态是否相应更新
$ kubectl get hawtio
NAME             AGE   URL                                   IMAGE
hawtio-online   1m    https://hawtio.192.168.64.38.nip.io   docker.io/hawtio/online:latest

# 编辑Hawtio配置
$ kubectl edit configmap hawtio-online
configmap/hawtio-online edited
# 观察配置变更触发的部署滚动更新
$ kubectl rollout status deployment.v1.apps/hawtio-online
Waiting for deployment "hawtio-online" rollout to finish: 1 out of 3 new replicas have been updated...
Waiting for deployment "hawtio-online" rollout to finish: 2 out of 3 new replicas have been updated...
Waiting for deployment "hawtio-online" rollout to finish: 1 old replicas are pending termination...
deployment "hawtio-online" successfully rolled out

# 更改Hawtio版本
$ kubectl patch hawtio hawtio-online --type='merge' -p '{"spec":{"version":"1.7.1"}}'
hawtio.hawt.io/hawtio-online patched
# 检查状态是否相应更新
$ kubectl get hawtio
NAME             AGE   URL                                   IMAGE
hawtio-online   1m    https://hawtio.192.168.64.38.nip.io   docker.io/hawtio/online:1.7.1
# 观察版本变更触发的部署滚动更新
$ kubectl rollout status deployment.v1.apps/hawtio-online
...
deployment "hawtio-online" successfully rolled out

# 删除Hawtio
$ kubectl delete hawtio hawtio-online
hawtio.hawt.io "hawtio-online" deleted

开发指南

要在本地构建和测试Operator，运行以下命令：

console
$ make build

本地获取hawtio-operator后，可按如下方式运行Operator：

console
$ WATCH_NAMESPACE=<namespace> ./hawtio-operator

其中WATCH_NAMESPACE是必填环境变量。设置WATCH_NAMESPACE=（空值）将以cluster类型运行Operator。

还可通过IMAGE_REPOSITORY环境变量更改Hawtio Online实例的Docker镜像仓库，默认仓库为docker.io/hawtio/online。例如：

console
$ WATCH_NAMESPACE=hawtio IMAGE_REPOSITORY=docker.io/fuse/hawtio-online ./hawtio-operator