`AtlasBackupPolicy` カスタムリソース

AtlasBackupPolicyカスタムリソースは、AtlasBackupSchedule AtlasDeploymentカスタムリソースに適用できるカスタムリソースに適用するバックアップポリシーを構成します。AtlasBackupPolicyカスタムリソースを作成すると、Atlas Kubernetes Operator はバックアップポリシーの作成または更新を試行します。

重要

カスタムリソースの定義が優先されます

Atlas Kubernetes Operator は、カスタムリソース構成ファイルを使用して Atlas 構成を管理します。各カスタムリソース定義は、Atlas UI などの他の方法で指定された設定を上書きします。カスタムリソースを削除すると、注釈を使用して削除をスキップしない限り、Atlas Kubernetes Operator によって Atlas からオブジェクトが削除されます。詳細については、「プロセスの作成と更新」および「削除プロセス」を参照してください。

Atlas Kubernetes Operator は、Atlas クラウドバックアップスケジュール API リソースを使用して次のいずれかのアクションを実行します。

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

Kubernetes クラスターからAtlasBackupPolicyリソースを削除すると、Atlas はクラスターのバックアップの作成を停止します。

注意

クラスターをバックアップするには、次のすべてのタスクを実行する必要があります。

バックアップポリシーを作成します。
バックアップスケジュールを作成し、 spec.policy.nameフィールドに構成されたバックアップポリシーの名前を設定します。
AtlasDeploymentカスタム spec.backupRef.nameリソースのフィールドに、構成されたバックアップスケジュールの名前を設定します。

詳しくは、「 Atlas クラスターのバックアップ」を参照してください。

例

次の例では、毎週スナップショットを取得し、スナップショットを 7 日間保持するように構成されたAtlasBackupPolicyカスタムリソースが示されています。

apiVersion: atlas.mongodb.com/v1
kind: AtlasBackupPolicy
metadata:
  name: "atlas-default-backuppolicy"
  labels:
    app.kubernetes.io/version: 1.6.0
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は月の最終日です。

spec.items.frequencyType

型: string

必須

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

注意

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

spec.items.retentionUnit

型: string

必須

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

spec.items.retentionValue

型: string

必須

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

戻る

AtlasDatabaseUser

AtlasBackupSchedule

重要

カスタム リソースの定義が優先されます

注意

例

パラメーター

例

注意

カスタムリソースの定義が優先されます