Verify file_storage definition w/out storage_class

closes: #946

Author: git-hyagi

.ci/scripts/galaxy_ng-tests.sh

@@ -6,16 +6,9 @@ SERVER=$(hostname)
 WEB_PORT="24817"
 if [[ "$1" == "--minikube" ]] || [[ "$1" == "-m" ]]; then
   KUBE="minikube"
-  SERVER="localhost"
-  if [[ "$CI_TEST" == "true" ]]; then
-    SVC_NAME="galaxy-example-web-svc"
-    WEB_PORT="24880"
-    API_SVC="galaxy-example-api-svc"
-    API_PORT="24817"
-    kubectl port-forward service/$SVC_NAME $WEB_PORT:$WEB_PORT &
-    kubectl port-forward service/$API_SVC $API_PORT:$API_PORT &
-    echo 127.0.0.1   galaxy-example-api-svc.pulp-operator-system.svc.cluster.local| sudo tee -a /etc/hosts
-  fi
+  WEB_PORT=30000
+  SERVER=nodeport.local
+  echo $(minikube ip) nodeport.local | sudo tee -a /etc/hosts
 fi
 
 pip install ansible
@@ -58,11 +51,11 @@ done
 echo "Pulling ..."
 podman pull quay.io/pulp/pulp-operator:devel
 echo "Login ..."
-podman login --tls-verify=false -u admin -p password localhost:24880
+podman login --tls-verify=false -u admin -p password $SERVER:$WEB_PORT
 echo "Tagging ..."
-podman tag quay.io/pulp/pulp-operator:devel localhost:24880/pulp/pulp-operator:devel
+podman tag quay.io/pulp/pulp-operator:devel $SERVER:$WEB_PORT/pulp/pulp-operator:devel
 echo "Pushing ..."
-podman push --tls-verify=false localhost:24880/pulp/pulp-operator:devel
+podman push --tls-verify=false $SERVER:$WEB_PORT/pulp/pulp-operator:devel
 
 echo "Repositories ..."
 curl -H "Authorization:Token $TOKEN" $BASE_ADDR/api/galaxy/_ui/v1/execution-environments/repositories/ | jq

.github/workflows/ci.yml

@@ -816,10 +816,10 @@ jobs:
           sudo -E docker build -t quay.io/pulp/pulp-operator:go-devel .
           make deploy IMG=quay.io/pulp/pulp-operator:go-devel
           kubectl get pulps.pulp.pulpproject.org
-          kubectl patch pulp example-pulp --type=merge -p '{"spec":{ "api": { "init_container": { "resource_requirements": { "limits": { "cpu": "100m", "memory": "128Mi"  }}}}}}'
-          kubectl patch pulp example-pulp --type=merge -p '{"spec":{ "content": { "init_container": { "resource_requirements": { "limits": { "cpu": "100m", "memory": "128Mi"  }}}}}}'
-          kubectl patch pulp example-pulp --type=merge -p '{"spec":{ "worker": { "init_container": { "resource_requirements": { "limits": { "cpu": "100m", "memory": "128Mi"  }}}}}}'
+          kubectl patch pulp example-pulp --type=merge -p '{"spec":{ "migration_job": { "container": { "resource_requirements": { "requests": { "cpu": 1 }, "limits":{ "cpu": 1} }}  }}}'
           kubectl patch pulp example-pulp --type=merge -p '{"spec":{"nodeport_port": 30000, "pulp_settings": {"TOKEN_SERVER": "http://nodeport.local:30000/token/", "CONTENT_ORIGIN": "http://nodeport.local:30000", "ANSIBLE_API_HOSTNAME": "http://nodeport.local:30000"} }}'
+          kubectl patch pulp example-pulp --type=merge -p '{"spec":{ "pvc": "example-pulp-file-storage" }}'
+          kubectl patch pulp example-pulp --type=json -p="[{'op': 'remove', 'path': '/spec/content/resource_requirements'},{'op': 'remove', 'path': '/spec/worker/resource_requirements'},{'op': 'remove', 'path': '/spec/web/resource_requirements'},{'op': 'remove', 'path': '/spec/file_storage_access_mode'},{'op': 'remove', 'path': '/spec/file_storage_size'}]"
         shell: bash
       - name: Check and wait pulp-operator deploy
         run: kubectl wait --for condition=Pulp-Operator-Finished-Execution pulp/example-pulp --timeout=900s

CHANGES/946.feature

@@ -0,0 +1,2 @@
+Added a check for missing file_storage_storage_class definition whenever
+file_storage_size or file_storage_access_mode is/are provided.

bundle/manifests/pulp-operator.clusterserviceversion.yaml

@@ -189,8 +189,6 @@ metadata:
                 }
               }
             },
-            "file_storage_access_mode": "ReadWriteMany",
-            "file_storage_size": "10Gi",
             "ingress_type": "nodeport",
             "pulp_settings": {
               "allowed_export_paths": [
@@ -201,7 +199,6 @@ metadata:
               ],
               "api_root": "/pulp/"
             },
-            "storage_type": "File",
             "worker": {
               "replicas": 2,
               "resource_requirements": {
@@ -253,15 +250,19 @@ metadata:
             "image_web": "quay.io/pulp/galaxy-web",
             "image_web_version": "4.6.3",
             "ingress_type": "nodeport",
+            "nodeport_port": 30000,
             "pulp_settings": {
               "allowed_export_paths": [
                 "/tmp"
               ],
               "allowed_import_paths": [
                 "/tmp"
               ],
+              "analytics": false,
+              "ansible_api_hostname": "http://nodeport.local:30000",
               "api_root": "/api/galaxy/pulp/",
-              "telemetry": false
+              "content_origin": "http://nodeport.local:30000",
+              "token_server": "http://nodeport.local:30000/token/"
             },
             "signing_scripts_configmap": "signing-scripts",
             "signing_secret": "signing-galaxy",
@@ -324,7 +325,7 @@ metadata:
     capabilities: Full Lifecycle
     categories: Integration & Delivery
     containerImage: quay.io/pulp/pulp-operator:devel
-    createdAt: "2023-08-08T18:04:04Z"
+    createdAt: "2023-08-09T19:33:08Z"
     description: Pulp is a platform for managing repositories of software packages
       and making them available to a large number of consumers.
     operators.operatorframework.io/builder: operator-sdk-v1.29.0

config/samples/galaxy.azure.ci.yaml

@@ -13,18 +13,18 @@ spec:
   signing_scripts_configmap: "signing-scripts"
   storage_type: Azure
   ingress_type: nodeport
+  nodeport_port: 30000
   object_storage_azure_secret: example-pulp-object-storage
-  # k3s local-path requires this
-  file_storage_access_mode: "ReadWriteMany"
-  # We have a little over 10GB free on GHA VMs/instances
-  file_storage_size: "10Gi"
   pulp_settings:
+    token_server: http://nodeport.local:30000/token/
+    content_origin: http://nodeport.local:30000
+    ansible_api_hostname: http://nodeport.local:30000
     api_root: "/api/galaxy/pulp/"
     allowed_export_paths:
       - /tmp
     allowed_import_paths:
       - /tmp
-    telemetry: false
+    analytics: false
   api:
     replicas: 1
   content:

config/samples/galaxy.s3.ci.yaml

@@ -13,19 +13,19 @@ spec:
   signing_scripts_configmap: "signing-scripts"
   storage_type: S3
   ingress_type: nodeport
+  nodeport_port: 30000
   object_storage_s3_secret: example-pulp-object-storage
-  # k3s local-path requires this
-  file_storage_access_mode: "ReadWriteMany"
-  # We have a little over 10GB free on GHA VMs/instances
-  file_storage_size: "10Gi"
   pulp_settings:
+    token_server: http://nodeport.local:30000/token/
+    content_origin: http://nodeport.local:30000
+    ansible_api_hostname: http://nodeport.local:30000
     api_root: "/api/galaxy/pulp/"
     allowed_export_paths:
       - /tmp
     allowed_import_paths:
       - /tmp
     aws_s3_endpoint_url: http://pulp_minio:9000
-    telemetry: false
+    analytics: false
   api:
     replicas: 1
   content:

config/samples/galaxy.yaml

@@ -14,18 +14,22 @@ spec:
   signing_scripts_configmap: "signing-scripts"
   storage_type: File
   ingress_type: nodeport
+  nodeport_port: 30000
   # k3s local-path requires this
   file_storage_access_mode: "ReadWriteMany"
   # We have a little over 10GB free on GHA VMs/instances
   file_storage_size: "10Gi"
   file_storage_storage_class: standard
   pulp_settings:
+    token_server: http://nodeport.local:30000/token/
+    content_origin: http://nodeport.local:30000
+    ansible_api_hostname: http://nodeport.local:30000
     api_root: "/api/galaxy/pulp/"
     allowed_export_paths:
       - /tmp
     allowed_import_paths:
       - /tmp
-    telemetry: false
+    analytics: false
   database:
     postgres_storage_class: standard
   api:

config/samples/repo-manager.pulpproject.org_v1beta2_pulp.yaml

@@ -3,16 +3,13 @@ kind: Pulp
 metadata:
   name: example
 spec:
-  file_storage_access_mode: "ReadWriteMany"
-  file_storage_size: "10Gi"
   ingress_type: nodeport
   pulp_settings:
     api_root: "/pulp/"
     allowed_export_paths:
       - /tmp
     allowed_import_paths:
       - /tmp
-  storage_type: File
   api:
     replicas: 1
   cache:

controllers/repo_manager/precheck.go

@@ -73,6 +73,11 @@ func prechecks(ctx context.Context, r *RepoManagerReconciler, pulp *repomanagerp
 		return reconcile, nil
 	}
 
+	// verify inconsistency in file_storage_* definition
+	if reconcile := checkFileStorage(ctx, r, pulp); reconcile != nil {
+		return reconcile, nil
+	}
+
 	return nil, nil
 }
 
@@ -201,3 +206,23 @@ func checkSecretsAvailability(ctx context.Context, r *RepoManagerReconciler, pul
 	}
 	return nil
 }
+
+// checkFileStorage verifies if there is a file_storage definition but the storage_class is not provided
+// the file_storage_* fields are used to provision the PVC using the provided file_storage_class
+// if no file_storage_class is provided, the other fields will not be useful and can cause confusion
+func checkFileStorage(ctx context.Context, r *RepoManagerReconciler, pulp *repomanagerpulpprojectorgv1beta2.Pulp) *ctrl.Result {
+	if hasFileStorageDefinition(pulp) && len(pulp.Spec.FileStorageClass) == 0 {
+		r.RawLogger.Error(nil, "No file_storage_class provided for the file_storage_{access_mode,size} definition(s)!")
+		r.RawLogger.Error(nil, "Provide a file_storage_storage_class with the file_storage_{access_mode,size} fields to deploy Pulp with persistent data")
+		r.RawLogger.Error(nil, "or remove all file_storage_* fields to deploy Pulp with emptyDir.")
+		return &ctrl.Result{}
+	}
+	return nil
+}
+
+// hasFileStorageDefinition returns true if any file_storage field is defined
+func hasFileStorageDefinition(pulp *repomanagerpulpprojectorgv1beta2.Pulp) bool {
+	// [TODO] check if we should also verify strings.ToLower(pulp.Spec.StorageType) == "file"
+	// not sure if we will deprecate the storageType field
+	return len(pulp.Spec.FileStorageAccessMode) > 0 || len(pulp.Spec.FileStorageSize) > 0
+}

main.go

@@ -180,7 +180,7 @@ func main() {
 		os.Exit(1)
 	}
 
-	setupLog.Info("pulp-operator version: 1.0.16-alpha.9")
+	setupLog.Info("pulp-operator version: 1.0.17-alpha.9")
 	setupLog.Info("starting manager")
 	if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
 		setupLog.Error(err, "problem running manager")