AtlasBackupPolicy
カスタム リソース
AtlasBackupPolicy
カスタム リソースは、AtlasBackupSchedule
AtlasDeployment
カスタム リソース に適用できる カスタム リソース に適用するバックアップ ポリシーを構成します。AtlasBackupPolicy
カスタム リソースを作成すると、Atlas Kubernetes Operator はバックアップ ポリシーの作成または更新を試行します。
重要
カスタム リソースはデフォルトでオブジェクトを削除しなくなりました
Atlas Kubernetes Operator はカスタムリソース構成ファイルを使用して Atlas2.0 構成を管理しますが、 Atlas Kubernetes Operator 以降、 Kubernetesで削除したカスタム リソースは Atlas で削除されなくなりました(デフォルトでは )。代わりに、Atlas Kubernetes Operator は Atlas 内のそれらのリソースの管理を停止します。例、 Kubernetesで カスタム リソースを削除すると、デフォルトでは、Atlas Kubernetes Operator
AtlasProject
は Atlas から対応するプロジェクトを自動的に削除しなくなります。この動作の変更は、誤ってまたは予期せずに削除されるのを防ぐことを目的としています。この動作を Atlas Kubernetes Operator2 0より前に使用されていたデフォルトに戻す方法などの詳細については、 をご覧ください。 については、「 新しいデフォルト: Atlas Kubernetes Operator の削除保護 」を参照してください。20 。同様に、Atlas Kubernetes Operator を使用してKubernetesの Atlasプロジェクトからチームを削除しても、Atlas Kubernetes Operator は Atlas からチームを削除しません。
デフォルトの Atlas 構成値が暗黙的に使用されるのを避けるために、必要な構成の詳細を明示的に定義します。場合によっては、Atlas のデフォルトを継承すると調整ループが発生し、カスタムリソースが
READY
状態に達しなくなります。例、含まれている例に示すように、AtlasDeployment
カスタムリソースで必要なオートスケーリング動作を明示的に定義すると、カスタムリソース内の静的インスタンスサイズが、オートスケーリングが有効になっている Atlas 配置に繰り返し適用されないことが保証されます。autoScaling: diskGB: enabled: true compute: enabled: true scaleDownEnabled: true minInstanceSize: M30 maxInstanceSize: M40
Atlas Kubernetes Operator は、Atlas クラウドバックアップ スケジュール API リソースを使用して次のいずれかのアクションを実行します。
新しいバックアップ ポリシーを作成します。
既存のバックアップ ポリシーを更新します。
Kubernetes クラスターからAtlasBackupPolicy
リソースを削除すると、Atlas はクラスターのバックアップの作成を停止します。
注意
クラスターをバックアップするには、次のすべてのタスクを実行する必要があります。
バックアップ ポリシーを作成します。
バックアップ スケジュールを作成し、
spec.policy.name
フィールドに構成されたバックアップ ポリシーの名前を設定します。AtlasDeployment
カスタムspec.backupRef.name
リソース の フィールドに、構成されたバックアップ スケジュールの名前を設定します。
例
次の例では、毎週スナップショットを取得し、スナップショットを 7 日間保持するように構成されたAtlasBackupPolicy
カスタム リソースが示されています。
apiVersion: atlas.mongodb.com/v1 kind: AtlasBackupPolicy metadata: name: "atlas-default-backuppolicy" spec: items: - frequencyType: "weekly" frequencyInterval: 1 retentionUnit: "days" retentionValue: 7
パラメーター
このセクションでは、使用可能な主要なAtlasBackupPolicy
カスタム リソース パラメータの一部について説明します。 使用可能なパラメータの完全なリストについては、 Atlas Modify クラウドバックアップ ポリシー APIを参照してください。 これらの説明、利用可能な例、 APIドキュメントを参照して仕様をカスタマイズします。
spec.items
タイプ: 配列
条件付き
APIからのポリシー アイテム パラメータを含むリスト。 利用可能なパラメータの完全なリストについては、「 Atlas Modify クラウドバックアップポリシー API 」を参照してください。
spec.items.frequencyInterval
タイプ: 数値
必須
spec.items.frequencyType
で指定された新しいバックアップ ポリシー項目の希望頻度を示す数値。1
の値は、対応するspec.items.frequencyType
の最初のインスタンスを指定します。例
月次ポリシー項目で、
1
は月次スナップショットが月の最初の日に発生することを示します。週次ポリシー項目で、
1
は週次スナップショットが月曜日を実行することを示します。
この設定では、次の頻度値を受け入れます。
時間単位:
1
、2
、4
、6
、8
、12
。毎日:
1
。週次:
1
から7
。1
は月曜日、7
は日曜日です。月間:
1
から28
および40
。1
は月の最初の日、40
は月の最終日です。年間:
1
から12
。1
は 1 月の最初の日、12
は 12 月の最初の日を指します。
spec.items.frequencyType
型: string
必須
バックアップ ポリシー項目に関連付けられた頻度を示す string。 指定できる値は、
hourly
、daily
、weekly
、monthly
、またはyearly
です。注意
複数の
hourly
とdaily
のバックアップ ポリシー項目を指定することはできません。
spec.items.retentionUnit
型: string
必須
バックアップ ポリシー項目の範囲を示すstring 。 これらの設定は
spec.items.retentionValue
とともに、スナップショットを保持する時間の長さを定義します。 指定できる値は、days
、weeks
、months
、またはyears
です。
spec.items.retentionValue
型: string
必須
spec.items.retentionUnit
に関連付ける値を示す string。spec.items.retentionUnit
とともに、これらの設定はスナップショットを保持する時間の長さを定義します。