Docs Menu
Docs Home
/
MongoDB Atlas
/
MongoDB Atlas Kubernetes 演算子
/
カスタム リソース

AtlasBackupPolicy カスタム リソース

項目一覧

  • 例
  • パラメーター

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

重要

カスタム リソースはデフォルトでオブジェクトを削除しなくなりました

Atlas Kubernetes Operator はカスタム リソース構成ファイルを使用して Atlas 構成を管理しますが、Atlas Kubernetes Operator 2.0 以降では、Kubernetes で削除したカスタム リソースは Atlas では削除されなくなりました。 代わりに、Atlas Kubernetes Operator はそれらのリソースの管理を停止します。 たとえば、Kubernetes でAtlasProjectカスタム リソースを削除すると、Atlas Kubernetes Operator による、Atlas 内の対応するプロジェクトの自動削除が行われなくなるた、意図しないまたは予期しない削除を防げます。 この動作を Atlas Kubernetes Operator 2.0 より前に使用されていたデフォルトに戻す方法などの詳細については、「新しいデフォルト: Atlas Kubernetes Operator 2.0 の削除保護 」を参照してください。

同様に、Atlas Kubernetes Operator を使用してKubernetesの Atlasプロジェクトからチームを削除しても、Atlas Kubernetes Operator は Atlas からチームを削除しません。

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

  • 新しいバックアップ ポリシーを作成します。

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

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

注意

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

  1. バックアップ ポリシーを作成します。

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

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

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

例

次の例では、毎週スナップショットを取得し、スナップショットを 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とともに、これらの設定はスナップショットを保持する時間の長さを定義します。

戻る

AtlasDatabaseUser

次へ

AtlasBackupSchedule