The AtlasBackupCompliancePolicy custom resource configures a Backup Compliance Policy that applies to the AtlasProject Custom Resource to protect your backup data. When you create the AtlasBackupCompliancePolicy custom resource, Atlas Kubernetes Operator tries to create or update a Backup Compliance Policy.
Atlas Kubernetes Operator does one of the following actions using the Atlas Backup Compliance Policy API Resource:
新しいバックアップ コンプライアンス ポリシーを作成します。
既存のバックアップ コンプライアンス ポリシーを更新します。
重要
「禁止されたアクションと考慮事項」を参照してください。 バックアップ コンプライアンス ポリシーは、プロジェクト内のすべてのクラスターに最小バックアップ ポリシーとして適用されます。 バックアップ コンプライアンス ポリシーは、既存のすべてのスナップショットを保護します。 バックアップ コンプライアンス ポリシーは、ロールに関係なく、すべてのユーザーが既存のスナップショットの有効期限が切れる前に既存のスナップショットを変更または削除するのを防ぎます。 このバックアップ コンプライアンス ポリシーに加えられた変更は、将来のスナップショットにのみ適用されます。 バックアップ コンプライアンス ポリシーを有効にすると、バックアップ コンプライアンス ポリシーによってバックアップ ストレージのコストを削減する能力が制限されます。 バックアップの保持を調整したり、削除してバックアップ ストレージのコストを削減することはできません。
例
次の例は、 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.copyProtectionEnabledタイプ: ブール値
任意
Flag that indicates whether to keep all snapshots when removing additional snapshot regions. This parameter defaults to
false.注意
You can prevent cluster users from deleting backups copied to other regions even if you change this parameter to
false. To learn more, see Copy Snapshots to Additional Regions.
spec.encryptionAtRestEnabledタイプ: ブール値
任意
すべてのクラスター に対してカスタマー キー管理を使用した保管時の暗号化を必要とするかどうかを示すフラグ。 このパラメータのデフォルトは
falseです。注意
このオプションを有効にするには、現在のすべてのクラスターに対して保管時の暗号化を有効にする 必要があります。 保存時の暗号化が有効になっていない一時停止中のクラスターではこのオプションを有効にすることはできません。
spec.onDemandPolicy.frequencyIntervalタイプ: 数値
必須
Number that indicates the desired frequency of the policy item specified by
spec.onDemandPolicy.frequencyType. A value of1specifies the first instance of the correspondingspec.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 that indicates the scope of the policy item. Together with
spec.onDemandPolicy.retentionValue, these settings define the length of time to retain snapshots. Accepted values are:days,weeks, ormonths.
spec.onDemandPolicy.retentionValue型: string
必須
String that indicates the value to associate with
spec.onDemandPolicy.retentionUnit. Together withspec.onDemandPolicy.retentionUnit, these settings define the length of time to retain snapshots.
spec.overwriteBackupPoliciesタイプ: ブール値
必須
AtlasBackupPolicyカスタム リソースで指定されている内容に関係なく、プロジェクト内のすべてのバックアップ ポリシーをアップグレードするかどうかを示すフラグ。重要
このパラメータを
trueに設定すると、AtlasBackupPolicyカスタム リソースで指定されている内容に関係なく、Atlas はプロジェクト内のすべてのバックアップ ポリシーをアップグレードします。 Atlas はAtlasBackupPolicyカスタム リソースと、そのカスタム リソースのステータスをReady: Falseに更新します。 バックアップ コンプライアンス ポリシーと一致するように、AtlasBackupPolicyカスタム リソースを手動で更新する必要があります。このパラメータを
falseに設定すると、既存のバックアップ ポリシーがバックアップ コンプライアンス ポリシーを満たさない場合、バックアップ コンプライアンス ポリシーの作成は失敗します。
spec.restoreWindowDaysタイプ: 数値
条件付き
Number of days in the restore window for point in time restore. If you set
spec.pitEnabledtotrue, you must specify this parameter.重要
You can't configure a restore window that is longer than the Hourly Snapshot Retention Time. After you save this Backup Compliance Policy, you can't change this setting without MongoDB support. To change this setting, the security or legal representative specified for the Backup Compliance Policy must request support and complete an extensive verification process.
spec.scheduledPolicyItems.frequencyIntervalタイプ: 数値
必須
Number that indicates the desired frequency of the policy item specified by
spec.scheduledPolicyItems.frequencyType. A value of1specifies the first instance of the correspondingspec.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 that indicates the scope of the policy item. Together with
spec.scheduledPolicyItems.retentionValue, these settings define the length of time to retain snapshots. Accepted values are:days,weeks, ormonths.
spec.scheduledPolicyItems.retentionValue型: string
必須
String that indicates the value to associate with
spec.scheduledPolicyItems.retentionUnit. Together withspec.scheduledPolicyItems.retentionUnit, these settings define the length of time to retain snapshots.