Skip to content

Commit 6337310

Browse files
banjohpaigecalvert
andauthored
feat: add ability for EC to define and use Velero plugins (#3661)
* feat: add ability for EC to define and use Velero plugins Signed-off-by: Evans Mungai <[email protected]> * Add when feature was introduced Signed-off-by: Evans Mungai <[email protected]> * Mention velero plugins in DR section Signed-off-by: Evans Mungai <[email protected]> * Minor edits to disaster recovery docs Signed-off-by: Evans Mungai <[email protected]> * docs edits --------- Signed-off-by: Evans Mungai <[email protected]> Co-authored-by: Paige Calvert <[email protected]>
1 parent f6ed71c commit 6337310

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

docs/reference/embedded-config.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,34 @@ spec:
265265
key: value
266266
```
267267

268+
### Configure Velero Plugins
269+
270+
> Introduced in Embedded Cluster v2.13.0
271+
272+
If the customer license has the **Allow Disaster Recovery (Alpha)** option enabled, you can add custom Velero plugins in the `extensions.velero.plugins` key to extend Velero's backup and restore capabilities. For example, you can add support for backing up databases like PostgreSQL, MySQL, or other stateful applications that require advanced disaster recovery capabilities.
273+
274+
Each plugin that you add to the `extensions.velero.plugins` key must have a name and a publicly accessible container image. For more information about the Velero plugin system, including how to create custom plugins, see [Velero plugin system](https://velero.io/docs/v1.17/overview-plugins/) in the Velero documentation.
275+
276+
#### Requirements
277+
278+
* The image for the Velero plugin must be available publicly. Images behind authentication are not supported.
279+
* The **Allow Disaster Recovery (Alpha)** option must be enabled in the license for Velero plugins to work. For more information about how to enable the Embedded Cluster disaster recovery feature, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery).
280+
281+
#### Example
282+
283+
```yaml
284+
apiVersion: embeddedcluster.replicated.com/v1beta1
285+
kind: Config
286+
spec:
287+
extensions:
288+
velero:
289+
# Each plugin requires a name and publicly accessible container image
290+
plugins:
291+
- name: velero-plugin-postgresql
292+
image: myvendor/velero-postgresql:v1.0.0
293+
imagePullPolicy: Always
294+
```
295+
268296
### Configure the Kubelet
269297

270298
You can configure the Kubelet to customize your worker nodes with Embedded Cluster. One common use case for configuring the Kubelet is that you need more pods on a single node than the default limit of 100. In this case, you could set the `maxPods` Kubelet configuration option to 150. Another common example is reducing startup time by setting `maxParallelImagePulls` to increase the maximum number of image pulls that can be done in parallel.

docs/vendor/embedded-disaster-recovery.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,15 @@ To configure Velero Backup and Restore custom resources for Embedded Cluster dis
158158
post.hook.restore.velero.io/wait-for-ready: 'true' # waits for the pod to be ready before running the post-restore hook
159159
```
160160

161-
1. Save and the promote the release to a development channel for testing.
161+
1. Save and the promote the release to a development channel for testing.
162+
163+
### Extend Disaster Recovery with Custom Velero Plugins
164+
165+
> Introduced in Embedded Cluster v2.13.0
166+
167+
You can extend Velero's backup and restore capabilities by configuring custom Velero plugins in the Embedded Cluster Config. This is useful if you need to add support for specific backup scenarios, such as backing up databases like PostgreSQL, MySQL, or other stateful applications that require advanced disaster recovery capabilities.
168+
169+
To configure custom Velero plugins, use the `extensions.velero.plugins` key in the Embedded Cluster Config. For more information, see [Configure Velero Plugins](/reference/embedded-config#configure-velero-plugins) in _Embedded Cluster Config_.
162170

163171
### Enable the Disaster Recovery Feature for Your Customers
164172

0 commit comments

Comments
 (0)