MKE 4 Documentation
Configuration
Backup and restore

Backup and restore

MKE 4 supports backup and restoration of cluster data through the use of the Velero add-on. System backup is enabled by default.

Backup configuration

The backup section of the MKE 4 configuration file renders as follows:

backup:
  enabled: true
  storage_provider:
    type: InCluster
    in_cluster_options:
      enable_ui: true
      distributed: false

By default, MKE 4 supports backups that use the in-cluster storage provider, as shown in the type.InCluster field. In-cluster backups for MKE 4 are implemented using the MinIO add-on.

Set enable_ui to true to expose the MinIO Console through the Ingress and make it accessible through the UI. Core backup functionality works, even if the UI is disabled.

The distributed setting configures MinIO storage to run in distributed mode.

Refer to the following list for detail on all the configuration file backup fields:

enabled
Indicates whether backup/restore functionality is enabled.
  • Valid values: true, false
  • Default: true
storage_provider.type

Indicates whether the storage type in use is in-cluster or external.

  • InCluster, External
  • Default: InCluster
storage_provider.in_cluster_options.enable_ui

Indicates whether to expose InCluster (MinIO) storage through NodePort.

  • Valid values: true, false
  • Default: true
storage_provider.in_cluster_options.distributed

Indicates whether to run MinIO in distributed mode.

  • Valid values: true, false
  • Default: false
storage_provider.external_options.provider

Name of the external storage provider. Currently, AWS is the only available option.

  • Valid values: aws
  • Default: aws
storage_provider.external_options.bucket

Name of the pre-created bucket to use for backup storage.

storage_provider.external_options.region

Region in which the bucket exists.

storage_provider.external_options.credentials_file_path

Path to the Credentials file.

storage_provider.external_options.credentials_file_profile

Profile in the Credentials file to use

Create a backup and perform a restore

For information on how to create backups and perform restores for both storage provider types, refer to:

Existing limitations

  • MKE 4 does not currently support:

    • scheduled backups
    • backup to NFS storage
    • backup to local disks

  • Backups must currently be restored in the same cluster in which the backup was taken. As such, you cannot restore a backup to a new set of nodes.

  • Backups must be downloaded and uploaded from the in-cluster storage provider using the MinIO Console, as the CLI does not currently support these actions.

Last updated on