-
Notifications
You must be signed in to change notification settings - Fork 31
feat: add ability for EC to define and use Velero plugins #3661
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
cd13a01
7dd74c0
e5ca14c
f93e8eb
f774700
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -265,6 +265,34 @@ spec: | |
| key: value | ||
| ``` | ||
|
|
||
| ### Configure Velero Plugins | ||
|
|
||
| > Introduced in Embedded Cluster v2.13.0 | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. note: added a link to the velero docs with info about how to create plugins (can remove if this is not actually relevant to this particular feature) |
||
|
|
||
| #### Requirements | ||
|
|
||
| * The image for the Velero plugin must be available publicly. Images behind authentication are not supported. | ||
| * 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). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ added the specific license field and a link to the disaster recovery feature page |
||
|
|
||
| #### Example | ||
|
|
||
| ```yaml | ||
| apiVersion: embeddedcluster.replicated.com/v1beta1 | ||
| kind: Config | ||
| spec: | ||
| extensions: | ||
| velero: | ||
| # Each plugin requires a name and publicly accessible container image | ||
| plugins: | ||
| - name: velero-plugin-postgresql | ||
| image: myvendor/velero-postgresql:v1.0.0 | ||
| imagePullPolicy: Always | ||
| ``` | ||
|
|
||
| ### Configure the Kubelet | ||
|
|
||
| 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. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -158,7 +158,15 @@ To configure Velero Backup and Restore custom resources for Embedded Cluster dis | |
| post.hook.restore.velero.io/wait-for-ready: 'true' # waits for the pod to be ready before running the post-restore hook | ||
| ``` | ||
|
|
||
| 1. Save and the promote the release to a development channel for testing. | ||
| 1. Save and the promote the release to a development channel for testing. | ||
|
|
||
| ### Extend Disaster Recovery with Custom Velero Plugins | ||
|
|
||
| > Introduced in Embedded Cluster v2.13.0 | ||
|
|
||
| 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. | ||
|
|
||
| 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_. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ there was some info here that felt more relevant to the reference page (like that each plugin needs a |
||
|
|
||
| ### Enable the Disaster Recovery Feature for Your Customers | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ brought over some of the helpful use case examples from the other page over here as well