Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,6 @@ yarn-error.log*

# Git worktrees
.worktrees

# Local tools / research directories
.tools
4 changes: 2 additions & 2 deletions docs/enterprise/snapshots-config-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To configure snapshots for embedded clusters:
- [Configure an NFS Storage Destination](snapshots-configuring-nfs)
- [Configure Other Storage Destinations](snapshots-storage-destinations)

1. Optionally increase the default memory for the node-agent (restic) Pod. See [Configure Namespace Access and Memory Limit](snapshots-velero-installing-config).
1. Optionally increase the default memory for the node-agent Pod. See [Configure Namespace Access and Memory Limit](snapshots-velero-installing-config).

## Configuring backup storage for existing clusters

Expand All @@ -38,7 +38,7 @@ Follow this process to install Velero and configure the snapshots feature:
- [Configure an NFS Storage Destination](snapshots-configuring-nfs)
- [Configure Other Storage Destinations](snapshots-storage-destinations)

1. Enable access to the Velero namespace if you are using RBAC and optionally increase the default memory for the node-agent (restic) Pod. See [Configure Namespace Access and Memory Limit](snapshots-velero-installing-config).
1. Enable access to the Velero namespace if you are using RBAC and optionally increase the default memory for the node-agent Pod. See [Configure Namespace Access and Memory Limit](snapshots-velero-installing-config).

## Next step

Expand Down
14 changes: 9 additions & 5 deletions docs/enterprise/snapshots-configuring-hostpath.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import InstallVelero from "../partials/snapshots/_installVelero.mdx"
import RegistryCredNote from "../partials/snapshots/_registryCredentialsNote.mdx"
import ResticDaemonSet from "../partials/snapshots/_resticDaemonSet.mdx"
import NodeAgentDaemonSet from "../partials/snapshots/_node-agent-daemonset.mdx"
import UpdateDefaultStorage from "../partials/snapshots/_updateDefaultStorage.mdx"
import CheckVersion from "../partials/snapshots/_checkVersion.mdx"
import KotsAvailability from "../partials/kots/_kots-availability.mdx"
Expand All @@ -15,6 +15,10 @@ This topic describes how to install Velero and configure a host path as your sto

<KotsAvailability/>

:::important
The local-volume-provider (LVP) plugin supports only Restic. Velero 1.17 and later do not support LVP. KOTS uses LVP only when you disable MinIO or explicitly install the LVP plugin. If you use LVP for HostPath storage, migrate to a Kopia-compatible destination before upgrading to Velero 1.17 or later. Existing LVP backups from Velero 1.16 and earlier are not restorable on Velero 1.17 or later. For more information, see [Upgrade Velero for snapshots](snapshots-velero-upgrading).
:::

## Requirements

* The host path must be a dedicated directory. Do not use a partition used by a service like Docker or Kubernetes for ephemeral storage.
Expand All @@ -37,7 +41,7 @@ To install Velero and configure host path storage in online environments:

1. <InstallVelero/>

1. <ResticDaemonSet/>
1. <NodeAgentDaemonSet/>

1. Run the following command to configure the host path storage destination:

Expand All @@ -51,17 +55,17 @@ To install Velero and configure host path storage in online environments:

For more information about required storage destination flags, see [`velero`](/reference/kots-cli-velero-index) in _Reference_.

## Install Velero and configure host path storage in air gapped environments
## Install Velero and configure host path storage in air-gapped environments

To install Velero and configure host path storage in air gapped environments:
To install Velero and configure host path storage in air-gapped environments:

1. <CheckVersion/>

1. <InstallVelero/>

<RegistryCredNote/>

1. <ResticDaemonSet/>
1. <NodeAgentDaemonSet/>

1. Run the following command to configure the host path storage destination:

Expand Down
14 changes: 9 additions & 5 deletions docs/enterprise/snapshots-configuring-nfs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import InstallVelero from "../partials/snapshots/_installVelero.mdx"
import RegistryCredNote from "../partials/snapshots/_registryCredentialsNote.mdx"
import ResticDaemonSet from "../partials/snapshots/_resticDaemonSet.mdx"
import NodeAgentDaemonSet from "../partials/snapshots/_node-agent-daemonset.mdx"
import UpdateDefaultStorage from "../partials/snapshots/_updateDefaultStorage.mdx"
import CheckVersion from "../partials/snapshots/_checkVersion.mdx"
import KotsAvailability from "../partials/kots/_kots-availability.mdx"
Expand All @@ -15,6 +15,10 @@ This topic describes how to install Velero and configure a Network File System (

<KotsAvailability/>

:::important
The local-volume-provider (LVP) plugin supports only Restic. Velero 1.17 and later do not support LVP. KOTS uses LVP only when you disable MinIO or explicitly install the LVP plugin. If you use LVP for NFS storage, migrate to a Kopia-compatible destination before upgrading to Velero 1.17 or later. Existing LVP backups from Velero 1.16 and earlier are not restorable on Velero 1.17 or later. For more information, see [Upgrade Velero for snapshots](snapshots-velero-upgrading).
:::

## Requirements

Configuring an NFS server as a snapshots storage destination has the following requirements:
Expand All @@ -38,7 +42,7 @@ To install Velero and configure NFS storage in an online environment:

1. <InstallVelero/>

1. <ResticDaemonSet/>
1. <NodeAgentDaemonSet/>

1. Run the following command to configure the NFS storage destination:

Expand All @@ -53,17 +57,17 @@ To install Velero and configure NFS storage in an online environment:

For more information about required storage destination flags, see [`velero`](/reference/kots-cli-velero-index) in _Reference_.

## Install Velero and configure NFS storage in air gapped environments
## Install Velero and configure NFS storage in air-gapped environments

To install Velero and configure NFS storage in air gapped environments:
To install Velero and configure NFS storage in air-gapped environments:

1. <CheckVersion/>

1. <InstallVelero/>

<RegistryCredNote/>

1. <ResticDaemonSet/>
1. <NodeAgentDaemonSet/>

1. Run the following command to configure the NFS storage destination:

Expand Down
42 changes: 21 additions & 21 deletions docs/enterprise/snapshots-storage-destinations.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,20 @@ To install Velero and configure an AWS storage destination:

1. Run the `velero install` command with these additional flags:

* **Velero 1.10 and later**: Use the `--use-node-agent`, `--uploader-type=restic`, and `--use-volume-snapshots=false` flags.
* **Velero versions earlier than 1.10**: Use the `--use-restic` and `--use-volume-snapshots=false` flags.
* **Velero 1.17 and later**: Use the `--use-node-agent` and `--use-volume-snapshots=false` flags.
* **Velero 1.11 to 1.16**: Use the `--use-node-agent`, `--uploader-type=restic`, and `--use-volume-snapshots=false` flags.

**Example:**

```
velero install \
--provider aws \
--plugins velero/velero-plugin-for-aws:v1.2.0 \
--bucket $BUCKET \
--backup-location-config region=$REGION \
--secret-file CREDS_FILE \
--use-node-agent --uploader-type=restic \
--use-volume-snapshots=false
--provider aws \
--plugins velero/velero-plugin-for-aws:v1.14.2 \
--bucket $BUCKET \
--backup-location-config region=$REGION \
--secret-file CREDS_FILE \
--use-node-agent \
--use-volume-snapshots=false
```

## Configure GCP storage for online environments
Expand All @@ -59,18 +59,18 @@ To install Velero and configure a GCP storage destination:
1. Follow the instructions for installing Velero on GCP in the [velero-plugin-for-gcp](https://github.com/vmware-tanzu/velero-plugin-for-gcp#setup) repository in GitHub.

1. Run the `velero install` command with these additional flags:
* **Velero 1.10 and later**: Use the `--use-node-agent`, `--uploader-type=restic`, and `--use-volume-snapshots=false` flags.
* **Velero versions earlier than 1.10**: Use the `--use-restic` and `--use-volume-snapshots=false` flags.
* **Velero 1.17 and later**: Use the `--use-node-agent` and `--use-volume-snapshots=false` flags.
* **Velero 1.11 to 1.16**: Use the `--use-node-agent`, `--uploader-type=restic`, and `--use-volume-snapshots=false` flags.

**Example:**

```
velero install \
--provider gcp \
--plugins velero/velero-plugin-for-gcp:v1.5.0 \
--plugins velero/velero-plugin-for-gcp:v1.14.2 \
--bucket $BUCKET \
--secret-file ./CREDS_FILE
--use-node-agent --uploader-type=restic \
--secret-file ./CREDS_FILE \
--use-node-agent \
--use-volume-snapshots=false
```

Expand All @@ -83,20 +83,20 @@ To install Velero and configure an Azure storage destination:
1. Follow the instructions for [Install Velero on Azure](https://github.com/vmware-tanzu/velero-plugin-for-microsoft-azure#setup) in the Velero documentation.

1. Run the `velero install` command with these additional flags:
* **Velero 1.10 and later**: Use the `--use-node-agent`, `--uploader-type=restic`, and `--use-volume-snapshots=false` flags.
* **Velero versions earlier than 1.10**: Use the `--use-restic` and `--use-volume-snapshots=false` flags.
* **Velero 1.17 and later**: Use the `--use-node-agent` and `--use-volume-snapshots=false` flags.
* **Velero 1.11 to 1.16**: Use the `--use-node-agent`, `--uploader-type=restic`, and `--use-volume-snapshots=false` flags.

**Example:**

```
velero install \
--provider azure \
--plugins velero/velero-plugin-for-microsoft-azure:v1.5.0 \
--plugins velero/velero-plugin-for-microsoft-azure:v1.14.2 \
--bucket $BLOB_CONTAINER \
--secret-file ./CREDS_FILE \
--backup-location-config resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,storageAccount=$AZURE_STORAGE_ACCOUNT_ID[,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] \
--snapshot-location-config apiTimeout=<YOUR_TIMEOUT>[,resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID]
--use-node-agent --uploader-type=restic \
--snapshot-location-config apiTimeout=<YOUR_TIMEOUT>[,resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] \
--use-node-agent \
--use-volume-snapshots=false
```

Expand Down Expand Up @@ -142,7 +142,7 @@ kubectl kots velero configure-other-s3 \

If no Velero installation is detected, instructions are displayed to install Velero and configure the storage destination.

## Configure s3-compatible storage for air gapped environments
## Configure s3-compatible storage for air-gapped environments

> Introduced in Replicated KOTS v1.94.0

Expand All @@ -151,7 +151,7 @@ The following S3-compatible object stores are supported for storing backups with
- Ceph RADOS v12.2.7
- MinIO

Run the following command to install Velero and configure an S3-compatible storage destination in an air gapped environment. For more information about required storage destination flags, see [`velero`](/reference/kots-cli-velero-index) in _Reference_.
Run the following command to install Velero and configure an S3-compatible storage destination in an air-gapped environment. For more information about required storage destination flags, see [`velero`](/reference/kots-cli-velero-index) in _Reference_.

```bash
kubectl kots velero configure-other-s3 \
Expand Down
Loading
Loading