newrelic/kubernetes-operator

New Relic Kubernetes Operator

镜像概述和主要用途

New Relic Kubernetes Operator是一个Kubernetes Operator，用于从Kubernetes配置中管理New Relic资源。通过https://github.com/newrelic/newrelic-kubernetes-operator/blob/master/examples/example.yaml#L2%E7%AE%A1%E7%90%86New Relic资源的方式，与管理内置Kubernetes对象的方式一致。

核心功能和特性

目前，该Operator支持管理以下资源：

• 告警策略（Alert Policies）
• NRQL告警条件（NRQL Alert Conditions）
• APM、浏览器和移动应用的告警条件（Alert Conditions for APM, Browser and mobile）

使用场景和适用范围

适用于需要在Kubernetes环境中集中管理New Relic监控配置的用户，特别是希望通过Kubernetes原生工具（如kubectl）进行配置管理、版本控制和自动化部署的场景。

详细使用方法和配置说明

快速启动

注意： 以下快速启动说明不需要克隆代码仓库。

使用kind在本地Docker容器中运行Kubernetes

1. 安装docker、kubectl、kustomize和kind

   bash
   brew cask install docker
   brew install kubernetes-cli kustomize kind
   

2. 使用kind创建测试集群

   bash
   kind create cluster --name newrelic
   kubectl cluster-info
   

3. 安装cert-manager

   bash
   kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v0.15.0/cert-manager.yaml
   

   注意： 此步骤需要1-2分钟完成，请等待一分钟后再进行下一步。

   可通过以下命令确认cert-manager是否运行：kubectl rollout status deployment -n cert-manager cert-manager-webhook

4. 在测试集群中安装Operator

   bash
   kustomize build github.com/newrelic/newrelic-kubernetes-operator/configs/default | kubectl apply -f -
   

   注意： 这将在kubectl当前配置的Kubernetes集群上安装Operator。

使用自定义容器

如果需要使用自定义容器部署Operator，可以通过kustomize.yaml文件覆盖镜像名称。

1. 创建新的kustomize.yaml文件

   yaml
   apiVersion: kustomize.config.k8s.io/v1beta1
   kind: Kustomization
   namespace: newrelic-kubernetes-operator-system
   resources:
     - github.com/newrelic/newrelic-kubernetes-operator/configs/default
   images:
     - name: newrelic/k8s-operator:snapshot
       newName: <自定义镜像名称>
       newTag: <自定义标签>
   

2. 应用该文件：

   bash
   kustomize build . | kubectl apply -f -
   

使用Operator配置New Relic资源

完成快速启动后，即可通过New Relic Kubernetes对象配置New Relic资源。

创建包含NRQL告警条件的New Relic告警策略

1. 使用以下示例策略配置文件。需要将api_key字段更新为New Relic个人API密钥。

   examples/example_policy.yaml

   yaml
   apiVersion: nr.k8s.newrelic.com/v1
   kind: Policy
   metadata:
     name: my-policy
   spec:
     # 在此处添加API密钥
     api_key: <你的New Relic个人API密钥>
     name: k8s创建的策略
     incident_preference: "PER_POLICY"
     region: "us"
     conditions:
       - spec:
           nrql:
             query: "SELECT count(*) FROM Transactions"
             since_value: "10"
           enabled: true
           terms:
             - threshold: "75.0"
               time_function: "all"
               duration: "5"
               priority: "critical"
               operator: "above"
           name: "K8s生成的告警条件"
       - spec:
           type: "apm_app_metric"
           enabled: true
           metric: "apdex"
           condition_scope: application
           entities:
             - "5950260"
           terms:
             - threshold: "0.9"
               time_function: "all"
               duration: "30"
               priority: "critical"
               operator: "above"
           name: "K8s生成的APM告警条件2"
   

   添加API密钥后，应用到本地集群：

   bash
   kubectl apply -f examples/example_policy.yaml
   

   注意： 也可以使用Kubernetes Secret提供API密钥。我们提供了示例Secret配置文件，使用时需将api_key替换为api_key_secret。

2. 使用以下命令查看配置的策略：

   bash
   kubectl describe policies.nr.k8s.newrelic.com
   

   注意： 你也应该能在New Relic账户中看到新创建的策略。

Operator将通过kubectl apply -f <文件名>应用配置文件，根据需要创建和更新告警策略及NRQL告警条件。

创建NRQL告警条件并添加到现有告警策略

1. 使用以下示例NRQL告警条件配置文件。需要将api_key字段更新为New Relic个人API密钥。

   examples/example_nrql_alert_condition.yaml

   yaml
   apiVersion: nr.k8s.newrelic.com/v1
   kind: NrqlAlertCondition
   metadata:
     name: my-alert-condition
   spec:
     # 在此处添加API密钥
     api_key: <你的New Relic个人API密钥>
     name: "K8s生成的告警条件"
     nrql:
       # 注意：这只是示例。
       # 你需要使用更具体的参数来匹配相关Kubernetes对象的查询。
       query: "SELECT count(*) FROM Transactions"
       since_value: "10"
     enabled: true
     terms:
       - threshold: "75.0"
         time_function: "all"
         duration: "5"
         priority: "critical"
         operator: "above"
     existing_policy_id: 26458245 # 注意：必须匹配你账户中现有的策略ID
     region: "us"
   

卸载Operator

卸载Operator的操作与安装相反，即通过kustomize构建Kubernetes资源文件并运行kubectl delete：

bash
kustomize build github.com/newrelic/newrelic-kubernetes-operator/configs/default | kubectl delete -f -

开发

本节将帮助你正确设置Operator的开发环境。

环境要求

• Go v1.13+
• Docker（启用Kubernetes）
• kubectl
• kustomize
• kubebuilder

代码开发

1. 克隆代码仓库

   bash
   git clone git@github.com:newrelic/newrelic-kubernetes-operator.git
   

2. 按照对应操作系统的说明安装kubebuilder。此安装还会包含测试所需的etcd和kube-apiserver。

   注意： 不要使用brew安装kubebuilder。Homebrew的kubebuilder包不会提供运行测试所需的所有依赖。

3. 运行测试套件（使用http://onsi.github.io/ginkgo/%E6%B5%8B%E8%AF%95%E6%A1%86%E6%9E%B6%EF%BC%89%E3%80%82%E4%BD%BF%E7%94%A8%60make%60%E7%9B%AE%E6%A0%87%E6%98%AF%E5%BC%80%E5%A7%8B%E6%B5%8B%E8%AF%95%E7%9A%84%E6%9C%80%E5%BF%AB%E6%96%B9%E5%BC%8F%EF%BC%9A

   • 使用make运行测试

     bash
     make test              # 运行所有测试
     make test-unit         # 仅运行单元测试
     make test-integration  # 仅运行集成测试
     

   • 代码 lint

     bash
     make lint
     

4. 执行快速启动部分的步骤，完成初始必要设置，并通过kubectl apply应用Operator配置。

5. 确认配置已部署到本地Kubernetes集群（使用kind创建的集群）：

   • 查看命名空间，应包含newrelic-kubernetes-operator-system

     bash
     kubectl get namespaces
     

   • 查看newrelic-kubernetes-operator-system命名空间中的节点

     bash
     kubectl get nodes -n newrelic-kubernetes-operator-system
     

     应看到类似以下输出：

     NAME                     STATUS   ROLES    AGE    VERSION
     newrelic-control-plane   Ready    master   163m   v1.18.2
     

6. 后续步骤：

   • 创建New Relic告警策略
   • 创建New Relic NRQL告警条件

常用命令

bash
# 描述当前配置的策略
kubectl describe policies.nr.k8s.newrelic.com

# 描述当前配置的告警条件
kubectl describe nrqlalertconditions.nr.k8s.newrelic.com

# 获取New Relic Operator使用的节点
kubectl get nodes -n newrelic-kubernetes-operator-system

# 描述New Relic Operator使用的节点
kubectl describe node <节点名称>

# 跟踪Operator的manager容器日志（开发时有用）
# 使用上述`describe node`命令定位manager控制器
kubectl logs -f -n newrelic-kubernetes-operator-system -c manager newrelic-kubernetes-operator-controller-manager-<哈希值>