Enhancements to the CRD fields to set JVM heap size

Author: thegridman

deploy/crds/coherence.oracle.com_coherence_crd.yaml

@@ -6507,26 +6507,46 @@ spec:
                           JVM option. If not set the JVM defaults are used.
                         type: string
                       heapSize:
-                        description: HeapSize is the min/max heap value to pass to
-                          the JVM. The format should be the same as that used for
-                          Java's -Xms and -Xmx JVM options. If not set the JVM defaults
-                          are used.
+                        description: "HeapSize sets both the initial and max heap
+                          size values for the JVM. This will set both the -XX:InitialHeapSize
+                          and -XX:MaxHeapSize JVM options to the same value (the equivalent
+                          of setting -Xms and -Xmx to the same value). \n The format
+                          should be the same as that used when specifying these JVM
+                          options. \n If not set the JVM defaults are used."
+                        type: string
+                      initialHeapSize:
+                        description: "InitialHeapSize sets the initial heap size value
+                          for the JVM. This will set the -XX:InitialHeapSize JVM option
+                          (the equivalent of setting -Xms). \n The format should be
+                          the same as that used when specifying this JVM options.
+                          \n NOTE: If the HeapSize field is set it will override this
+                          field."
                         type: string
                       initialRAMPercentage:
                         anyOf:
                         - type: integer
                         - type: string
                         description: "Set initial heap size as a percentage of total
-                          memory. \n This option will be ignored if HeapSize is set.
-                          \n Valid values are decimal numbers between 0 and 100. \n
-                          NOTE: This field is a k8s resource.Quantity value as CRDs
-                          do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity
+                          memory. \n The JVM will ignore this option if any of the
+                          HeapSize, InitialHeapSize or MaxHeapSize options have been
+                          set. \n Valid values are decimal numbers between 0 and 100.
+                          \n NOTE: If the Percentage field is set it will override
+                          this field. \n NOTE: This field is a k8s resource.Quantity
+                          value as CRDs do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity
                           for the different formats of number that may be entered.
-                          \n NOTE: This field maps the the -XX:InitialRAMPercentage
+                          \n NOTE: This field maps to the -XX:InitialRAMPercentage
                           JVM option and will be incompatible with some JVMs that
                           do not have this option (e.g. Java 8)."
                         pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                         x-kubernetes-int-or-string: true
+                      maxHeapSize:
+                        description: "MaxHeapSize sets the maximum heap size value
+                          for the JVM. This will set the -XX:MaxHeapSize JVM option
+                          (the equivalent of setting -Xmx). \n The format should be
+                          the same as that used when specifying this JVM options.
+                          \n NOTE: If the HeapSize field is set it will override this
+                          field."
+                        type: string
                       maxRAM:
                         description: Sets the JVM option `-XX:MaxRAM=N` which sets
                           the maximum amount of memory used by the JVM to `n`, where
@@ -6538,12 +6558,14 @@ spec:
                         - type: integer
                         - type: string
                         description: "Set maximum heap size as a percentage of total
-                          memory. \n This option will be ignored if HeapSize is set.
-                          \n Valid values are decimal numbers between 0 and 100. \n
-                          NOTE: This field is a k8s resource.Quantity value as CRDs
-                          do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity
+                          memory. \n The JVM will ignore this option if any of the
+                          HeapSize, InitialHeapSize or MaxHeapSize options have been
+                          set. \n Valid values are decimal numbers between 0 and 100.
+                          \n NOTE: If the Percentage field is set it will override
+                          this field. \n NOTE: This field is a k8s resource.Quantity
+                          value as CRDs do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity
                           for the different formats of number that may be entered.
-                          \n NOTE: This field maps the the -XX:MaxRAMPercentage JVM
+                          \n NOTE: This field maps to the -XX:MaxRAMPercentage JVM
                           option and will be incompatible with some JVMs that do not
                           have this option (e.g. Java 8)."
                         pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
@@ -6587,6 +6609,26 @@ spec:
                               OOM error occurs. Default is true
                             type: boolean
                         type: object
+                      percentage:
+                        anyOf:
+                        - type: integer
+                        - type: string
+                        description: "Percentage sets the initial and maximum and
+                          minimum heap percentage sizes to the same value, This will
+                          set the -XX:InitialRAMPercentage -XX:MinRAMPercentage and
+                          -XX:MaxRAMPercentage JVM options to the same value. \n The
+                          JVM will ignore this option if any of the HeapSize, InitialHeapSize
+                          or MaxHeapSize options have been set. \n Valid values are
+                          decimal numbers between 0 and 100. \n NOTE: This field is
+                          a k8s resource.Quantity value as CRDs do not support decimal
+                          numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity
+                          for the different formats of number that may be entered.
+                          \n NOTE: This field maps to the -XX:InitialRAMPercentage
+                          -XX:MinRAMPercentage and -XX:MaxRAMPercentage JVM options
+                          and will be incompatible with some JVMs that do not have
+                          this option (e.g. Java 8)."
+                        pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                        x-kubernetes-int-or-string: true
                       stackSize:
                         description: StackSize is the stack size value to pass to
                           the JVM. The format should be the same as that used for

deploy/crds/v1beta1/coherence.oracle.com_coherence_crd.yaml

@@ -6393,26 +6393,44 @@ spec:
                         option. If not set the JVM defaults are used.
                       type: string
                     heapSize:
-                      description: HeapSize is the min/max heap value to pass to the
-                        JVM. The format should be the same as that used for Java's
-                        -Xms and -Xmx JVM options. If not set the JVM defaults are
-                        used.
+                      description: "HeapSize sets both the initial and max heap size
+                        values for the JVM. This will set both the -XX:InitialHeapSize
+                        and -XX:MaxHeapSize JVM options to the same value (the equivalent
+                        of setting -Xms and -Xmx to the same value). \n The format
+                        should be the same as that used when specifying these JVM
+                        options. \n If not set the JVM defaults are used."
+                      type: string
+                    initialHeapSize:
+                      description: "InitialHeapSize sets the initial heap size value
+                        for the JVM. This will set the -XX:InitialHeapSize JVM option
+                        (the equivalent of setting -Xms). \n The format should be
+                        the same as that used when specifying this JVM options. \n
+                        NOTE: If the HeapSize field is set it will override this field."
                       type: string
                     initialRAMPercentage:
                       anyOf:
                       - type: integer
                       - type: string
                       description: "Set initial heap size as a percentage of total
-                        memory. \n This option will be ignored if HeapSize is set.
-                        \n Valid values are decimal numbers between 0 and 100. \n
+                        memory. \n The JVM will ignore this option if any of the HeapSize,
+                        InitialHeapSize or MaxHeapSize options have been set. \n Valid
+                        values are decimal numbers between 0 and 100. \n NOTE: If
+                        the Percentage field is set it will override this field. \n
                         NOTE: This field is a k8s resource.Quantity value as CRDs
                         do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity
                         for the different formats of number that may be entered. \n
-                        NOTE: This field maps the the -XX:InitialRAMPercentage JVM
+                        NOTE: This field maps to the -XX:InitialRAMPercentage JVM
                         option and will be incompatible with some JVMs that do not
                         have this option (e.g. Java 8)."
                       pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                       x-kubernetes-int-or-string: true
+                    maxHeapSize:
+                      description: "MaxHeapSize sets the maximum heap size value for
+                        the JVM. This will set the -XX:MaxHeapSize JVM option (the
+                        equivalent of setting -Xmx). \n The format should be the same
+                        as that used when specifying this JVM options. \n NOTE: If
+                        the HeapSize field is set it will override this field."
+                      type: string
                     maxRAM:
                       description: Sets the JVM option `-XX:MaxRAM=N` which sets the
                         maximum amount of memory used by the JVM to `n`, where `n`
@@ -6424,12 +6442,14 @@ spec:
                       - type: integer
                       - type: string
                       description: "Set maximum heap size as a percentage of total
-                        memory. \n This option will be ignored if HeapSize is set.
-                        \n Valid values are decimal numbers between 0 and 100. \n
+                        memory. \n The JVM will ignore this option if any of the HeapSize,
+                        InitialHeapSize or MaxHeapSize options have been set. \n Valid
+                        values are decimal numbers between 0 and 100. \n NOTE: If
+                        the Percentage field is set it will override this field. \n
                         NOTE: This field is a k8s resource.Quantity value as CRDs
                         do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity
                         for the different formats of number that may be entered. \n
-                        NOTE: This field maps the the -XX:MaxRAMPercentage JVM option
+                        NOTE: This field maps to the -XX:MaxRAMPercentage JVM option
                         and will be incompatible with some JVMs that do not have this
                         option (e.g. Java 8)."
                       pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
@@ -6473,6 +6493,24 @@ spec:
                             OOM error occurs. Default is true
                           type: boolean
                       type: object
+                    percentage:
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      description: "Percentage sets the initial and maximum and minimum
+                        heap percentage sizes to the same value, This will set the
+                        -XX:InitialRAMPercentage -XX:MinRAMPercentage and -XX:MaxRAMPercentage
+                        JVM options to the same value. \n The JVM will ignore this
+                        option if any of the HeapSize, InitialHeapSize or MaxHeapSize
+                        options have been set. \n Valid values are decimal numbers
+                        between 0 and 100. \n NOTE: This field is a k8s resource.Quantity
+                        value as CRDs do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity
+                        for the different formats of number that may be entered. \n
+                        NOTE: This field maps to the -XX:InitialRAMPercentage -XX:MinRAMPercentage
+                        and -XX:MaxRAMPercentage JVM options and will be incompatible
+                        with some JVMs that do not have this option (e.g. Java 8)."
+                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                      x-kubernetes-int-or-string: true
                     stackSize:
                       description: StackSize is the stack size value to pass to the
                         JVM. The format should be the same as that used for Java's

docs/about/04_coherence_spec.adoc

@@ -321,26 +321,53 @@ Options for managing the JVM memory.
 [cols="1,10,1,1"options="header"]
 |===
 | Field | Description | Type | Required
-m| heapSize | HeapSize is the min/max heap value to pass to the JVM. The format should be the same as that used for Java's -Xms and -Xmx JVM options. If not set the JVM defaults are used. m| *string | false
+m| heapSize | HeapSize sets both the initial and max heap size values for the JVM. This will set both the -XX:InitialHeapSize and -XX:MaxHeapSize JVM options to the same value (the equivalent of setting -Xms and -Xmx to the same value). +
+ +
+The format should be the same as that used when specifying these JVM options. +
+ +
+If not set the JVM defaults are used. m| *string | false
+m| initialHeapSize | InitialHeapSize sets the initial heap size value for the JVM. This will set the -XX:InitialHeapSize JVM option (the equivalent of setting -Xms). +
+ +
+The format should be the same as that used when specifying this JVM options. +
+ +
+NOTE: If the HeapSize field is set it will override this field. m| *string | false
+m| maxHeapSize | MaxHeapSize sets the maximum heap size value for the JVM. This will set the -XX:MaxHeapSize JVM option (the equivalent of setting -Xmx). +
+ +
+The format should be the same as that used when specifying this JVM options. +
+ +
+NOTE: If the HeapSize field is set it will override this field. m| *string | false
 m| maxRAM | Sets the JVM option `-XX:MaxRAM=N` which sets the maximum amount of memory used by the JVM to `n`, where `n` is expressed in terms of megabytes (for example, `100m`) or gigabytes (for example `2g`). m| *string | false
+m| percentage | Percentage sets the initial and maximum and minimum heap percentage sizes to the same value, This will set the -XX:InitialRAMPercentage -XX:MinRAMPercentage and -XX:MaxRAMPercentage JVM options to the same value. +
+ +
+The JVM will ignore this option if any of the HeapSize, InitialHeapSize or MaxHeapSize options have been set. +
+ +
+Valid values are decimal numbers between 0 and 100. +
+ +
+NOTE: This field is a k8s resource.Quantity value as CRDs do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity for the different formats of number that may be entered. +
+ +
+NOTE: This field maps to the -XX:InitialRAMPercentage -XX:MinRAMPercentage and -XX:MaxRAMPercentage JVM options and will be incompatible with some JVMs that do not have this option (e.g. Java 8). m| *resource.Quantity | false
 m| initialRAMPercentage | Set initial heap size as a percentage of total memory. +
  +
-This option will be ignored if HeapSize is set. +
+The JVM will ignore this option if any of the HeapSize, InitialHeapSize or MaxHeapSize options have been set. +
  +
 Valid values are decimal numbers between 0 and 100. +
  +
+NOTE: If the Percentage field is set it will override this field. +
+ +
 NOTE: This field is a k8s resource.Quantity value as CRDs do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity for the different formats of number that may be entered. +
  +
-NOTE: This field maps the the -XX:InitialRAMPercentage JVM option and will be incompatible with some JVMs that do not have this option (e.g. Java 8). m| *resource.Quantity | false
+NOTE: This field maps to the -XX:InitialRAMPercentage JVM option and will be incompatible with some JVMs that do not have this option (e.g. Java 8). m| *resource.Quantity | false
 m| maxRAMPercentage | Set maximum heap size as a percentage of total memory. +
  +
-This option will be ignored if HeapSize is set. +
+The JVM will ignore this option if any of the HeapSize, InitialHeapSize or MaxHeapSize options have been set. +
  +
 Valid values are decimal numbers between 0 and 100. +
  +
+NOTE: If the Percentage field is set it will override this field. +
+ +
 NOTE: This field is a k8s resource.Quantity value as CRDs do not support decimal numbers. See https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity for the different formats of number that may be entered. +
  +
-NOTE: This field maps the the -XX:MaxRAMPercentage JVM option and will be incompatible with some JVMs that do not have this option (e.g. Java 8). m| *resource.Quantity | false
+NOTE: This field maps to the -XX:MaxRAMPercentage JVM option and will be incompatible with some JVMs that do not have this option (e.g. Java 8). m| *resource.Quantity | false
 m| minRAMPercentage | Set the minimal JVM Heap size as a percentage of the total memory. +
  +
 This option will be ignored if HeapSize is set. +