Merge branch 'allow-nfs-type-pv' into 'main'

Allow using NFS in persistent volume spec as part of the `initializeDomainOnPV`.

See merge request weblogic-cloud/weblogic-kubernetes-operator!4306

Author: rjeberhard

documentation/domains/Domain.json

@@ -885,6 +885,10 @@
           "description": "StorageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.",
           "type": "string"
         },
+        "nfs": {
+          "description": "nfs represents an NFS mount on the host. Provisioned by an admin. More info:\nhttps://kubernetes.io/docs/concepts/storage/volumes#nfs\nRepresents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
+          "$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.13.5/_definitions.json#/definitions/io.k8s.api.core.v1.NFSVolumeSource"
+        },
         "persistentVolumeReclaimPolicy": {
           "description": "PersistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming  ",
           "type": "string"

documentation/domains/Domain.md

@@ -362,6 +362,7 @@ The current status of the operation of the WebLogic domain. Updated automaticall
 | --- | --- | --- |
 | `capacity` | Map | Capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity |
 | `hostPath` | [Host Path Volume Source](k8s1.13.5.md#host-path-volume-source) | HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info:<br/> https://kubernetes.io/docs/concepts/storage/volumes#hostpath<br/>Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. |
+| `nfs` | [NFS Volume Source](k8s1.13.5.md#nfs-volume-source) | nfs represents an NFS mount on the host. Provisioned by an admin. More info:<br/>https://kubernetes.io/docs/concepts/storage/volumes#nfs<br/>Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. |
 | `persistentVolumeReclaimPolicy` | string | PersistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming   |
 | `storageClassName` | string | StorageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. |
 | `volumeMode` | string | VolumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. |

kubernetes/crd/domain-crd.yaml

@@ -5,7 +5,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    weblogic.sha256: f276330d4f124e1c8828a6183c3232d15a7ab68cda30d3cdf8d1e008e3c726e2
+    weblogic.sha256: 74446d3b1c48a2baabc56f1240b28e5a2d1e8a6e8f656295532ad83de1517552
   name: domains.weblogic.oracle
 spec:
   group: weblogic.oracle
@@ -206,6 +206,22 @@ spec:
                                   to which this persistent volume belongs. Empty value
                                   means that this volume does not belong to any StorageClass.
                                 type: string
+                              nfs:
+                                description: |-
+                                  nfs represents an NFS mount on the host. Provisioned by an admin. More info:
+                                  https://kubernetes.io/docs/concepts/storage/volumes#nfs
+                                  Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
+                                properties:
+                                  path:
+                                    type: string
+                                  server:
+                                    type: string
+                                  readOnly:
+                                    type: boolean
+                                required:
+                                - path
+                                - server
+                                type: object
                               persistentVolumeReclaimPolicy:
                                 description: 'PersistentVolumeReclaimPolicy defines
                                   what happens to a persistent volume when released

operator/src/main/java/oracle/kubernetes/operator/helpers/PersistentVolumeHelper.java

@@ -223,7 +223,8 @@ private V1PersistentVolumeSpec createSpec(PersistentVolumeSpec spec) {
       return new V1PersistentVolumeSpec().accessModes(Collections.singletonList(READ_WRITE_MANY))
           .storageClassName(spec.getStorageClassName())
           .capacity(spec.getCapacity()).persistentVolumeReclaimPolicy(spec.getPersistentVolumeReclaimPolicy())
-          .hostPath(spec.getHostPath());
+          .hostPath(spec.getHostPath())
+          .nfs(spec.getNfs());
     }
 
 

operator/src/main/java/oracle/kubernetes/weblogic/domain/model/PersistentVolumeSpec.java

@@ -7,6 +7,7 @@
 
 import io.kubernetes.client.custom.Quantity;
 import io.kubernetes.client.openapi.models.V1HostPathVolumeSource;
+import io.kubernetes.client.openapi.models.V1NFSVolumeSource;
 import oracle.kubernetes.json.Description;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
@@ -26,6 +27,12 @@ public class PersistentVolumeSpec {
       + " or SELinux relabeling.")
   private V1HostPathVolumeSource hostPath;
 
+  @Description("nfs represents an NFS mount on the host. Provisioned by an admin. More info:\n"
+      + "https://kubernetes.io/docs/concepts/storage/volumes#nfs\n"
+      + "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do"
+      + " not support ownership management or SELinux relabeling.")
+  private V1NFSVolumeSource nfs;
+
   @Description("PersistentVolumeReclaimPolicy defines what happens to a persistent volume when released from"
       + " its claim. Valid options are Retain (default for manually created PersistentVolumes),"
       + " Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated)."
@@ -59,6 +66,15 @@ public PersistentVolumeSpec hostPath(V1HostPathVolumeSource hostPath) {
     return this;
   }
 
+  public V1NFSVolumeSource getNfs() {
+    return nfs;
+  }
+
+  public PersistentVolumeSpec nfs(V1NFSVolumeSource nfs) {
+    this.nfs = nfs;
+    return this;
+  }
+
   public String getPersistentVolumeReclaimPolicy() {
     return persistentVolumeReclaimPolicy;
   }
@@ -91,6 +107,7 @@ public String toString() {
         new ToStringBuilder(this)
             .append("capacity", capacity)
             .append("hostPath", hostPath)
+            .append("nfs", nfs)
             .append("persistentVolumeReclaimPolicy", persistentVolumeReclaimPolicy)
             .append("storageClassName", storageClassName)
             .append("volumeMode", volumeMode);
@@ -103,6 +120,7 @@ public int hashCode() {
     HashCodeBuilder builder = new HashCodeBuilder()
         .append(capacity)
         .append(hostPath)
+        .append(nfs)
         .append(persistentVolumeReclaimPolicy)
         .append(storageClassName)
         .append(volumeMode);
@@ -123,6 +141,7 @@ public boolean equals(Object other) {
         new EqualsBuilder()
             .append(capacity, rhs.capacity)
             .append(hostPath, rhs.hostPath)
+            .append(nfs, rhs.nfs)
             .append(persistentVolumeReclaimPolicy, rhs.persistentVolumeReclaimPolicy)
             .append(storageClassName, rhs.storageClassName)
             .append(volumeMode, rhs.volumeMode);

operator/src/test/java/oracle/kubernetes/operator/helpers/DomainIntrospectorJobTest.java

@@ -31,7 +31,6 @@
 import io.kubernetes.client.openapi.models.V1ContainerStateWaiting;
 import io.kubernetes.client.openapi.models.V1ContainerStatus;
 import io.kubernetes.client.openapi.models.V1EmptyDirVolumeSource;
-import io.kubernetes.client.openapi.models.V1HostPathVolumeSource;
 import io.kubernetes.client.openapi.models.V1Job;
 import io.kubernetes.client.openapi.models.V1JobCondition;
 import io.kubernetes.client.openapi.models.V1JobSpec;
@@ -84,8 +83,6 @@
 import oracle.kubernetes.weblogic.domain.model.InitializeDomainOnPV;
 import oracle.kubernetes.weblogic.domain.model.Model;
 import oracle.kubernetes.weblogic.domain.model.Opss;
-import oracle.kubernetes.weblogic.domain.model.PersistentVolume;
-import oracle.kubernetes.weblogic.domain.model.PersistentVolumeSpec;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -560,13 +557,6 @@ private Opss getOpss() {
     return opss;
   }
 
-  private PersistentVolume createPv() {
-    return new PersistentVolume().metadata(new V1ObjectMeta().name("test-pv"))
-        .spec(new PersistentVolumeSpec().storageClassName("oke-pv")
-            .capacity(Collections.singletonMap("storage", new Quantity("500Gi")))
-            .hostPath(new V1HostPathVolumeSource().path("/shared")));
-  }
-
   private List<V1Container> getCreatedPodSpecContainers(List<V1Job> jobs) {
     return getJobPodSpec(jobs.get(0)).getContainers();
   }

operator/src/test/java/oracle/kubernetes/weblogic/domain/model/DomainV2Test.java

@@ -14,6 +14,7 @@
 import io.kubernetes.client.openapi.models.V1Container;
 import io.kubernetes.client.openapi.models.V1EnvVar;
 import io.kubernetes.client.openapi.models.V1HostPathVolumeSource;
+import io.kubernetes.client.openapi.models.V1NFSVolumeSource;
 import io.kubernetes.client.openapi.models.V1ObjectMeta;
 import io.kubernetes.client.openapi.models.V1PodSecurityContext;
 import io.kubernetes.client.openapi.models.V1ResourceRequirements;
@@ -1722,6 +1723,24 @@ private PersistentVolume createPv() {
             .volumeMode("Block"));
   }
 
+  @Test
+  void whenPersistentVolumeConfiguredWithNfs_useConfiguredValues() {
+    configureDomain(domain).withInitializeDomainOnPv(new InitializeDomainOnPV().persistentVolume(createNfsPv()));
+
+    assertThat(getPersistentVolume(domain), equalTo(createNfsPv()));
+    assertThat(getPersistentVolume(domain).getSpec().getStorageClassName(), equalTo("oke-pv"));
+    assertThat(getPersistentVolume(domain).getSpec().getCapacity(), notNullValue());
+    assertThat(getPersistentVolume(domain).getSpec().getNfs().getPath(), equalTo("/shared"));
+  }
+
+  private PersistentVolume createNfsPv() {
+    return new PersistentVolume().metadata(new V1ObjectMeta().name("test-pv"))
+        .spec(new PersistentVolumeSpec().storageClassName("oke-pv")
+            .capacity(Collections.singletonMap("storage", new Quantity("500Gi")))
+            .nfs(new V1NFSVolumeSource().path("/shared")
+            .server("10.0.3.9")));
+  }
+
   @Test
   void whenPersistentVolumeClaimConfigured_useConfiguredValues() {
     configureDomain(domain).withInitializeDomainOnPv(new InitializeDomainOnPV().persistentVolumeClaim(createPvc()));