カスタムリソースは、バックアップデータを保護するためにAtlasProject AtlasBackupCompliancePolicyカスタム リソースに適用するバックアップ コンプライアンス ポリシーを構成します。 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.copyProtectionEnabledタイプ: ブール値
任意
追加の スナップショット リージョン を削除するときにすべてのスナップショットを保持するかどうかを示すフラグ。 このパラメータのデフォルトは
falseです。注意
このパラメータを
falseに変更しても、クラスター ユーザーが他のリージョンにコピーされたバックアップを削除するのを防ぐことができます。 詳しくは、「 Atlas を設定してスナップショットを他のリージョンに自動的にコピーする 」を参照してください。
spec.encryptionAtRestEnabledタイプ: ブール値
任意
すべてのクラスター に対してカスタマー キー管理を使用した保管時の暗号化を必要とするかどうかを示すフラグ。 このパラメータのデフォルトは
falseです。注意
このオプションを有効にするには、現在のすべてのクラスターに対して保管時の暗号化を有効にする 必要があります。 保存時の暗号化が有効になっていない一時停止中のクラスターではこのオプションを有効にすることはできません。
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.restoreWindowDaysタイプ: 数値
条件付き
ポイントインタイム復元の復元ウィンドウ内の日数。
spec.pitEnabledをtrueに設定する場合は、このパラメータを指定する必要があります。重要
1 時間ごとのスナップショット保持時間より長い復元ウィンドウは設定できません。 このバックアップ コンプライアンス ポリシーを保存した後は、MongoDB サポートがないとこの設定を変更できません。 この設定を変更するには、バックアップ コンプライアンス ポリシーに指定されたセキュリティ担当者または法定代理人がサポートをリクエストし、広範な検証プロセスを完了する必要があります。
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とともに、これらの設定はスナップショットを保持する時間の長さを定義します。