使用 KubeEye 為你的 K8s 叢集安全保駕護航

KubeSphere發表於2022-04-22
作者:KaliArch(薛磊),某Cloud MSP服務商產品負責人,熟悉企業級高可用/高併發架構,包括混合雲架構、異地災,熟練企業DevOPS改造優化,熟悉Shell/Python/Go等開發語言,熟悉Kubernetes、 Docker、 雲原生、微服務架構等。

前言

KubeEye 是一款 Kubernetes 安全及配置問題檢測工具,針對部署在 K8s 叢集中的業務應用進行配置檢測使用 OPA,針對叢集部署的 Node 使用Node-Problem-Detector進行檢測,同時除了系統內建有根據大多數業界常見場景的預定義規則,還支援使用者自定義規則來進行叢集檢測。

架構

KubeEye 通過呼叫 Kubernetes API,通過匹配資源中的關鍵字和容器語法的規則匹配來獲取叢集診斷資料,詳見架構圖。

其中針對 Node 節點的檢測,需要在被檢測 Node 主機上安裝。

特點

特性

  • KubeEye 根據行業最佳實踐審查你的工作負載 YAML 規範,幫助你使你的叢集穩定。
  • KubeEye 可以發現你的叢集控制平面的問題,包括 kube-apiserver/kube-controller-manager/etcd 等。
  • KubeEye 可以幫助你檢測各種節點問題,包括記憶體/CPU/磁碟壓力,意外的核心錯誤日誌等。

檢查項

是/否檢查項描述級別
PrivilegeEscalationAllowed允許特權升級緊急
CanImpersonateUserrole/clusterrole 有偽裝成其他使用者許可權警告
CanDeleteResourcesrole/clusterrole 有刪除 Kubernetes 資源許可權警告
CanModifyWorkloadsrole/clusterrole 有修改 Kubernetes 資源許可權警告
NoCPULimits資源沒有設定 CPU 使用限制緊急
NoCPURequests資源沒有設定預留 CPU緊急
HighRiskCapabilities開啟了高危功能,例如 ALL/SYS_ADMIN/NET_ADMIN緊急
HostIPCAllowed開啟了主機 IPC緊急
HostNetworkAllowed開啟了主機網路緊急
HostPIDAllowed開啟了主機PID緊急
HostPortAllowed開啟了主機埠緊急
ImagePullPolicyNotAlways映象拉取策略不是 always警告
ImageTagIsLatest映象標籤是 latest警告
ImageTagMiss映象沒有標籤緊急
InsecureCapabilities開啟了不安全的功能,例如 KILL/SYS_CHROOT/CHOWN警告
NoLivenessProbe沒有設定存活狀態檢查警告
NoMemoryLimits資源沒有設定記憶體使用限制緊急
NoMemoryRequests資源沒有設定預留記憶體緊急
NoPriorityClassName沒有設定資源排程優先順序通知
PrivilegedAllowed以特權模式執行資源緊急
NoReadinessProbe沒有設定就緒狀態檢查警告
NotReadOnlyRootFilesystem沒有設定根檔案系統為只讀警告
NotRunAsNonRoot沒有設定禁止以 root 使用者啟動程式警告
CertificateExpiredPeriod將檢查 API Server 證照的到期日期少於30天緊急
EventAudit事件檢查警告
NodeStatus節點狀態檢查警告
DockerStatusDocker 狀態檢查警告
KubeletStatusKubelet 狀態檢查警告

部署

KubeEye 本身使用 Golang 編寫,可使用編譯好的二進位制可執行檔案進行相關元件安裝。

安裝

二進位制安裝

wget https://github.com/kubesphere/kubeeye/releases/download/v0.3.0/kubeeye-0.3.0-linux-amd64.tar.gz
tar -zxvf kubeeye-0.3.0-linux-amd64.tar.gz
mv kubeeye /usr/bin/

原始碼編譯安裝

git clone https://github.com/kubesphere/kubeeye.git
cd kubeeye 
make installke

安裝 NPD

針對叢集 Node 主機的檢測,kubeEye 採用Node-problem-Detector ,需要在 Node 主機節點進行安裝,KubeEye 封裝安裝命令,可以進行一鍵安裝。

⚠️注意:這將在你的叢集上安裝 NPD,只有當你想要詳細的節點報告時才需要。

[root@VM-48-7-centos ~]# kubeeye install -e npd
kube-system      ConfigMap      node-problem-detector-config      created
kube-system      DaemonSet      node-problem-detector      created

其主要在 kube-system 名稱空間建立 node-problem-detector-config 的 ConfigMap 和 node-problem-detector DaemonSet。

叢集中執行 KubeEye

kubeEye 除了可以一次性使用工具執行,同時 kubeEye 也是一個 Operator,可以執行在叢集內部,進行長久的持續對叢集進行檢測。

Kubernetes 中部署 KubeEye

kubectl apply -f https://raw.githubusercontent.com/kubesphere/kubeeye/main/deploy/kubeeye.yaml
kubectl apply -f https://raw.githubusercontent.com/kubesphere/kubeeye/main/deploy/kubeeye_insights.yaml

檢視 KubeEye 巡檢結果

$ kubectl get clusterinsight -o yaml

apiVersion: v1
items:
- apiVersion: kubeeye.kubesphere.io/v1alpha1
  kind: ClusterInsight
  metadata:
    name: clusterinsight-sample
    namespace: default
  spec:
    auditPeriod: 24h
  status:
    auditResults:
      auditResults:
      - resourcesType: Node
        resultInfos:
        - namespace: ""
          resourceInfos:
          - items:
            - level: waring
              message: KubeletHasNoSufficientMemory
              reason: kubelet has no sufficient memory available
            - level: waring
              message: KubeletHasNoSufficientPID
              reason: kubelet has no sufficient PID available
            - level: waring
              message: KubeletHasDiskPressure
              reason: kubelet has disk pressure
            name: kubeeyeNode

測試

命令選項

[root@VM-48-7-centos ~]# kubeeye -h
KubeEye finds various problems on Kubernetes cluster.

Usage:
  ke [command]

Available Commands:
  audit       audit resources from the cluster
  completion  generate the autocompletion script for the specified shell
  help        Help about any command
  install     A brief description of your command
  uninstall   A brief description of your command

Flags:
  -f, --config string         Specify the path of kubeconfig.
  -h, --help                  help for ke
      --kubeconfig string     Paths to a kubeconfig. Only required if out-of-cluster.
      --master --kubeconfig   (Deprecated: switch to --kubeconfig) The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster.

可以看到 KubeEye 目前主要支援兩個命令,一個為 install package 例如 NPD,另外一個執行 audit,對叢集應用進行配置掃描。

audit

[root@VM-48-7-centos ~]# kubeeye audit
KIND         NAMESPACE         NAME                                           MESSAGE
Deployment   dddd              jenkins-1644220286                             [NoCPULimits ImagePullPolicyNotAlways NoMemoryLimits NoPriorityClassName NotReadOnlyRootFilesystem NotRunAsNonRoot]
Deployment   jenkins           jenkins-1644220286                             [NoCPULimits ImagePullPolicyNotAlways NoMemoryLimits NoPriorityClassName NotReadOnlyRootFilesystem NotRunAsNonRoot]
Deployment   smartkm-api-k8s   velero                                         [ImageTagIsLatest NoLivenessProbe NoPriorityClassName NotReadOnlyRootFilesystem NoReadinessProbe NotRunAsNonRoot]
DaemonSet    smartkm-api-k8s   restic                                         [ImageTagIsLatest NoLivenessProbe NoPriorityClassName NotReadOnlyRootFilesystem NoReadinessProbe NotRunAsNonRoot]
Node                           minikube                                       [KernelHasNoDeadlock FilesystemIsNotReadOnly KubeletHasSufficientMemory KubeletHasNoDiskPressure KubeletHasSufficientPID]
Event        kube-system       node-problem-detector-dmsws.16d844532f662318   [Failed to pull image "k8s.gcr.io/node-problem-detector/node-problem-detector:v0.8.7": rpc error: code = Unknown desc = Error response from daemon: Get https://k8s.gcr.io/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)]
Event        kube-system       node-problem-detector-dmsws.16d844532f66703e   [Error: ErrImagePull]
Event        kube-system       node-problem-detector-dmsws.16d84453351b8b19   [Error: ImagePullBackOff]    

新增自定義檢查規則

我們利用命令檢視預定義 OPA 檢查規則。

kubectl get cm -n kube-system node-problem-detector-config -oyaml

同時也可以根據自己業務建立自定義檢查規則。

  • 建立 OPA 規則存放目錄
mkdir opa
  • 新增自定義 OPA 規則檔案
注意:為檢查工作負載設定的 OPA 規則, Package 名稱必須是 kubeeye_workloads_rego 為檢查 RBAC 設定的 OPA 規則, Package 名稱必須是 kubeeye_RBAC_rego 為檢查節點設定的 OPA 規則, Package 名稱必須是 kubeeye_nodes_rego
  • 以下為檢查映象倉庫地址規則,儲存以下規則到規則檔案 imageRegistryRule.rego
package kubeeye_workloads_rego

deny[msg] {
    resource := input
    type := resource.Object.kind
    resourcename := resource.Object.metadata.name
    resourcenamespace := resource.Object.metadata.namespace
    workloadsType := {"Deployment","ReplicaSet","DaemonSet","StatefulSet","Job"}
    workloadsType[type]

    not workloadsImageRegistryRule(resource)

    msg := {
        "Name": sprintf("%v", [resourcename]),
        "Namespace": sprintf("%v", [resourcenamespace]),
        "Type": sprintf("%v", [type]),
        "Message": "ImageRegistryNotmyregistry"
    }
}

workloadsImageRegistryRule(resource) {
    regex.match("^myregistry.public.kubesphere/basic/.+", resource.Object.spec.template.spec.containers[_].image)
}
  • 使用額外的規則執行 KubeEye
提示:KubeEye 將讀取指定目錄下所有 .rego 結尾的檔案
kubeeye audit -p ./opa

問題排查

  • NPD 安裝異常,預設使用 k8s.gcr.io,如果安裝伺服器無法連通公網可使用我的映象倉庫:1832990/node-problem-detector:v0.8.7。
  • kubEye 安裝使用預設使用主機 $HOME/.kube/config 檔案,如果不存在 K8s config 檔案,則無法正常執行。

參考連結

相關文章