Merge pull request #235 from opokornyy/deprecate-task

Add deprecation annotations
kubevirt · Mar 30, 2023 · b06402a · b06402a
2 parents eb1c772 + 159ce61
commit b06402a
Show file tree

Hide file tree

Showing 14 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -38,6 +38,8 @@ Visit [RBAC permissions for running the tasks](docs/tasks-rbac-permissions.md) i
 
 ## Usage
 
+#### copy-template, modify-vm-template and create-vm-from-template tasks are deprecated and will be removed in future versions. These tasks based on templates will be replaced with create-vm task with enhancements related to instance types.
+
 #### Create Virtual Machines
 
 - [create-vm-from-manifest](tasks/create-vm-from-manifest)

diff --git a/manifests/okd/kubevirt-tekton-tasks-okd.yaml b/manifests/okd/kubevirt-tekton-tasks-okd.yaml
diff --git a/tasks/copy-template/README.md b/tasks/copy-template/README.md
diff --git a/tasks/copy-template/manifests/copy-template.yaml b/tasks/copy-template/manifests/copy-template.yaml
diff --git a/tasks/create-vm-from-template/README.md b/tasks/create-vm-from-template/README.md
diff --git a/tasks/create-vm-from-template/manifests/create-vm-from-template.yaml b/tasks/create-vm-from-template/manifests/create-vm-from-template.yaml
diff --git a/tasks/modify-vm-template/README.md b/tasks/modify-vm-template/README.md
diff --git a/tasks/modify-vm-template/manifests/modify-vm-template.yaml b/tasks/modify-vm-template/manifests/modify-vm-template.yaml
diff --git a/templates/copy-template/manifests/copy-template.yaml b/templates/copy-template/manifests/copy-template.yaml
@@ -3,6 +3,7 @@ apiVersion: tekton.dev/v1beta1
 kind: ClusterTask
 metadata:
   annotations:
+    tekton.dev/deprecated: "true"
     task.kubevirt.io/associatedServiceAccount: {{ sa_name }}
     sourceTemplateName.params.task.kubevirt.io/kind: {{ task_param_types.template_kind }}
     sourceTemplateName.params.task.kubevirt.io/apiVersion: {{ task_param_types.template_version }}

diff --git a/templates/copy-template/readmes/README.md b/templates/copy-template/readmes/README.md
@@ -1,5 +1,7 @@
 # Copy okd template Task
 
+#### Task is deprecated and will be removed in future versions.
+
 This task copies a template.
 A bundle of predefined templates to use can be found in [Common Templates](https://github.com/kubevirt/common-templates) project.
 

diff --git a/templates/create-vm-from-manifest/manifests/create-vm.yaml b/templates/create-vm-from-manifest/manifests/create-vm.yaml
@@ -10,6 +10,7 @@ metadata:
     manifest.params.task.kubevirt.io/apiVersion: {{ task_param_types.vm_version }}
     namespace.params.task.kubevirt.io/type: {{ task_param_types.namespace }}
 {% elif task_name == "create-vm-from-template" %}
+    tekton.dev/deprecated: "true"
     templateName.params.task.kubevirt.io/type: {{ task_param_types.vm_template_name }}
     templateName.params.task.kubevirt.io/kind: {{ task_param_types.template_kind }}
     templateName.params.task.kubevirt.io/apiVersion: {{ task_param_types.template_version }}

diff --git a/templates/create-vm-from-template/readmes/README.md b/templates/create-vm-from-template/readmes/README.md
@@ -1,5 +1,7 @@
 # Create VirtualMachine from OKD Template Task
 
+#### Task is deprecated and will be removed in future versions.
+
 This task creates a VirtualMachine from OKD Template.
 Virtual machines can be described and parametrized in a generic form with these templates.
 A bundle of predefined templates to use can be found in [Common Templates](https://github.com/kubevirt/common-templates) project.

diff --git a/templates/modify-vm-template/manifests/modify-vm-template.yaml b/templates/modify-vm-template/manifests/modify-vm-template.yaml
@@ -3,6 +3,7 @@ apiVersion: tekton.dev/v1beta1
 kind: ClusterTask
 metadata:
   annotations:
+    tekton.dev/deprecated: "true"
     task.kubevirt.io/associatedServiceAccount: {{ sa_name }}
     templateName.params.task.kubevirt.io/kind: {{ task_param_types.template_kind }}
     templateName.params.task.kubevirt.io/apiVersion: {{ task_param_types.template_version }}

diff --git a/templates/modify-vm-template/readmes/README.md b/templates/modify-vm-template/readmes/README.md
@@ -1,5 +1,7 @@
 # Modify OpenShift template Task
 
+#### Task is deprecated and will be removed in future versions.
+
 This task modifies template.
 A bundle of predefined templates to use can be found in [Common Templates](https://github.com/kubevirt/common-templates) project.