Atlas Kubernetes Operator を使用して、Atlas プロジェクト内のデータベース配置へのアクセスとデータベース配置の状態を監視できるようにアラートを構成できます。
詳しくは、「アラート設定の構成 」を参照してください。
Considerations
In your AtlasProject カスタム リソース、alertConfigurationSyncEnabled と withDefaultAlertsSettings 設定を使用して、Atlasアラート構成を管理します。次の表では、これらの設定の構成方法に基づいて Atlas Kubernetes Operator が実行するアクションを説明しています。
spec.alertConfigurationSyncEnabled | spec.withDefaultAlertsSettings | 動作 |
|---|---|---|
true | true | Atlas Kubernetes Operator は、デフォルトのアラート構成を使用してプロジェクトを作成します。 Atlas Kubernetes Operator によってプロジェクトが作成されると、 |
true | false | Atlas Kubernetes Operator は、デフォルトのアラート構成を追加せずにプロジェクトを作成します。 Atlas Kubernetes Operator によってプロジェクトが作成されると、 |
false | true | Atlas Kubernetes Operator は、デフォルトのアラート構成を使用してプロジェクトを作成します。Atlas Kubernetes Operator は、Atlas のアラート定義と |
false | false | Atlas Kubernetes Operator は、デフォルトのアラート構成を追加せずにプロジェクトを作成します。Atlas Kubernetes Operator は、Atlas のアラート定義と |
前提条件
Atlas Kubernetes Operator から Atlas へのアクセスを構成するには、次の公開 API キー、プライベート API キー、および組織 ID 情報が必要です。
Atlas Kubernetes Operator で新しい Atlasプロジェクトを作成する場合は、 組織へのプログラムによるアクセスの付与 。組織で Atlas Administration APIのIP アクセス リストが必要な場合は、 APIアクセス リストも設定する必要があります。
重要
API キーには、 Organization Project Creator組織ロール以上を割り当てる必要があります。
既存の Atlasプロジェクトを操作する場合は、 プロジェクトからプロジェクト アクセスを追加 します。組織で Atlas Administration APIのIP アクセス リストが必要な場合は、 APIアクセス リストも設定する必要があります。
重要
Project Ownerプロジェクト ロールに API キーを割り当てる必要があります。
詳細については、「 Atlas へのアクセスの設定 」を参照してください。
手順
プロジェクト アラートを構成するには、 AtlasProjectカスタム リソースを構成します。
例:
cat <<EOF | kubectl apply -f - apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: TestAlertConfig connectionSecretRef: name: my-atlas-key projectIpAccessList: - cidrBlock: "0.0.0.0/1" comment: "Everyone has access. For test purposes only." - cidrBlock: "128.0.0.0/1" comment: "Everyone has access. For test purposes only." alertConfigurations: - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", enabled: true, notifications: - delayMin: 0 emailEnabled: true intervalMin: 60 roles: [ "GROUP_OWNER" ] smsEnabled: false typeName: "GROUP" threshold: operator: "LESS_THAN", threshold: 1, units: "HOURS" alertConfigurationSyncEnabled: true withDefaultAlertsSettings: false EOF
AtlasProjectカスタム リソースで指定する必要があるパラメータは、構成するアラートによって異なります。
APIから利用できる構成パラメーターの詳細については、「アラート構成 」を参照してください。