docs(CNV-53188): improve disk-uploader usage guidance

Add more details to explain an usage of EXPORT_SOURCE_KIND. Also, Add an example of the Secret object, that will be referenced by SECRET_NAME. Signed-off-by: Ben Oukhanov <[email protected]>
kubevirt · Jan 6, 2025 · ebc66cc · ebc66cc
1 parent 8dea0da
commit ebc66cc
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 3 deletions.
diff --git a/configs/disk-uploader.yaml b/configs/disk-uploader.yaml
@@ -1,4 +1,5 @@
 task_name: disk-uploader
+secret_task_name: disk-uploader-secret
 task_category: disk-uploader
 main_image: quay.io/kubevirt/tekton-tasks
 nice_name: disk uploader
diff --git a/release/tasks/disk-uploader/README.md b/release/tasks/disk-uploader/README.md
@@ -12,7 +12,7 @@ When user runs [KubeVirt Tekton Tasks](https://github.com/kubevirt/kubevirt-tekt
 
 ### Parameters
 
-- **EXPORT_SOURCE_KIND**: The name of the export source kind
+- **EXPORT_SOURCE_KIND**: Specify the export source kind (vm, vmsnapshot, pvc)
 - **EXPORT_SOURCE_NAME**: The name of the export source
 - **VOLUME_NAME**: The volume name (If source kind is PVC, then volume name is equal to source name)
 - **IMAGE_DESTINATION**: Destination of the image in container registry
@@ -21,6 +21,21 @@ When user runs [KubeVirt Tekton Tasks](https://github.com/kubevirt/kubevirt-tekt
 
 ### Usage
 
+Secret of the task run:
+```
+apiVersion: v1
+data:
+    accessKeyId: <ACCESS_KEY_ID>
+    secretKey: <SECRET_KEY>
+kind: Secret
+metadata:
+    name: disk-uploader-credentials
+type: Opaque
+
+```
+
+Get `ACCESS_KEY_ID` or `SECRET_KEY` by running: `echo -n "<REGISTRY_USERNAME_OR_PASSWORD>" | base64`.
+
 Task run using resolver:
 ```
 apiVersion: tekton.dev/v1
@@ -39,6 +54,8 @@ spec:
         value: quay.io/kubevirt/example-vm-exported:latest
     -   name: PUSH_TIMEOUT
         value: 120
+    -   name: SECRET_NAME
+        value: disk-uploader-credentials
     taskRef:
         params:
         -   name: catalog

diff --git a/release/tasks/disk-uploader/disk-uploader.yaml b/release/tasks/disk-uploader/disk-uploader.yaml
@@ -24,7 +24,7 @@ spec:
     to be used in multiple Kubernetes clusters.
   params:
   - name: EXPORT_SOURCE_KIND
-    description: The name of the export source kind
+    description: Specify the export source kind (vm, vmsnapshot, pvc)
     type: string
   - name: EXPORT_SOURCE_NAME
     description: The name of the export source

diff --git a/release/tasks/disk-uploader/examples/taskruns/disk-uploader-secret.yaml b/release/tasks/disk-uploader/examples/taskruns/disk-uploader-secret.yaml
@@ -0,0 +1,9 @@
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: disk-uploader-credentials
+type: Opaque
+data:
+  accessKeyId: "<ACCESS_KEY_ID>"
+  secretKey: "<SECRET_KEY>"
diff --git a/release/tasks/disk-uploader/examples/taskruns/disk-uploader-taskrun-resolver.yaml b/release/tasks/disk-uploader/examples/taskruns/disk-uploader-taskrun-resolver.yaml
@@ -27,3 +27,5 @@ spec:
     value: quay.io/kubevirt/example-vm-exported:latest
   - name: PUSH_TIMEOUT
     value: 120
+  - name: SECRET_NAME
+    value: disk-uploader-credentials
diff --git a/templates/disk-uploader/examples/disk-uploader-taskrun.yaml b/templates/disk-uploader/examples/disk-uploader-taskrun.yaml
@@ -27,3 +27,5 @@ spec:
     value: quay.io/kubevirt/example-vm-exported:latest
   - name: PUSH_TIMEOUT
     value: 120
+  - name: SECRET_NAME
+    value: disk-uploader-credentials
diff --git a/templates/disk-uploader/generate-task.yaml b/templates/disk-uploader/generate-task.yaml
@@ -36,6 +36,13 @@
         mode: "{{ default_file_mode }}"
       with_items:
         - { taskrun_with_flavor_name: "{{ task_name }}-taskrun-resolver"}
+    - name: Generate example secret of the task
+      template:
+        src: "{{ examples_templates_dir }}/{{ secret_task_name }}.yaml"
+        dest: "{{ examples_taskruns_output_dir }}/{{ item.secret_task_with_flavor_name }}.yaml"
+        mode: "{{ default_file_mode }}"
+      with_items:
+        - { secret_task_with_flavor_name: "{{ secret_task_name }}"}
     - name: Generate README
       template:
         src: "{{ readmes_templates_dir }}/README.md"
@@ -46,6 +53,8 @@
         task_yaml: "{{ lookup('file', task_path) | from_yaml }}"
         task_run_resolver_path: "{{ examples_taskruns_output_dir }}/{{ task_name }}-taskrun-resolver.yaml"
         task_run_resolver_yaml: "{{ lookup('file', task_run_resolver_path) | from_yaml }}"
+        secret_task_path: "{{ examples_taskruns_output_dir }}/{{ secret_task_name }}.yaml"
+        secret_task_yaml: "{{ lookup('file', secret_task_path) | from_yaml }}"
     - name: "Delete readme tmp directory"
       file:
         path: "{{ readme_output_dir_tmp }}"

diff --git a/templates/disk-uploader/manifests/disk-uploader.yaml b/templates/disk-uploader/manifests/disk-uploader.yaml
@@ -24,7 +24,7 @@ spec:
     to be used in multiple Kubernetes clusters.
   params:
   - name: EXPORT_SOURCE_KIND
-    description: The name of the export source kind
+    description: Specify the export source kind (vm, vmsnapshot, pvc)
     type: string
   - name: EXPORT_SOURCE_NAME
     description: The name of the export source

diff --git a/templates/disk-uploader/readmes/README.md b/templates/disk-uploader/readmes/README.md
@@ -18,6 +18,13 @@ When user runs [KubeVirt Tekton Tasks](https://github.com/kubevirt/kubevirt-tekt
 
 ### Usage
 
+Secret of the task run:
+```
+{{ secret_task_yaml | to_nice_yaml }}
+```
+
+Get `ACCESS_KEY_ID` or `SECRET_KEY` by running: `echo -n "<REGISTRY_USERNAME_OR_PASSWORD>" | base64`.
+
 Task run using resolver:
 ```
 {{ task_run_resolver_yaml | to_nice_yaml }}