aerogearcatalog/metrics-apb

Metrics APB

![License]([***]

测试

若需测试本仓库的变更，可直接运行apb test命令。测试流程如下：

1. 构建APB
2. 在当前目标OpenShift实例中创建项目
3. 执行provision角色
4. 执行test-provision角色，验证以下内容：
   • Grafana和Prometheus路由是否可访问
   • OpenShift认证代理服务器是否返回成功响应
5. 执行deprovision角色
6. 执行deprovision-test角色，验证所有对象（路由、Pod、服务）是否已成功销毁

若测试成功，控制台将输出Pod phase Succeeded without returning test results信息。

关于APB测试的更多信息，请查看https://github.com/ansibleplaybookbundle/ansible-playbook-bundle/blob/master/docs/getting_started.md#test%E3%80%82

服务自动发现原理

请参考此处的内联注释，以及Prometheus的https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus-kubernetes.yml%E3%80%82

如何在部署服务时添加新仪表盘

Grafana会自动加载grafana-dashboards-configmap中的所有JSON格式仪表盘文件。本节描述如何从APB内部向该ConfigMap添加新仪表盘，部署服务的APB也应负责添加仪表盘。

已创建一个可复用的Ansible角色，用于将JSON文件添加到ConfigMap：https://github.com/aerogear/oc-patch-file-to-configmap-role%E3%80%82%E4%BB%A5%E4%B8%8B%E9%83%A8%E5%88%86%E6%BC%94%E7%A4%BA%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8%E8%AF%A5%E8%A7%92%E8%89%B2%E3%80%82

requirements.yml

在playbooks目录下创建requirements.yml文件：

yaml
- src: https://github.com/aerogear/oc-patch-file-to-configmap-role
  version: master
  name: oc-patch-file-to-configmap

该文件定义oc-patch-file-to-configmap角色为依赖项。

修改Dockerfile

下一步是修改默认的Dockerfile。默认APB Dockerfile通常包含以下命令：

COPY playbooks /opt/apb/actions
COPY roles /opt/ansible/roles
COPY vars /opt/ansible/vars
RUN chmod -R g=u /opt/{ansible,apb}
USER apb

在RUN chmod -R g=u /opt/{ansible,apb}命令之前添加以下行：

RUN ansible-galaxy install -r /opt/apb/actions/requirements.yml -p /opt/ansible/roles

该命令使用ansible-galaxy CLI工具将requirements.yml中的依赖项安装到指定角色目录。这意味着在运行apb build时，oc-patch-file-to-configmap角色会被安装到APB镜像中。

使用方法

建议直接在部署服务的角色（如provision-keycloak-apb）中使用oc-patch-file-to-configmap角色。角色目录结构应类似如下：

bash
├── defaults
│   └── main.yml
├── files
│   ├── ... # 角色特定文件
├── tasks
│   └── main.yml
└── templates
    ├── ... # 角色特定模板

首先，将仪表盘JSON文件放置在files目录下，例如files/keycloak-dashboard.json。

接下来，在defaults/main.yml中添加以下变量：

yaml
# 仪表盘配置
dashboards_configmap: grafana-dashboards-configmap # 该值不应修改
dashboard_filename: keycloak-dashboard.json # 文件在ConfigMap中的名称
dashboard_file_contents: "{{ lookup('file','../files/keycloak-dashboard.json') }}" # 仪表盘文件内容

注意：dashboard_filename是文件在ConfigMap中的名称，不应与其他服务的文件名冲突。若ConfigMap中已存在同名文件，将被覆盖。

最后，在tasks/main.yml中添加以下内容：

yaml
- include_role:
    name: oc-patch-file-to-configmap
  vars:
    file_contents: "{{ dashboard_file_contents }}"
    filename: "{{ dashboard_filename }}"
    configmap: "{{ dashboards_configmap }}"
    namespace: "{{ namespace }}"

这将指示Ansible执行该角色，并传入相应变量。

注意：若仍不清楚该角色的使用方法，可参考https://github.com/aerogearcatalog/keycloak-apb%E4%B8%AD%E7%9A%84%E4%BD%BF%E7%94%A8%E7%A4%BA%E4%BE%8B%E3%80%82