Skip to content

Commit deb0713

Browse files
kstrenkovasdatko
authored andcommitted
Add warning for ExtraConfigmapsMounts deprecation
Now that test-operator supports ExtraMounts parameter, there is no need for a parameter adding extra configmap mounts. It can be directly done through ExtraMounts, so I think of it as a duplicate code. But it is not a good practice to remove parameters right away, so I am first adding warning for users who might be using extraConfigmapsMounts parameters about its deprecation. Let's remove it after this warning is old enough.
1 parent 52d01a3 commit deb0713

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

roles/test_operator/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ cifmw_test_operator_stages:
8585
* `cifmw_test_operator_tempest_extra_images`: (List) A list of images that should be uploaded to OpenStack before the tests are executed. The value is passed to extraImages parameter in the [Tempest CR](https://openstack-k8s-operators.github.io/test-operator/crds.html#tempest-custom-resource). Default value: `[]`
8686
* `cifmw_test_operator_tempest_network_attachments`: (List) List of network attachment definitions to attach to the tempest pods spawned by test-operator. Default value: `[]`.
8787
* `cifmw_test_operator_tempest_extra_rpms`: (List) . A list of URLs that point to RPMs that should be installed before the execution of tempest. Note that this parameter has no effect when `cifmw_test_operator_tempest_external_plugin` is used. Default value: `[]`
88-
* `cifmw_test_operator_tempest_extra_configmaps_mounts`: (List) A list of configmaps that should be mounted into the tempest test pods. Default value: `[]`
88+
* `cifmw_test_operator_tempest_extra_configmaps_mounts`: WARNING: This parameter will be deprecated! Please use `cifmw_test_operator_tempest_extra_mounts` parameter instead. (List) A list of configmaps that should be mounted into the tempest test pods. Default value: `[]`
8989
* `cifmw_test_operator_tempest_extra_mounts`: (List) A list of additional volume mounts for the tempest test pods. Each item specifies a volume name, mount path, and other mount properties. Default value: `[]`
9090
* `cifmw_test_operator_tempest_debug`: (Bool) Run Tempest in debug mode, it keeps the operator pod sleeping infinity (it must only set to `true`only for debugging purposes). Default value: `false`
9191
* `cifmw_test_operator_tempest_rerun_failed_tests`: (Bool) Activate tempest re-run feature. When activated, tempest will perform another run of the tests that failed during the first execution. Default value: `false`
@@ -196,7 +196,7 @@ Default value: {}
196196
* `cifmw_test_operator_ansibletest_openstack_config_secret`: (String) The name of the Secret containing the secure.yaml. Default value: "openstack-config-secret"
197197
* `cifmw_test_operator_ansibletest_debug`: (Bool) Run ansible playbook with -vvvv. Default value: `false`
198198
* `cifmw_test_operator_ansibletest_workflow`: (List) A parameter that contains a workflow definition. Default value: `[]`
199-
* `cifmw_test_operator_ansibletest_extra_configmaps_mounts`: (List) Extra configmaps for mounting in the pod. Default value: `[]`
199+
* `cifmw_test_operator_ansibletest_extra_configmaps_mounts`: WARNING: This parameter will be deprecated! Please use `cifmw_test_operator_ansibletest_extra_mounts` parameter instead. (List) Extra configmaps for mounting in the pod. Default value: `[]`
200200
* `cifmw_test_operator_ansibletest_extra_mounts`: (List) A list of additional volume mounts for the ansibletest test pods. Each item specifies a volume name, mount path, and other mount properties. Default value: `[]`
201201
* `cifmw_test_operator_ansibletest_resources`: (Dict) A dictionary that specifies resources (cpu, memory) for the test pods. When kept untouched it defaults to the resource limits specified on the test-operator side. Default value: `{}`
202202
* `cifmw_test_operator_ansibletest_config`: Definition of AnsibleTest CRD instance that is passed to the test-operator (see [the test-operator documentation](https://openstack-k8s-operators.github.io/test-operator/crds.html)). Default value:

roles/test_operator/defaults/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ cifmw_test_operator_tempest_config:
149149
networkAttachments: "{{ stage_vars_dict.cifmw_test_operator_tempest_network_attachments }}"
150150
tolerations: "{{ cifmw_test_operator_tolerations | default(omit) }}"
151151
nodeSelector: "{{ cifmw_test_operator_node_selector | default(omit) }}"
152+
# Note: This parameter will be deprecated! Please use cifmw_test_operator_tempest_extra_mounts parameter instead
152153
extraConfigmapsMounts: "{{ stage_vars_dict.cifmw_test_operator_tempest_extra_configmaps_mounts | default(omit) }}"
153154
extraMounts: "{{ stage_vars_dict.cifmw_test_operator_tempest_extra_mounts | default(omit) }}"
154155
resources: "{{ stage_vars_dict.cifmw_test_operator_tempest_resources | default(omit) }}"
@@ -251,6 +252,7 @@ cifmw_test_operator_ansibletest_config:
251252
spec:
252253
SELinuxLevel: "{{ cifmw_test_operator_selinux_level }}"
253254
containerImage: "{{ stage_vars_dict.cifmw_test_operator_ansibletest_image }}:{{ stage_vars_dict.cifmw_test_operator_ansibletest_image_tag }}"
255+
# Note: This parameter will be deprecated! Please use cifmw_test_operator_ansibletest_extra_mounts parameter instead
254256
extraConfigmapsMounts: "{{ stage_vars_dict.cifmw_test_operator_ansibletest_extra_configmaps_mounts }}"
255257
extraMounts: "{{ stage_vars_dict.cifmw_test_operator_ansibletest_extra_mounts | default(omit) }}"
256258
storageClass: "{{ cifmw_test_operator_storage_class }}"

0 commit comments

Comments
 (0)