You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can override the default values of Kopia hashing, encryption, and splitter algorithms by using specific environment variables in the Data Protection Application (DPA).
11
+
Override the default values of Kopia hashing, encryption, and splitter algorithms by using specific environment variables in the Data Protection Application (DPA).
12
12
13
13
// configuring the DPA with Kopia environment variables
Copy file name to clipboardExpand all lines: modules/oadp-kopia-algorithms-benchmarking.adoc
+42-70Lines changed: 42 additions & 70 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,22 +7,24 @@
7
7
= Benchmarking Kopia hashing, encryption, and splitter algorithms
8
8
9
9
[role="_abstract"]
10
-
You can run Kopia commands to benchmark the hashing, encryption, and splitter algorithms. Based on the benchmarking results, you can select the most suitable algorithm for your workload. In this procedure, you run the Kopia benchmarking commands from a pod on the cluster. The benchmarking results can vary depending on CPU speed, available RAM, disk speed, current I/O load, and so on.
10
+
Run Kopia commands to benchmark the hashing, encryption, and splitter algorithms. Based on the benchmarking results, you can select the most suitable algorithm for your workload. You run the Kopia benchmarking commands from a pod on the cluster. The benchmarking results can vary depending on CPU speed, available RAM, disk speed, current I/O load, and so on.
11
+
12
+
include::snippets/kopia-repo-config.adoc[]
11
13
12
14
.Prerequisites
13
15
14
16
* You have installed the {oadp-short} Operator.
15
17
* You have an application with persistent volumes running in a separate namespace.
16
18
* You have run a backup of the application with Container Storage Interface (CSI) snapshots.
17
19
18
-
include::snippets/kopia-repo-config.adoc[]
20
+
19
21
20
22
.Procedure
21
23
22
24
. Configure the `must-gather` pod as shown in the following example. Make sure you are using the `oadp-mustgather` image for {oadp-short} version 1.3 and later.
23
25
+
24
26
.Example pod configuration
25
-
+
27
+
26
28
[source,yaml]
27
29
----
28
30
apiVersion: v1
@@ -39,19 +41,18 @@ spec:
39
41
args: ["infinity"]
40
42
----
41
43
+
42
-
[NOTE]
43
-
=====
44
44
The Kopia client is available in the `oadp-mustgather` image.
45
-
=====
46
-
+
45
+
46
+
47
47
. Create the pod by running the following command:
48
48
+
49
49
[source,terminal]
50
50
----
51
-
$ oc apply -f <pod_config_file_name> # <1>
51
+
$ oc apply -f <pod_config_file_name>
52
52
----
53
-
<1> Specify the name of the YAML file for the pod configuration.
54
-
+
53
+
Replace `<pod_config_file_name>` with the name of the YAML file for the pod configuration.
54
+
55
+
55
56
. Verify that the Security Context Constraints (SCC) on the pod is `anyuid`, so that Kopia can connect to the repository.
<1> Specify the object storage provider bucket name.
89
-
<2> Specify the namespace for the application.
90
-
<3> This is the Kopia password to connect to the repository.
91
-
<4> Specify the object storage provider access key.
92
-
<5> Specify the object storage provider secret access key.
93
-
<6> Specify the bucket endpoint. You do not need to specify the bucket endpoint, if you are using {aws-short} S3 as the storage provider.
82
+
--bucket=<bucket_name> \
83
+
--prefix=velero/kopia/<application_namespace> \
84
+
--password=static-passw0rd \
85
+
--access-key="<access_key>" \
86
+
--secret-access-key="<secret_access_key>" \
87
+
--endpoint=<bucket_endpoint>
88
+
----
89
+
+
90
+
where:
91
+
+
92
+
`<bucket_name>`:: Specifies the object storage provider bucket name.
93
+
`<application_namespace>`:: Specifies the namespace for the application.
94
+
`static-passw0rd`:: This is the Kopia password to connect to the repository.
95
+
`<access_key>`:: Specifies the object storage provider access key.
96
+
`<secret_access_key>`:: Specifies the object storage provider secret access key.
97
+
`<bucket_endpoint>`:: Specifies the bucket endpoint. You do not need to specify the bucket endpoint, if you are using {aws-short} S3 as the storage provider.
98
+
94
99
+
95
-
[NOTE]
96
-
====
100
+
97
101
This is an example command. The command can vary based on the object storage provider.
98
-
====
99
-
+
102
+
103
+
100
104
. To benchmark the hashing algorithm, run the following command:
Copy file name to clipboardExpand all lines: modules/oadp-kopia-configuring-algorithms.adoc
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,51 +7,51 @@
7
7
= Configuring the DPA to override Kopia hashing, encryption, and splitter algorithms
8
8
9
9
[role="_abstract"]
10
-
You can use an {oadp-first} option to override the default Kopia algorithms for hashing, encryption, and splitter to improve Kopia performance or to compare performance metrics. You can set the following environment variables in the `spec.configuration.velero.podConfig.env` section of the DPA:
10
+
Configure the Data Protection Application (DPA) to override the default Kopia hashing, encryption, and splitter algorithms by setting environment variables in the Velero pod configuration. This helps you improve Kopia performance and compare performance metrics for your backup operations.
11
11
12
-
* `KOPIA_HASHING_ALGORITHM`
13
-
* `KOPIA_ENCRYPTION_ALGORITHM`
14
-
* `KOPIA_SPLITTER_ALGORITHM`
12
+
include::snippets/kopia-repo-config.adoc[]
15
13
16
14
.Prerequisites
17
15
18
16
* You have installed the {oadp-short} Operator.
19
17
* You have created the secret by using the credentials provided by the cloud provider.
20
18
21
-
include::snippets/kopia-repo-config.adoc[]
22
-
23
19
.Procedure
24
20
25
21
* Configure the DPA with the environment variables for hashing, encryption, and splitter as shown in the following example.
22
+
26
23
+
27
-
.Example DPA
24
+
28
25
[source,yaml]
29
26
----
30
27
apiVersion: oadp.openshift.io/v1alpha1
31
28
kind: DataProtectionApplication
32
29
#...
33
30
configuration:
34
31
nodeAgent:
35
-
enable: true # <1>
36
-
uploaderType: kopia # <2>
32
+
enable: true
33
+
uploaderType: kopia
37
34
velero:
38
35
defaultPlugins:
39
36
- openshift
40
37
- aws
41
-
- csi #<3>
38
+
- csi
42
39
defaultSnapshotMoveData: true
43
40
podConfig:
44
41
env:
45
42
- name: KOPIA_HASHING_ALGORITHM
46
-
value: <hashing_algorithm_name> # <4>
43
+
value: <hashing_algorithm_name>
47
44
- name: KOPIA_ENCRYPTION_ALGORITHM
48
-
value: <encryption_algorithm_name> # <5>
45
+
value: <encryption_algorithm_name>
49
46
- name: KOPIA_SPLITTER_ALGORITHM
50
-
value: <splitter_algorithm_name> # <6>
47
+
value: <splitter_algorithm_name>
51
48
----
52
-
<1> Enable the `nodeAgent`.
53
-
<2> Specify the `uploaderType` as `kopia`.
54
-
<3> Include the `csi` plugin.
55
-
<4> Specify a hashing algorithm. For example, `BLAKE3-256`.
56
-
<5> Specify an encryption algorithm. For example, `CHACHA20-POLY1305-HMAC-SHA256`.
57
-
<6> Specify a splitter algorithm. For example, `DYNAMIC-8M-RABINKARP`.
49
+
+
50
+
where:
51
+
52
+
`enable`:: Set to `true` to enable the `nodeAgent`.
53
+
`uploaderType`:: Specifies the uploader type as `kopia`.
54
+
`csi`:: Include the `csi` plugin.
55
+
`<hashing_algorithm_name>`:: Specifies a hashing algorithm. For example, `BLAKE3-256`.
56
+
`<encryption_algorithm_name>`:: Specifies an encryption algorithm. For example, `CHACHA20-POLY1305-HMAC-SHA256`.
57
+
`<splitter_algorithm_name>`:: Specifies a splitter algorithm. For example, `DYNAMIC-8M-RABINKARP`.
0 commit comments