(DOCSP-7255): Use 'Gi' instead of 'G' for persistent volumes. (#105)

jdestefano-mongo · jwilliams-mongo · commit 63074692d598 · 2025-04-14T17:11:16.000-05:00
* (DOCSP-7255): Use 'Gi' instead of 'G' for persistent volumes. * DOCSP-7255 - Change remaining 'G' to Gi
diff --git a/.gitignore b/.gitignore
@@ -23,3 +23,4 @@ handouts/mongodb-logo-eps-converted-to.pdf
 source/figures/
 giza.log
 backups/*
+.vscode/*
diff --git a/source/includes/list-tables/rs-resource-base-options.rst b/source/includes/list-tables/rs-resource-base-options.rst
@@ -84,7 +84,7 @@
 
        If this value is ``true``, then
        :setting:`spec.podSpec.persistence.single` is set to its
-       default value of ``16G``.
+       default value of ``16Gi``.
 
        To change your |k8s-pvcs| configuration, configure the
        following collections to meet your deployment requirements:
diff --git a/source/includes/options-k8s-replica-set.yaml b/source/includes/options-k8s-replica-set.yaml
@@ -242,7 +242,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` shard member
   storedItem: data
-  defaultStorage: 16G
+  defaultStorage: 16Gi
 
 ---
 program: k8sRsConf
@@ -257,7 +257,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` shard member
   storedItem: journal
-  defaultStorage: 1G
+  defaultStorage: 1Gi
 
 ---
 program: k8sRsConf
@@ -272,7 +272,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` shard member
   storedItem: logs
-  defaultStorage: 3G
+  defaultStorage: 3Gi
 
 ---
 program: k8sRsConf
diff --git a/source/includes/options-k8s-shared.yaml b/source/includes/options-k8s-shared.yaml
@@ -247,7 +247,7 @@ description: |
   .. example::
 
      If this |k8s-mdbrsc| requires 4 gigabytes of memory, set
-     this value to ``4G``.
+     this value to ``4Gi``.
 
   This value maps to the
   :k8sdocs:`limits field </reference/generated/kubernetes-api/v1.10/#resourcerequirements-v1-core>`
@@ -287,7 +287,7 @@ name: spec.podSpec.storage
 type: string
 directive: setting
 optional: true
-default: 16G
+default: 16Gi
 description: |
   Minimum storage capacity that must be available on a |k8s|
   |k8s-node| to host this {{component}} on |k8s|. This value is
@@ -297,7 +297,7 @@ description: |
   .. example::
 
      If this |k8s-mdbrsc| requires 60 gigabytes of storage space, set
-     this value to ``60G``.
+     this value to ``60Gi``.
 replacement:
   component: :term:`standalone deployment`
 
@@ -404,7 +404,7 @@ description: |
          .. example::
 
             If this |k8s-mdbrsc| requires 60 gigabytes of storage
-            space, set this value to ``60G``.
+            space, set this value to ``60Gi``.
 
      * - ``storageClass``
        - string
@@ -418,7 +418,7 @@ description: |
 
 replacement:
   component: :term:`standalone deployment`
-  defaultStorage: 16G
+  defaultStorage: 16Gi
 
 ---
 program: _shared
@@ -463,7 +463,7 @@ description: |
          .. example::
 
             If this |k8s-mdbrsc| requires 60 gigabytes of storage
-            space, set this value to ``60G``.
+            space, set this value to ``60Gi``.
 
      * - ``storageClass``
        - string
@@ -478,7 +478,7 @@ description: |
 replacement:
   component: :term:`standalone deployment`
   storedItem: data
-  defaultStorage: 16G
+  defaultStorage: 16Gi
 
 ---
 program: _shared
diff --git a/source/includes/options-k8s-shared_cluster.yaml b/source/includes/options-k8s-shared_cluster.yaml
@@ -224,7 +224,7 @@ name: spec.configSrvPodSpec.storage
 type: string
 directive: setting
 optional: true
-default: 5G
+default: 5Gi
 inherit:
   name: spec.podSpec.storage
   program: _shared
@@ -257,7 +257,7 @@ inherit:
   file: options-k8s-shared.yaml
 replacement:
   component: :term:`sharded cluster` shard member
-  defaultStorage: 5G
+  defaultStorage: 5Gi
 ---
 program: k8sScConf
 name: spec.configSrvPodSpec.persistence.multiple.data
@@ -271,7 +271,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` :term:`config server` member
   storedItem: data
-  defaultStorage: 16G
+  defaultStorage: 16Gi
 
 ---
 program: k8sScConf
@@ -286,7 +286,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` :term:`config server` member
   storedItem: journal
-  defaultStorage: 1G
+  defaultStorage: 1Gi
 
 ---
 program: k8sScConf
@@ -301,7 +301,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` :term:`config server` member
   storedItem: logs
-  defaultStorage: 3G
+  defaultStorage: 3Gi
 
 ---
 program: k8sScConf
@@ -594,7 +594,7 @@ name: spec.shardPodSpec.storage
 type: string
 directive: setting
 optional: true
-default: 16G
+default: 16Gi
 inherit:
   name: spec.podSpec.storage
   program: _shared
@@ -641,7 +641,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` shard member
   storedItem: data
-  defaultStorage: 16G
+  defaultStorage: 16Gi
 
 ---
 program: k8sScConf
@@ -656,7 +656,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` shard member
   storedItem: journal
-  defaultStorage: 1G
+  defaultStorage: 1Gi
 
 ---
 program: k8sScConf
@@ -671,7 +671,7 @@ inherit:
 replacement:
   component: :term:`sharded cluster` shard member
   storedItem: logs
-  defaultStorage: 3G
+  defaultStorage: 3Gi
 
 ---
 program: k8sScConf
diff --git a/source/includes/options-k8s-standalone.yaml b/source/includes/options-k8s-standalone.yaml
@@ -285,7 +285,7 @@ inherit:
 replacement:
   component: :term:`standalone deployment <standalone>`
   storedItem: data
-  defaultStorage: 16G
+  defaultStorage: 16Gi
 
 ---
 program: k8sSaConf
@@ -300,7 +300,7 @@ inherit:
 replacement:
   component: :term:`standalone deployment <standalone>`
   storedItem: journal
-  defaultStorage: 1G
+  defaultStorage: 1Gi
 
 ---
 program: k8sSaConf
@@ -315,7 +315,7 @@ inherit:
 replacement:
   component: :term:`standalone deployment <standalone>`
   storedItem: logs
-  defaultStorage: 3G
+  defaultStorage: 3Gi
 
 ---
 program: k8sSaConf
diff --git a/source/includes/steps-deploy-k8s-opsmgr-http.yaml b/source/includes/steps-deploy-k8s-opsmgr-http.yaml
@@ -145,7 +145,7 @@ content: |
           If this value is ``true``, then
           ``spec.applicationDatabase.podSpec.persistence.``
           :setting:`~spec.podSpec.persistence.single`
-          is set to its default value of ``16G``.
+          is set to its default value of ``16Gi``.
 
           To change your |k8s-pvcs| configuration, configure the
           following collections to meet your deployment requirements:
diff --git a/source/includes/steps-deploy-k8s-sharded-cluster.yaml b/source/includes/steps-deploy-k8s-sharded-cluster.yaml
@@ -139,7 +139,7 @@ content: |
           |k8s-mdbrsc| is stopped or restarted.
 
           If this value is ``true``, then the following values are set
-          to their default value of ``16G``:
+          to their default value of ``16Gi``:
 
           - :setting:`spec.shardPodSpec.persistence.single`
           - :setting:`spec.configSrvPodSpec.persistence.single`
diff --git a/source/includes/steps-deploy-k8s-standalone.yaml b/source/includes/steps-deploy-k8s-standalone.yaml
@@ -109,7 +109,7 @@ content: |
 
           If this value is ``true``, then
           :setting:`spec.podSpec.persistence.single` is set to its
-          default value of ``16G``.
+          default value of ``16Gi``.
 
           To change your |k8s-pvcs| configuration, configure the
           following collections to meet your deployment requirements:
diff --git a/source/reference/k8s-operator-om-specification.txt b/source/reference/k8s-operator-om-specification.txt
@@ -225,7 +225,7 @@ Optional |onprem| Resource Settings
           expressed as an integer followed by a unit of storage in
           |jedec| notation.
 
-          Default value is ``30G``.
+          Default value is ``30Gi``.
 
           .. seealso::
 
@@ -234,7 +234,7 @@ Optional |onprem| Resource Settings
           .. example::
 
              If the head database requires 60 gigabytes of storage
-             space, set this value to ``60G``.
+             space, set this value to ``60Gi``.
 
       * - ``storageClass``
         - string
diff --git a/source/reference/k8s/example-ops-manager.yaml b/source/reference/k8s/example-ops-manager.yaml
@@ -12,7 +12,7 @@ spec:
  backup:
   enabled: true
   headDB:
-   storage: 30G
+   storage: 30Gi
    labelSelector:
     matchLabels:
      app: my-app
diff --git a/source/reference/k8s/shardedclusterpodspec.yaml b/source/reference/k8s/shardedclusterpodspec.yaml
@@ -28,7 +28,7 @@ spec:
     memory: 512M
 
     # if "persistence" element is omitted then Operator uses the
-    # default size (5G) for mounting single Persistent Volume
+    # default size (5Gi) for mounting single Persistent Volume
 
     podAntiAffinityTopologyKey: kubernetes.io/hostname
     podAffinity:
@@ -53,7 +53,7 @@ spec:
                 weight: 50
   mongosPodSpec:
     cpu: '0.8'
-    memory: 1G
+    memory: 1Gi
     podAntiAffinityTopologyKey: rackId
     nodeAffinity:
       preferredDuringSchedulingIgnoredDuringExecution:
@@ -77,15 +77,15 @@ spec:
                 weight: 50
   shardPodSpec:
     cpu: '0.6'
-    memory: 3G
+    memory: 3Gi
     persistence:
       multiple:
         # if the child of "multiple" is omitted then the default size will be used.
-        # 16G for "data", 1G for "journal", 3Gb for "logs"
+        # 16GB for "data", 1GB for "journal", 3GB for "logs"
         data:
-          storage: 20G
+          storage: 20Gi
         logs:
-          storage: 4G
+          storage: 4Gi
           storageClass: standard
     podAntiAffinityTopologyKey: kubernetes.io/hostname
   security:
diff --git a/source/reference/k8s/standalonepodspec.yaml b/source/reference/k8s/standalonepodspec.yaml
@@ -16,7 +16,7 @@ spec:
     memory: 512M
     persistence:
       single:
-        storage: 12G
+        storage: 12Gi
         storageClass: standard
         labelSelector:
           matchExpressions:
diff --git a/source/reference/production-notes.txt b/source/reference/production-notes.txt
@@ -64,7 +64,7 @@ verify that the |k8s-pvcs| are configured to meet your storage needs.
            topologyKey: failure-domain.beta.kubernetes.io/zone
      mongosPodSpec:
        cpu: '0.8'
-       memory: 1G
+       memory: 1Gi
        podAntiAffinityTopologyKey: rackId
        nodeAffinity:
          preferredDuringSchedulingIgnoredDuringExecution:
@@ -77,13 +77,13 @@ verify that the |k8s-pvcs| are configured to meet your storage needs.
                - another-node-label-value
      shardPodSpec:
        cpu: '0.6'
-       memory: 3G
+       memory: 3Gi
        persistence:
          multiple:
            data:
-             storage: 20G
+             storage: 20Gi
            logs:
-             storage: 4G
+             storage: 4Gi
              storageClass: standard
        podAntiAffinityTopologyKey: kubernetes.io/hostname
 
@@ -169,7 +169,7 @@ compute and memory. |k8s| refers to the lower bound of a resource as a
               topologyKey: failure-domain.beta.kubernetes.io/zone
         mongosPodSpec:
           cpu: '0.8'
-          memory: 1G
+          memory: 1Gi
           podAntiAffinityTopologyKey: rackId
           nodeAffinity:
             preferredDuringSchedulingIgnoredDuringExecution:
@@ -182,13 +182,13 @@ compute and memory. |k8s| refers to the lower bound of a resource as a
                   - another-node-label-value
         shardPodSpec:
           cpu: '0.6'
-          memory: 3G
+          memory: 3Gi
           persistence:
             multiple:
               data:
-                storage: 20G
+                storage: 20Gi
               logs:
-                storage: 4G
+                storage: 4Gi
                 storageClass: standard
           podAntiAffinityTopologyKey: kubernetes.io/hostname
 
@@ -237,7 +237,7 @@ availability.
               topologyKey: failure-domain.beta.kubernetes.io/zone
         mongosPodSpec:
           cpu: '0.8'
-          memory: 1G
+          memory: 1Gi
           podAntiAffinityTopologyKey: rackId
           nodeAffinity:
             preferredDuringSchedulingIgnoredDuringExecution:
@@ -250,13 +250,13 @@ availability.
                   - another-node-label-value
         shardPodSpec:
           cpu: '0.6'
-          memory: 3G
+          memory: 3Gi
           persistence:
             multiple:
               data:
-                storage: 20G
+                storage: 20Gi
               logs:
-                storage: 4G
+                storage: 4Gi
                 storageClass: standard
           podAntiAffinityTopologyKey: kubernetes.io/hostname
 
diff --git a/source/reference/troubleshooting.txt b/source/reference/troubleshooting.txt
@@ -245,7 +245,7 @@ To view all |k8s-mdbrsc| specifications in the provided
         type: Standalone
         persistent: false
         podSpec:
-          memory: 1G
+          memory: 1Gi
         project: my-om-config
         version: 4.2.2-ent
 
