Merge pull request #217 from lpiwowar/bugfix/update-privileged-documentation

[docs] Add documentation for privileged parameter

Author: openshift-merge-bot[bot]

config/samples/test_v1beta1_ansibletest.yaml

@@ -20,6 +20,18 @@ spec:
     ---
     # Use exist cloud resources
     somevar: somevalue
+
+  # Privileged
+  # ----------
+  #
+  # Use with caution! This parameter specifies whether test-operator should spawn test
+  # pods with allowedPrivilegedEscalation: true and the default capabilities on
+  # top of capabilities that are usually needed by the test pods (NET_ADMIN, NET_RAW).
+  # This parameter is deemed insecure but it is needed for certain test-operator
+  # functionalities to work properly (e.g.: extraRPMs in Tempest CR, or certain set
+  # of tobiko tests).
+  #
+  # privileged: false
   workflow:
     - stepName: beststep
       ansibleExtraVars: ' -e manual_run=false '

config/samples/test_v1beta1_horizontest.yaml

@@ -54,3 +54,15 @@ spec:
 
   # The maximum number of retry executions (optional)
   backoffLimit: 0
+
+  # Privileged
+  # ----------
+  #
+  # Use with caution! This parameter specifies whether test-operator should spawn test
+  # pods with allowedPrivilegedEscalation: true and the default capabilities on
+  # top of capabilities that are usually needed by the test pods (NET_ADMIN, NET_RAW).
+  # This parameter is deemed insecure but it is needed for certain test-operator
+  # functionalities to work properly (e.g.: extraRPMs in Tempest CR, or certain set
+  # of tobiko tests).
+  #
+  # privileged: false

config/samples/test_v1beta1_tempest.yaml

@@ -27,6 +27,17 @@ spec:
   # the private key in ssh-privatekey field of the secret.
   #
   # SSHKeySecretName: secret_name
+
+  # Privileged
+  # ----------
+  # Use with caution! This parameter specifies whether test-operator should spawn test
+  # pods with allowedPrivilegedEscalation: true and the default capabilities on
+  # top of capabilities that are usually needed by the test pods (NET_ADMIN, NET_RAW).
+  # This parameter is deemed insecure but it is needed for certain test-operator
+  # functionalities to work properly (e.g.: extraRPMs in Tempest CR, or certain set
+  # tobiko tests).
+  #
+  # privileged: false
   tempestRun:
     # NOTE: All parameters have default values (use only when you want to override
     #       the default behaviour)

config/samples/test_v1beta1_tobiko.yaml

@@ -6,6 +6,19 @@ metadata:
   namespace: openstack
 spec:
   containerImage: ""
+
+  # Privileged
+  # ----------
+  #
+  # Use with caution! This parameter specifies whether test-operator should spawn test
+  # pods with allowedPrivilegedEscalation: true and the default capabilities on
+  # top of capabilities that are usually needed by the test pods (NET_ADMIN, NET_RAW).
+  # This parameter is deemed insecure but it is needed for certain test-operator
+  # functionalities to work properly (e.g.: extraRPMs in Tempest CR, or certain set
+  # of tobiko tests).
+  #
+  # privileged: false
+
   # storageClass: local-storage
   # parallel: false
   # debug: false