Allow to pass a PV as storage

This change allows to use an user managed pv to use as results store. We might use different strategies at the end.
openstack-k8s-operators · Oct 30, 2023 · f70e467 · f70e467
1 parent b18652f
commit f70e467
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 5 deletions.
diff --git a/api/bases/test.openstack.org_tempests.yaml b/api/bases/test.openstack.org_tempests.yaml
@@ -35,6 +35,9 @@ spec:
           spec:
             description: TempestSpec defines the desired state of Tempest
             properties:
+              PersistentVolumePath:
+                description: subdirectory on the volume to use
+                type: string
               backoffLimit:
                 default: 0
                 description: BackoffLimimt allows to define the maximum number of
@@ -109,6 +112,23 @@ spec:
                 description: OpenStackConfigSecret is the name of the Secret containing
                   the secure.yaml
                 type: string
+              persistentVolumeClaim:
+                description: persistentVolumeClaimVolumeSource represents a reference
+                  to a PersistentVolumeClaim in the same namespace. Usable for storing
+                  test results.
+                properties:
+                  claimName:
+                    description: 'claimName is the name of a PersistentVolumeClaim
+                      in the same namespace as the pod using this volume. More info:
+                      https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+                    type: string
+                  readOnly:
+                    description: readOnly Will force the ReadOnly setting in VolumeMounts.
+                      Default false.
+                    type: boolean
+                required:
+                - claimName
+                type: object
               tempestRun:
                 description: TempestSpec TempestRun parts
                 properties:

diff --git a/api/v1beta1/tempest_types.go b/api/v1beta1/tempest_types.go
@@ -19,6 +19,7 @@ package v1beta1
 import (
 	"github.com/openstack-k8s-operators/lib-common/modules/common/condition"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/endpoint"
+        corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -62,6 +63,15 @@ type TempestSpec struct {
 	// Tempest Container Image URL (will be set to environmental default if empty)
 	ContainerImage string `json:"containerImage"`
 
+	// +kubebuilder:validation:Optional
+	// persistentVolumeClaimVolumeSource represents a reference to a
+	// PersistentVolumeClaim in the same namespace. Usable for storing test results.
+        PersistentVolumeClaim *corev1.PersistentVolumeClaimVolumeSource `json:"persistentVolumeClaim,omitempty"`
+
+	// +kubebuilder:validation:Optional
+        // subdirectory on the volume to use
+        PersistentVolumePath string `json:"PersistentVolumePath"`
+
 	// +kubebuilder:validation:Optional
 	// NodeSelector to target subset of worker nodes running this service
 	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/test.openstack.org_tempests.yaml b/config/crd/bases/test.openstack.org_tempests.yaml
@@ -35,6 +35,9 @@ spec:
           spec:
             description: TempestSpec defines the desired state of Tempest
             properties:
+              PersistentVolumePath:
+                description: subdirectory on the volume to use
+                type: string
               backoffLimit:
                 default: 0
                 description: BackoffLimimt allows to define the maximum number of
@@ -109,6 +112,23 @@ spec:
                 description: OpenStackConfigSecret is the name of the Secret containing
                   the secure.yaml
                 type: string
+              persistentVolumeClaim:
+                description: persistentVolumeClaimVolumeSource represents a reference
+                  to a PersistentVolumeClaim in the same namespace. Usable for storing
+                  test results.
+                properties:
+                  claimName:
+                    description: 'claimName is the name of a PersistentVolumeClaim
+                      in the same namespace as the pod using this volume. More info:
+                      https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+                    type: string
+                  readOnly:
+                    description: readOnly Will force the ReadOnly setting in VolumeMounts.
+                      Default false.
+                    type: boolean
+                required:
+                - claimName
+                type: object
               tempestRun:
                 description: TempestSpec TempestRun parts
                 properties:

diff --git a/pkg/tempest/job.go b/pkg/tempest/job.go
@@ -25,6 +25,11 @@ func Job(
 		envVars["TEMPEST_CONCURRENCY"] = env.SetValue("0")
 	}
 
+	// NOTE: validate also having pv ?
+	// When having PV the path also should work when the home dir is different
+	if instance.Spec.PersistentVolumePath != "" {
+		envVars["TEMPEST_OUTPUTDIR"] = env.SetValue("/var/lib/tempest/output" + instance.Spec.PersistentVolumePath)
+	}
 	job := &batchv1.Job{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      instance.Name,
@@ -51,7 +56,7 @@ func Job(
 							},
 							Args:         []string{},
 							Env:          env.MergeEnvs([]corev1.EnvVar{}, envVars),
-							VolumeMounts: GetVolumeMounts(),
+							VolumeMounts: GetVolumeMounts(instance),
 						},
 					},
 					Volumes: GetVolumes(instance),

diff --git a/pkg/tempest/volumes.go b/pkg/tempest/volumes.go
@@ -12,7 +12,13 @@ func GetVolumes(instance *testv1beta1.Tempest) []corev1.Volume {
 	var scriptsVolumeConfidentialMode int32 = 0420
 
 	//source_type := corev1.HostPathDirectoryOrCreate
-	return []corev1.Volume{
+	volumes := []corev1.Volume{
+		corev1.Volume{
+			Name: "results",
+			VolumeSource: corev1.VolumeSource{
+				PersistentVolumeClaim: instance.Spec.PersistentVolumeClaim,
+			},
+		},
 		{
 			Name: "etc-machine-id",
 			VolumeSource: corev1.VolumeSource{
@@ -72,12 +78,22 @@ func GetVolumes(instance *testv1beta1.Tempest) []corev1.Volume {
 			},
 		},
 	}
+	if instance.Spec.PersistentVolumeClaim != nil {
+		return volumes
+	} else {
+		return volumes[1:]
+	}
 
 }
 
 // GetVolumeMounts -
-func GetVolumeMounts() []corev1.VolumeMount {
-	return []corev1.VolumeMount{
+func GetVolumeMounts(instance *testv1beta1.Tempest) []corev1.VolumeMount {
+	volumes := []corev1.VolumeMount{
+		{
+			Name:      "results",
+			MountPath: "/var/lib/tempest/output",
+			ReadOnly:  false,
+		},
 		{
 			Name:      "etc-machine-id",
 			MountPath: "/etc/machine-id",
@@ -111,4 +127,9 @@ func GetVolumeMounts() []corev1.VolumeMount {
 			SubPath:   "secure.yaml",
 		},
 	}
+	if instance.Spec.PersistentVolumeClaim != nil {
+		return volumes
+	} else {
+		return volumes[1:]
+	}
 }
diff --git a/templates/tempest/bin/invoke_tempest b/templates/tempest/bin/invoke_tempest
@@ -4,7 +4,7 @@ set -x
 TEMPEST_DIR=$HOME/openshift
 OPERATOR_ETC=/etc/test_operator
 # NOTE: might be backed with a PV
-OUTPUT_PATH=$HOME/output
+OUTPUT_PATH=${TEMPEST_OUTPUTDIR:-$HOME/output}
 
 cd "$HOME"