監控 AlloyDB Omni Kubernetes 運算子自訂資源

本頁說明如何使用 kube-state-metrics (KSM) 監控 AlloyDB Omni Kubernetes 運算子自訂資源的狀態。

使用 Kubernetes 運算子執行 KSM 時，您可以執行下列操作：

  • 在與 Prometheus 相容的可觀測性堆疊中，與 AlloyDB Omni 指標一起即時監控自訂資源狀態。
  • 根據自訂資源指標建立資訊主頁和快訊，以便掌握營運狀況，並主動偵測問題。

如要進一步瞭解 kube-state-metrics，請參閱總覽。如要瞭解 kube-state-metrics 如何監控 Kubernetes 自訂資源，請參閱自訂資源狀態指標。

AlloyDB Omni Kubernetes 運算子自訂資源的運作方式

根據預設，系統不會啟用自訂資源指標。您可以使用 AlloyDB Omni Kubernetes 運算子 Helm 資訊套件，啟用自訂資源指標。啟用自訂資源指標後，系統會建立 KSM 部署作業，其中包含定義自訂資源指標的 configmap，以及用來公開 KSM 部署作業指標端點的 ClusterIP 類型服務。Prometheus 收集器可以收集指標，您也可以將這些指標與其他 AlloyDB Omni 指標一起以視覺化方式呈現。詳情請參閱「AlloyDB Omni Kubernetes 運算子的自訂資源指標」。

事前準備

請確認你已備妥以下項目：

  • 在 Kubernetes 叢集中執行的 Prometheus 相容指標擷取器。
  • 存取位於 registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 的 kube-state-metrics 映像檔。您可以預先將映像檔提取至私人登錄檔。
  • helm套件管理工具。 您會在 Linux 指令列終端機中執行 Helm 指令。

安裝 Kubernetes 運算子，並啟用自訂資源指標

您可以在 AlloyDB Omni Kubernetes 運算子 Helm 資訊套件中使用下列變數，控制自訂資源指標的安裝和移除作業：

變數 類型 說明 預設

crdMetrics.enabled

布林值 (true/false) 啟用及停用自訂資源指標 false (停用)

crdMetrics.ksmImage

字串 ksmImage 的完整路徑

registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0

如果尚未安裝運算子 Helm 資訊套件，請在執行 Helm 安裝時設定變數。

如要安裝 Kubernetes 運算子並啟用自訂資源指標，請按照下列步驟操作：

  1. 開啟 Linux 指令列終端機。

  2. 執行下列指令，定義下列環境變數：

    export GCS_BUCKET=alloydb-omni-operator
export HELM_PATH=$(gcloud storage cat gs://$GCS_BUCKET/latest)
export OPERATOR_VERSION="${HELM_PATH%%/*}"

  3. 下載 AlloyDB Omni Kubernetes 運算子：

    gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive

  4. 如果您已在 registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 將公開 KSM 映像檔預先提取到私人登錄檔，請略過這個步驟，直接前往下一個步驟。否則，請安裝 AlloyDB Omni Kubernetes 運算子和自訂資源指標，然後繼續執行這個程序的最後一個步驟。

    helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--create-namespace \
--namespace alloydb-omni-system \
--set crdMetrics.enabled=true \
--atomic \
--timeout 5m

  5. 匯出環境變數：

    export KSM_IMAGE=<full path to your KSM image>

  6. 如要安裝 AlloyDB Omni Kubernetes 運算子，並使用自訂資源指標和您自己的 KSM 映像檔位置，請執行下列指令：

    helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--create-namespace \
--namespace alloydb-omni-system \
--set crdMetrics.enabled=true,crdMetrics.ksmImage=${KSM_IMAGE} \
--atomic \
--timeout 5m

    安裝成功後，系統會傳回下列輸出內容：

    NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 1
TEST SUITE: None

  7. 刪除下載的 AlloyDB Omni Kubernetes 運算子安裝檔案，清除安裝作業。檔案名稱為 alloydbomni-operator-VERSION_NUMBER.tgz，位於目前的工作目錄中。

在現有的 Kubernetes 運算子中啟用自訂資源指標

如果您已安裝 AlloyDB Omni Kubernetes 運算子 1.3.0 版 (或更新版本)，可以升級現有運算子，啟用自訂資源指標。

  1. 開啟 Linux 指令列終端機。

  2. 執行下列指令，找出目前的 AlloyDB Omni Kubernetes 運算子版本，並定義環境變數：

    export OPERATOR_VERSION=$(helm ls -n alloydb-omni-system  -o json | jq -r 'map(select(.name == "alloydbomni-operator") | .chart)| .[0]')

OPERATOR_VERSION=${OPERATOR_VERSION#"alloydbomni-operator-"}

echo $OPERATOR_VERSION

export GCS_BUCKET=alloydb-omni-operator

export HELM_PATH=$OPERATOR_VERSION/alloydbomni-operator-$OPERATOR_VERSION.tgz

    輸出內容是已安裝的 AlloyDB Omni Kubernetes 運算子版本，例如 1.3.0。

  3. 下載指定版本的運算子：

    gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive

  4. 執行下列指令，升級 AlloyDB Omni Kubernetes 運算子，然後前往這個程序的最後一個步驟。如果您已在 registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 將公開 KSM 映像檔預先提取到私人登錄檔，請略過這個步驟，直接進行下一個步驟。

    helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--namespace alloydb-omni-system \
--reuse-values \
--set crdMetrics.enabled=true \
--atomic \
--timeout 5m

  5. 匯出環境變數：

    export KSM_IMAGE=<full path to your KSM image>

  6. 如要執行升級，請執行下列指令：

    helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--namespace alloydb-omni-system \
--reuse-values \
--set crdMetrics.enabled=true,crdMetrics.ksmImage=${KSM_IMAGE} \
--atomic \
--timeout 5m

    升級成功後，系統會傳回下列輸出內容：

    NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 2
TEST SUITE: None

在現有 Kubernetes 運算子中停用自訂資源指標

  1. 開啟 Linux 指令列終端機。

  2. 執行下列指令：

    export OPERATOR_VERSION=$(helm ls -n alloydb-omni-system  -o json | jq -r 'map(select(.name == "alloydbomni-operator") | .chart)| .[0]')

OPERATOR_VERSION=${OPERATOR_VERSION#"alloydbomni-operator-"}

  3. 如要停用自訂資源指標，請執行下列指令：

    helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--namespace alloydb-omni-system \
--reuse-values \
--set crdMetrics.enabled=false \
--atomic \
--timeout 5m

使用 Prometheus API 查看指標

如要查看指標，請參閱「使用 Prometheus API 查看指標」。

後續步驟