/ /

`AtlasBackupCompliancePolicy` カスタムリソース

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

パラメーター

AtlasBackupCompliancePolicy

AtlasBackupCompliancePolicy は、特定のバックアップと保持要件を強制する構成です

`Name`	タイプ	説明	必須
`apiVersion`	string	atlas.mongodb.com/v1	true
`kind`	string	`AtlasBackupCompliancePolicy`	true
`metadata`	オブジェクト	`metadata`フィールドのフィールドについては、 Kubernetes `API` のドキュメントを参照してください。	true
`spec`	オブジェクト	`AtlasBackupCompliancePolicySpec` は、目的のバックアップコンプライアンスポリシー構成の仕様です。	false
`status`	オブジェクト	`BackupCompliancePolicyStatus` は、`AtlasBackupCompliancePolicy` の監視された状態を定義します。	false

AtlasBackupCompliancePolicy.spec

AtlasBackupCompliancePolicySpec は、目的のバックアップコンプライアンスポリシー構成の仕様です。

`Name`	タイプ	説明	必須
`authorizedEmail`	string	バックアップコンプライアンスポリシー設定を更新する権限を持つユーザーのメールアドレス。	true
`authorizedUserFirstName`	string	バックアップコンプライアンスポリシー設定を更新する権限を持つユーザーの名。	true
`authorizedUserLastName`	string	バックアップコンプライアンスポリシー設定を更新する権限を持つユーザーの姓。	true
`copyProtectionEnabled`	ブール値	追加のスナップショットリージョンが削除された場合でも、クラスターユーザーが他のリージョンにコピーされたバックアップを削除できないようにするかどうかを示すフラグ。	false
`encryptionAtRestEnabled`	ブール値	バックアップコンプライアンスポリシーが設定されているすべてのクラスターに対して、カスタマーキーマネジメントを使用した保管時の暗号化を要求するかどうかを示すフラグ。	false
`onDemandPolicy`	オブジェクト	オンデマンドポリシーの仕様。	false
`overwriteBackupPolicies`	ブール値	コンプライアンス以外のバックアップポリシーを新しいデータ保護設定で上書きするかどうかを示すフラグ。	false
`pointInTimeEnabled`	ブール値	クラスターがバックアップコンプライアンスポリシーを使用して継続的なクラウドバックアップを使用するかどうかを示すフラグ。	false
`restoreWindowDays`	integer	バックアップコンプライアンスポリシーが設定された継続的クラウドバックアップで、復元可能な前の日数。このパラメータは、バックアップコンプライアンスポリシーが設定された継続的なクラウドバックアップにのみ適用されます。	false
`scheduledPolicyItems`	[]オブジェクト	1 つのスケジュールされたポリシーの仕様を含むリスト。	false

AtlasBackupCompliancePolicy.spec.onDemandPolicy

オンデマンドポリシーの仕様。

`Name`	タイプ	説明	必須
`retentionUnit`	列挙	バックアップポリシー項目の範囲: 日、週、または月。列挙: 日、週、月	true
`retentionValue`	integer	`RetentionUnit` に関連付ける値。	true

AtlasBackupCompliancePolicy.spec.sScheduledPolicyItems

`Name`	タイプ	説明	必須
`frequencyInterval`	integer	`FrequencyType` によって指定される新しいバックアップポリシー項目の頻度。1 の値は、対応する `FrequencyType` の最初のインスタンスを指定します。NVMe クラスターでは、`FrequencyInterval` は 12 にのみ設定できます。列挙: 1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、16、17、18、19、20、21、22、23、24、25、26、27、28、40	true
`frequencyType`	列挙	バックアップポリシー項目に関連付けられている頻度。1 時間ごとまたは 1 日ごとのバックアップポリシー項目は、それぞれ 1 つだけ指定できます。列挙: 時間単位、毎日、週次、月次、年ごと	true
`retentionUnit`	列挙	`MongoDB` Atlas がスナップショットの保持を測定する時間の単位。列挙: 日、週、月、年	true
`retentionValue`	integer	`MongoDB` クラウドがスナップショットを保持する日数、週、月、または年単位。頻度の低いポリシー項目の場合、`MongoDB` クラウドでは、頻度の高いポリシー項目に指定された値以上の値を指定する必要があります。	true

AtlasBackupCompliancePolicy.status

BackupCompliancePolicyStatus は、AtlasBackupCompliancePolicy の監視された状態を定義します。

`Name`	タイプ	説明	必須
`conditions`	[]オブジェクト	条件は、Atlas カスタムリソースの現在の状態を示すステータスのリストです	true
`observedGeneration`	integer	`ObservedGeneration` は、Atlas 演算子が認識しているリソース仕様の生成を示します。Atlas 演算子は、このフィールドを「メタデータ.generate 」の値に更新します。が、リソースの調整を開始するとすぐに表示されます。形式: int64	false

AtlasBackupCompliancePolicy.status.条件

条件は、特定の点における Atlas カスタムリソースの状態を表します。

`Name`	タイプ	説明	必須
`status`	string	条件のステータス。 True、False、Unknown のいずれか 1 つ。	true
`type`	string	Atlas カスタムリソース条件のタイプ。	true
`lastTransitionTime`	string	条件があるステータスから別のステータスに最後に移行した時刻。`ISO` 8601形式で表されます。形式: 日時	false
`message`	string	移行に関する詳細を提供する `message`。	false
`reason`	string	条件の最後の移行の `reason`。	false

戻る

AtlasStreamWorkspace

AtlasTeam

AtlasBackupCompliancePolicy カスタム リソース

例