`AtlasBackupCompliancePolicy` カスタムリソース

項目一覧

パラメーター

The AtlasBackupCompliancePolicy custom resource configures a Backup Compliance Policy that applies to the AtlasProject Custom Resource to protect your backup data. AtlasBackupCompliancePolicyカスタムリソースを作成すると、Atlas Kubernetes Operator はバックアップコンプライアンスポリシーの作成または更新を試行します。

Atlas Kubernetes Operator は、Atlasバックアップコンプライアンスポリシー API リソースを使用して次のいずれかのアクションを実行します。

新しいバックアップコンプライアンスポリシーを作成します。
既存のバックアップコンプライアンスポリシーを更新します。

重要

「禁止されたアクションと考慮事項」を参照してください。バックアップコンプライアンスポリシーは、プロジェクト内のすべてのクラスターに最小バックアップポリシーとして適用されます。バックアップコンプライアンスポリシーは、既存のすべてのスナップショットを保護します。バックアップコンプライアンスポリシーは、ロールに関係なく、すべてのユーザーが既存のスナップショットの有効期限が切れる前に既存のスナップショットを変更または削除するのを防ぎます。このバックアップコンプライアンスポリシーに加えられた変更は、将来のスナップショットにのみ適用されます。バックアップコンプライアンスポリシーを有効にすると、バックアップコンプライアンスポリシーによってバックアップストレージのコストを削減する能力が制限されます。バックアップの保持を調整したり、削除してバックアップストレージのコストを削減することはできません。

例

次の例は、 BackupCompliancePolicyカスタムリソースを示しています。詳細については、「バックアップコンプライアンスポリシーの構成」を参照してください。

apiVersion: atlas.mongodb.com/v1
kind: AtlasBackupCompliancePolicy
metadata:
  name: my-backup-compliance-policy
  namespace: mongodb-atlas-system
spec:
  authorizedEmail: john.doe@example.com
  authorizedUserFirstName: John
  authorizedUserLastName: Doe
  copyProtectionEnabled: false
  encryptionAtRestEnabled: false
  onDemandPolicy:
    retentionUnit: weeks
    retentionValue: 3
  overwriteBackupPolicies: false
  pointInTimeEnabled: true
  restoreWindowDays: 42
  scheduledPolicyItems:
  - frequencyInterval: 2
    frequencyType: daily
    retentionUnit: days
    retentionValue: 7

パラメーター

このセクションでは、使用可能な主要なBackupCompliancePolicyカスタムリソースパラメータの一部について説明します。使用可能なパラメーターの完全なリストについては、 Atlas Update またはバックアップコンプライアンスポリシー設定 API の有効化を参照してください。これらの説明、利用可能な例、 APIドキュメントを参照して仕様をカスタマイズします。

spec.authorizedEmail

型: string

必須

承認されたセキュリティ担当者または法定代理人のメールアドレス。

重要

無効または誤ったメールアドレスでは、MongoDB サポートで修正されるまで、このバックアップコンプライアンスポリシーを変更または有効にすることはできません。

spec.authorizedUserFirstName

型: string

必須

承認されたセキュリティ担当者または法定代理人の名。

spec.authorizedUserLastName

型: string

必須

承認されたセキュリティ担当者または法定代理人の姓。

spec.copyProtectionEnabled

タイプ: ブール値

任意

追加のスナップショットリージョンを削除するときにすべてのスナップショットを保持するかどうかを示すフラグ。このパラメータのデフォルトはfalseです。

注意

このパラメータをfalseに変更しても、クラスターユーザーが他のリージョンにコピーされたバックアップを削除するのを防ぐことができます。詳しくは、「 Atlas を設定してスナップショットを他のリージョンに自動的にコピーする」を参照してください。

spec.encryptionAtRestEnabled

タイプ: ブール値

任意

すべてのクラスターに対してカスタマーキー管理を使用した保管時の暗号化を必要とするかどうかを示すフラグ。このパラメータのデフォルトはfalseです。

注意

このオプションを有効にするには、現在のすべてのクラスターに対して保管時の暗号化を有効にする必要があります。保存時の暗号化が有効になっていない一時停止中のクラスターではこのオプションを有効にすることはできません。

spec.onDemandPolicy

型: オブジェクト

任意

オンデマンドスナップショットポリシー項目の設定を含むオブジェクト。

spec.onDemandPolicy.frequencyInterval

タイプ: 数値

必須

spec.onDemandPolicy.frequencyTypeによって指定されたポリシーアイテムの希望頻度を示す数値。 1の値は、対応するspec.onDemandPolicy.frequencyTypeの最初のインスタンスを指定します。

例

月次バックアップコンプライアンスポリシーで、 1は月次スナップショットが月の最初の日に実行されることを示します。
週次バックアップコンプライアンスポリシーで、 1は週次スナップショットが月曜日を実行することを示します。

この設定では、次の頻度値を受け入れます。

時間単位: 1 、 2 、 4 、 6 、 8 、 12 。
毎日: 1 。
週次: 1から7 。 1は月曜日、 7は日曜日です。
月間: 1から28および40 。 1は月の最初の日、 40は月の最終日です。

spec.onDemandPolicy.frequencyType

型: string

必須

ポリシー項目に関連付けられた頻度を示す string。指定できる値は、 hourly 、 daily 、 weekly 、またはmonthlyです。

注意

MongoDB Policy では、複数のhourlyとdailyバックアップポリシーを指定できません。

spec.onDemandPolicy.retentionUnit

型: string

必須

ポリシー項目の範囲を示す string。これらの設定はspec.onDemandPolicy.retentionValueとともに、スナップショットを保持する時間の長さを定義します。指定可能な値はdays 、 weeks 、またはmonthsです。

spec.onDemandPolicy.retentionValue

型: string

必須

spec.onDemandPolicy.retentionUnitに関連付ける値を示す string。 spec.onDemandPolicy.retentionUnitとともに、これらの設定はスナップショットを保持する時間の長さを定義します。

spec.overwriteBackupPolicies

タイプ: ブール値

必須

AtlasBackupPolicyカスタムリソースで指定されている内容に関係なく、プロジェクト内のすべてのバックアップポリシーをアップグレードするかどうかを示すフラグ。

重要

このパラメータをtrueに設定すると、 AtlasBackupPolicyカスタムリソースで指定されている内容に関係なく、Atlas はプロジェクト内のすべてのバックアップポリシーをアップグレードします。 Atlas はAtlasBackupPolicyカスタムリソースと、そのカスタムリソースのステータスをReady: Falseに更新します。バックアップコンプライアンスポリシーと一致するように、 AtlasBackupPolicyカスタムリソースを手動で更新する必要があります。

このパラメータをfalseに設定すると、既存のバックアップポリシーがバックアップコンプライアンスポリシーを満たさない場合、バックアップコンプライアンスポリシーの作成は失敗します。

spec.pitEnabled

タイプ: ブール値

任意

すべてのクラスターへのポイントインタイム復元が必要かどうかを示すフラグ。このパラメータのデフォルトはfalseです。

spec.restoreWindowDays

タイプ: 数値

条件付き

ポイントインタイム復元の復元ウィンドウ内の日数。 spec.pitEnabledをtrueに設定する場合は、このパラメータを指定する必要があります。

重要

1 時間ごとのスナップショット保持時間より長い復元ウィンドウは設定できません。このバックアップコンプライアンスポリシーを保存した後は、MongoDB サポートがないとこの設定を変更できません。この設定を変更するには、バックアップコンプライアンスポリシーに指定されたセキュリティ担当者または法定代理人がサポートをリクエストし、広範な検証プロセスを完了する必要があります。

spec.scheduledPolicyItems

型: オブジェクト

任意

スナップショットポリシー項目の設定を含むオブジェクト。

spec.scheduledPolicyItems.frequencyInterval

タイプ: 数値

必須

spec.scheduledPolicyItems.frequencyTypeによって指定されたポリシーアイテムの希望頻度を示す数値。 1の値は、対応するspec.scheduledPolicyItems.frequencyTypeの最初のインスタンスを指定します。

例

月次バックアップコンプライアンスポリシーで、 1は月次スナップショットが月の最初の日に実行されることを示します。
週次バックアップコンプライアンスポリシーで、 1は週次スナップショットが月曜日を実行することを示します。

この設定では、次の頻度値を受け入れます。

時間単位: 1 、 2 、 4 、 6 、 8 、 12 。
毎日: 1 。
週次: 1から7 。 1は月曜日、 7は日曜日です。
月間: 1から28および40 。 1は月の最初の日、 40は月の最終日です。

spec.scheduledPolicyItems.frequencyType

型: string

必須

ポリシー項目に関連付けられた頻度を示す string。指定できる値は、 hourly 、 daily 、 weekly 、またはmonthlyです。

注意

複数のhourlyとdailyのバックアップポリシー scheduledPolicyItems を指定することはできません。

spec.scheduledPolicyItems.retentionUnit

型: string

必須

ポリシー項目の範囲を示す string。これらの設定はspec.scheduledPolicyItems.retentionValueとともに、スナップショットを保持する時間の長さを定義します。指定可能な値はdays 、 weeks 、またはmonthsです。

spec.scheduledPolicyItems.retentionValue

型: string

必須

spec.scheduledPolicyItems.retentionUnitに関連付ける値を示す string。 spec.scheduledPolicyItems.retentionUnitとともに、これらの設定はスナップショットを保持する時間の長さを定義します。

戻る

AtlasBackupSchedule

AtlasTeam