`AtlasBackupSchedule` カスタムリソース

AtlasBackupScheduleカスタムリソースは、 AtlasDeploymentカスタムリソースに適用できるバックアップスケジュールを構成します。 AtlasBackupScheduleカスタムリソースを作成すると、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 は、Atlas クラウドバックアップスケジュール API リソースを使用して次のいずれかのアクションを実行します。

新しいバックアップスケジュールを作成します。
既存のバックアップスケジュールを更新します。

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

注意

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

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

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

クラスターごとに指定できるバックアップスケジュールは 1 つですが、複数のクラスターで同じバックアップスケジュールを使用することもできます。

例

次の例では、10:10 UTC でスナップショットを取得し、最大 2 日間復元するように構成されたAtlasBackupScheduleカスタムリソースを示しています。

apiVersion: atlas.mongodb.com/v1
kind: AtlasBackupSchedule
metadata:
  name: atlas-default-backupschedule
spec:
  autoExportEnabled: true
  copySettings:
  - cloudProvider: AWS
    frequencies:
    - HOURLY
    regionName: US_EAST_1
    shouldCopyOplogs: true
  referenceHourOfDay: 10
  referenceMinuteOfHour: 10
  restoreWindowDays: 2
  policy:
    name: atlas-default-backuppolicy
    namespace: mongodb-atlas-system

パラメーター

このセクションでは、使用可能な主要なAtlasBackupScheduleカスタムリソースパラメータの一部について説明します。使用可能なパラメータの完全なリストについては、 Atlas Modify クラウドバックアップポリシー APIを参照してください。これらの説明、利用可能な例、 APIドキュメントを参照して仕様をカスタマイズします。

spec.autoExportEnabled

タイプ: ブール値

任意

AtlasがクラウドバックアップのスナップショットをAmazon Web Servicesバックアップに自動的にエクスポートするかどうかを指定するフラグ。 Amazon Web Servicesバケットへのクラウドバックアップスナップショットの自動エクスポートを有効にするには、true を指定します。自動エクスポートを無効にするには、 falseを指定します。

spec.copySetting

タイプ: 配列

必須

目的のバックアップポリシー内の各コピー設定項目のドキュメントを含むリスト。各コピー設定項目は、スナップショット分散ポリシーを定義します。

spec.export

型: オブジェクト

任意

クラウドバックアップのスナップショットを自動的にエクスポートするポリシー。

spec.export.exportBucketId

型: string

任意

バケットを識別する一意の Amazon Web Services24 桁の 16 進数の文字。string

spec.export.frequencyType

型: string

任意

エクスポートポリシー項目の発生レートを示す、人間が判読可能なラベル。

spec.referenceHourOfDay

タイプ: 数値

任意

0から23までのUTC時間を示す数値。Atlas がバックアップポリシー項目のスナップショットを取得する時刻を表します。

spec.referenceMinuteOfHour

タイプ: 数値

任意

Atlas がバックアップポリシー項目のスナップショットを取得するspec.referenceHourOfDay後の分を示す数値。値は、 0 59の間で指定されなければなりません。

spec.restoreWindowDays

タイプ: 数値

任意

継続的なクラウドバックアップの精度で復元できる過去の日数を示す数値。値は、ゼロ以外の正の整数である必要があります。

この設定は継続的なクラウドバックアップにのみ適用されます。

spec.policy

タイプ: 配列

必須

適用するバックアップポリシーの詳細を含むリスト。

spec.policy.name

型: string

必須

metadata.name 適用するバックアップポリシーのAtlasBackupPolicyカスタムリソース内の値。バックアップスケジュールごとに指定できるバックアップポリシーは 1 つだけです。複数のバックアップスケジュールで同じバックアップポリシーを使用することはできません。

spec.policy.namespace

型: string

必須

適用するバックアップポリシーのAtlasBackupPolicyカスタムリソースを含む名前空間を示す string。

戻る

AtlasBackupPolicy

AtlasCustomRoles

重要

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

注意

例

パラメーター

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