📚 Sync docs from alaudadevops/harbor-ce-operator on d92f4753ab9587c6224505626db3fb10d1375b85

Source: doc: add documentation for snapshot-based backup (#131)
Author: nanjingfm
Ref: refs/heads/main
Commit: d92f4753ab9587c6224505626db3fb10d1375b85

This commit automatically syncs documentation changes from the source-docs repository.

🔗 View source commit: AlaudaDevops/harbor-ce-operator@d92f475
🤖 Synced on 2025-08-21 04:34:03 UTC

Author: nanjingfm

.github/SYNC_INFO.md

@@ -1,10 +1,10 @@
 # Documentation Sync Information
 
-- **Last synced**: 2025-08-13 06:36:49 UTC
+- **Last synced**: 2025-08-21 04:34:03 UTC
 - **Source repository**: alaudadevops/harbor-ce-operator
-- **Source commit**: [258a67084dbd367a13cc3105bafe0027e5b4e5bc](https://github.com/alaudadevops/harbor-ce-operator/commit/258a67084dbd367a13cc3105bafe0027e5b4e5bc)
-- **Triggered by**: yuzichen12123
-- **Workflow run**: [#11](https://github.com/alaudadevops/harbor-ce-operator/actions/runs/16929547208)
+- **Source commit**: [d92f4753ab9587c6224505626db3fb10d1375b85](https://github.com/alaudadevops/harbor-ce-operator/commit/d92f4753ab9587c6224505626db3fb10d1375b85)
+- **Triggered by**: nanjingfm
+- **Workflow run**: [#14](https://github.com/alaudadevops/harbor-ce-operator/actions/runs/17117180755)
 
 ## Files synced:
 - docs/

docs/en/howto/04_backup_and_restore_using_velero.mdx

@@ -55,9 +55,9 @@ mc alias set ${MINIO_ALIAS_NAME} ${MINIO_HOST} ${MINIO_ACCESS_KEY} ${MINIO_SECRE
 mc ping ${MINIO_ALIAS_NAME}
 
 # Example output:
-#   1: http://192.168.131.56:32571:32571   min=98.86ms    max=98.86ms    average=98.86ms    errors=0   roundtrip=98.86ms 
-#   2: http://192.168.131.56:32571:32571   min=29.57ms    max=98.86ms    average=64.21ms    errors=0   roundtrip=29.57ms 
-#   3: http://192.168.131.56:32571:32571   min=29.57ms    max=98.86ms    average=52.77ms    errors=0   roundtrip=29.88ms 
+#   1: http://192.168.131.56:32571:32571   min=98.86ms    max=98.86ms    average=98.86ms    errors=0   roundtrip=98.86ms
+#   2: http://192.168.131.56:32571:32571   min=29.57ms    max=98.86ms    average=64.21ms    errors=0   roundtrip=29.57ms
+#   3: http://192.168.131.56:32571:32571   min=29.57ms    max=98.86ms    average=52.77ms    errors=0   roundtrip=29.88ms
 ```
 
 If you can successfully ping the MinIO instance, it means mc is configured correctly.
@@ -205,6 +205,104 @@ kubectl wait --for=condition=ready pod -n ${HARBOR_NAMESPACE} ${HARBOR_NAME}-bac
 # pod/xxxx-harbor-backup-pod condition met
 ```
 
+#### Create Backup Volume Policy
+
+Volume policy is used to specify the backup method for PVCs. The default policy is to backup PVCs using the `fs-backup` method.
+
+```bash
+export BACKUP_POLICY_NAME=${BACKUP_POLICY_NAME:-harbor-backup}
+export VELERO_BACKUP_REPO_NAME=${VELERO_BACKUP_REPO_NAME:-backup}
+
+kubectl apply -f - <<EOF
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ${BACKUP_POLICY_NAME}-volume-policy
+  namespace: cpaas-system
+data:
+  resourcepolicies: |
+    version: v1
+    volumePolicies:
+      - conditions:
+          csi: {}
+        action:
+          type: fs-backup
+      - conditions:
+          csi: {}
+        action:
+          type: fs-backup
+EOF
+
+# Output
+# configmap/harbor-backup-volume-policy created
+```
+
+If the PVC supports snapshot, you can use snapshot to backup pvc to speed up backup. You need to modify the volume policy configmap to specify that the storage class uses snapshot for backup. For example, if the `ceph` storage class supports snapshot backup, you need to add the following configuration (the added condition should be placed at the top to get higher priority):
+
+[How to determine if the PVC supports snapshot?](./04_backup_and_restore_using_velero.mdx#how_to_determine_if_the_pvc_supports_snapshot)
+
+:::warning
+
+**If you use pvc snapshot backup, you cannot change the storage class when restoring. Please adjust the storage class according to the actual situation.**
+
+:::
+
+```diff
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: ${BACKUP_POLICY_NAME}-volume-policy
+  namespace: cpaas-system
+data:
+  resourcepolicies: |
+    version: v1
+    volumePolicies:
++      - conditions:
++          storageClass:
++            - ceph
++        action:
++          type: snapshot
+      - conditions:
+          csi: {}
+        action:
+          type: fs-backup
+      - conditions:
+          csi: {}
+        action:
+          type: fs-backup
+```
+
+:::warning
+
+If the velero is not enabled CSI snapshot, you will get the following error when backup:
+
+```
+Skip action velero.io/csi-pvc-backupper for resource persistentvolumeclaims:xxx, because the CSI feature is not enabled.
+```
+
+To fix this, you need to add `--features=EnableCSI` parameter to the velero deployment.
+
+```diff
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: velero
+spec:
+  template:
+    spec:
+      containers:
+      - args:
+        - server
+        - --uploader-type=restic
++        - --features=EnableCSI
+        - --namespace=cpaas-system
+        command:
+        - /velero
+        name: velero
+```
+
+:::
+
 #### Execute Backup
 
 Run the following commands to create a backup schedule and trigger a backup job:
@@ -228,6 +326,9 @@ spec:
     - ${HARBOR_NAMESPACE}
     includedResources:
     - '*'
+    resourcePolicy:
+      kind: configmap
+      name: ${BACKUP_POLICY_NAME}-volume-policy
     storageLocation: ${VELERO_BACKUP_REPO_NAME}
     ttl: 720h0m0s
 EOF
@@ -249,6 +350,9 @@ spec:
   includedResources:
     - "*"
   itemOperationTimeout: 4h0m0s
+  resourcePolicy:
+    kind: configmap
+    name: ${BACKUP_POLICY_NAME}-volume-policy
   snapshotMoveData: false
   storageLocation: ${VELERO_BACKUP_REPO_NAME}
   ttl: 720h0m0s
@@ -462,6 +566,8 @@ spec:
     - secrets
     - pods
     - harbors.operator.alaudadevops.io
+    - volumesnapshots
+    - volumesnapshotcontents
   itemOperationTimeout: 10h0m0s
   namespaceMapping:
     ${HARBOR_NAMESPACE}: ${NEW_HARBOR_NAMESPACE}
@@ -551,3 +657,47 @@ After the instance status returns to normal, log in to HARBOR to check whether t
 
 At the same time, disable the read-only mode for the restored Harbor instance (log in to Harbor and uncheck Administration -> Configuration -> System Settings -> Repository Read Only).
 
+## Q & A
+
+### How to determine if the PVC supports snapshot? \{#how_to_determine_if_the_pvc_supports_snapshot}
+
+To determine whether a PVC supports snapshot, you need to check if its underlying StorageClass supports snapshot functionality. A PVC supports snapshot if there is a VolumeSnapshotClass in the cluster whose `driver` matches the StorageClass's `provisioner`. If such a VolumeSnapshotClass exists, the StorageClass (and therefore the PVC) supports snapshot functionality.
+
+**Example Configuration:**
+
+```
+apiVersion: storage.k8s.io/v1
+kind: StorageClass
+metadata:
+  name: ceph
+provisioner: rook-ceph.cephfs.csi.ceph.com
+parameters:
+  clusterID: rook-ceph
+  csi.storage.k8s.io/controller-expand-secret-name: rook-csi-cephfs-provisioner
+  csi.storage.k8s.io/controller-expand-secret-namespace: rook-ceph
+  csi.storage.k8s.io/node-stage-secret-name: rook-csi-cephfs-node
+  csi.storage.k8s.io/node-stage-secret-namespace: rook-ceph
+  csi.storage.k8s.io/provisioner-secret-name: rook-csi-cephfs-provisioner
+  csi.storage.k8s.io/provisioner-secret-namespace: rook-ceph
+  fsName: cephfs
+  pool: cephfs-data0
+reclaimPolicy: Delete
+volumeBindingMode: Immediate
+allowVolumeExpansion: true
+---
+apiVersion: snapshot.storage.k8s.io/v1
+kind: VolumeSnapshotClass
+metadata:
+  name: csi-cephfs-snapshotclass
+deletionPolicy: Delete
+driver: rook-ceph.cephfs.csi.ceph.com
+parameters:
+  clusterID: rook-ceph
+  csi.storage.k8s.io/snapshotter-secret-name: rook-csi-cephfs-provisioner
+  csi.storage.k8s.io/snapshotter-secret-namespace: rook-ceph
+```
+
+**Key Points:**
+- StorageClass `provisioner` must exactly match VolumeSnapshotClass `driver`
+- Both resources must exist in the cluster
+- The CSI driver must support snapshot operations

docs/en/howto/05_template.mdx

@@ -21,6 +21,8 @@ The tool deployment template is defined and managed through the ConfigMap resour
 2. UI dynamic form: Defines the form items that the user needs to fill in when deploying the tool
 3. Deployment template: Contains the specific resource definitions required for tool deployment
 
+{/* lint ignore code-block-split-list */}
+
 ```yaml
 apiVersion: v1
 kind: ConfigMap

docs/en/trouble_shooting/01_modify_project_permissions_error.mdx

@@ -37,7 +37,7 @@ rfr-acl-harbor-harbor-demo1-redis-operator   harbor-harbor-demo1-redis   operato
 
 ```
 
-- before changed
+Before changed:
 
 ``` yaml
 # ...
@@ -55,7 +55,7 @@ status:
 ```
 
 
-- after changed
+After changed:
 
 ``` yaml
 # ...
@@ -83,4 +83,3 @@ Due to the `keys` command scanning all indexes and causing the Redis service to
 ## Related Content
 
 - https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/
-

docs/en/upgrade/01_upgrade_2.6.4_to_2.12.md

@@ -289,6 +289,8 @@ If the original instance is deployed with a storage class, the PVC names are fix
 * registry: `<instance name>-harbor-registry`
 * trivy: `data-<instance name>-harbor-trivy-0`
 
+<!-- lint ignore code-block-split-list -->
+
 ```yaml
 # New instance configuration
 helmValues:
@@ -391,10 +393,10 @@ helmValues:
 
 1. Check all Pod statuses:
 
-```bash
-export INSTANCE_NAME=<harbor instance name> INSTANCE_NAMESPACE=<harbor instance namespace>
-kubectl get pods -n ${INSTANCE_NAMESPACE} -l release=${INSTANCE_NAME}
-```
+    ```bash
+    export INSTANCE_NAME=<harbor instance name> INSTANCE_NAMESPACE=<harbor instance namespace>
+    kubectl get pods -n ${INSTANCE_NAMESPACE} -l release=${INSTANCE_NAME}
+    ```
 
 2. Verify Harbor service is accessible:
     * Access Harbor Web UI, verify existing projects and images are visible

package.json

@@ -1,11 +1,12 @@
 {
   "devDependencies": {
-    "@alauda/doom": "^0.23.5",
-    "typescript": "^5.8.2"
+    "@alauda/doom": "^1.10.9",
+    "typescript": "^5.9.2"
   },
   "scripts": {
     "dev": "doom dev",
     "build": "doom build",
+    "lint": "doom lint",
     "serve": "doom serve",
     "translate": "doom translate"
   },