Skip to content

Commit bab30bf

Browse files
authored
adding docs for custom plugin images (#394)
1 parent cec951d commit bab30bf

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
4. [Self-Signed Certificate](docs/config/self_signed_certs.md)
2222
5. [Use NooBaa as a Backup Storage Location](docs/config/noobaa/install_oadp_noobaa.md)
2323
6. [Use Velero --features flag](docs/config/features_flag.md)
24+
6. [Use Custom Plugin Images for Velero ](docs/config/custom_plugin_images.md)
2425
6. [Upgrade from 0.2](docs/upgrade.md)
2526
7. Examples
2627
1. [Stateless App Backup/Restore](docs/examples/stateless.md)

docs/config/custom_plugin_images.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<hr style="height:1px;border:none;color:#333;">
2+
<h1 align="center">Usage of Custom Plugin Images for Velero</h1>
3+
<hr style="height:1px;border:none;color:#333;">
4+
5+
The OADP Operator supports custom plugin images under the `unsupportedOverrides` field as detailed in the YAML below. This feature can be used to support rapid development and testing of custom images for supported plugins and provides a way for developers to quickly deploy and test their changes.
6+
7+
Details for supported plugins and thier usage is given below, and please use the respective keys for the plugins. All keys must be entered in the Velero CR under a new field called as `unsupportedOverrides`, and with the key below for reference and corresponding image tag as their value.
8+
9+
10+
- Velero Imagekey -> `veleroPluginImageFqin`
11+
- AWS Plugin ImageKey -> `awsPluginImageFqin`
12+
- OpenShift Plugin ImageKey -> `openshiftPluginImageFqin`
13+
- Azure Plugin ImageKey -> `azurePluginImageFqin`
14+
- GCP Plugin ImageKey -> `gcpPluginImageFqin`
15+
- CSI Plugin ImageKey -> `csiPluginImageFqin`
16+
- Restic Restore ImageKey -> `resticRestoreImageFqin`
17+
18+
Below is an example Velero CR with the unsupportedOverrides key added for reference. Please note that the `<IMAGE_PLACEHOLDER WITH TAG>` is to be replaced with the plugin image and tag.
19+
20+
```
21+
apiVersion: oadp.openshift.io/v1alpha1
22+
kind: Velero
23+
metadata:
24+
name: velero-sample
25+
spec:
26+
defaultVeleroPlugins:
27+
- aws
28+
backupStorageLocations:
29+
- name: default
30+
provider: aws
31+
default: true
32+
objectStorage:
33+
bucket: my-bucket
34+
prefix: my-prefix
35+
config:
36+
region: us-east-1
37+
profile: "default"
38+
credential:
39+
name: cloud-credentials
40+
key: cloud
41+
volumeSnapshotLocations:
42+
- name: default
43+
provider: aws
44+
config:
45+
region: us-west-2
46+
profile: "default"
47+
unsupportedOverrides:
48+
awsPluginImageFqin: <IMAGE_PLACEHOLDER WITH TAG>
49+
openshiftPluginImageFqin: <IMAGE_PLACEHOLDER WITH TAG>
50+
```

0 commit comments

Comments
 (0)