Skip to content

Commit b1c6ce0

Browse files
authored
Merge pull request #70 from anarnold97/update-GiB
MTA-4234: Update GiB to Gi where applicable and Update GiB to GB where applicable
2 parents 19df03f + 25ba4e4 commit b1c6ce0

8 files changed

+57
-57
lines changed

docs/topics/mta-6-installing-web-console-on-openshift.adoc

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,27 @@ To successfully deploy, the {ProductShortName} Operator requires 3 RWO persisten
2424
|Description
2525

2626
|`hub database`
27-
|5 GiB
27+
|`5 Gi`
2828
|RWO
2929
|Hub database
3030

3131
|`hub bucket`
32-
|100 GiB
32+
|`100 Gi`
3333
|RWX
3434
|Hub file storage; required if the `rwx_supported` configuration option is set to `true`
3535

3636
|`keycloak postgresql`
37-
|1 GiB
37+
|`1 Gi`
3838
|RWO
3939
|Keycloak back end database
4040

4141
|`pathfinder postgresql`
42-
|1 GiB
42+
|`1 Gi`
4343
|RWO
4444
|Pathfinder back end database
4545

4646
|`cache`
47-
|100 GiB
47+
|`100 Gi`
4848
|RWX
4949
|Maven m2 cache; required if the `rwx_supported` configuration option is set to `true`
5050
|====
@@ -55,7 +55,7 @@ You can install the {ProductName} ({ProductShortName}) and the {WebName} on Open
5555

5656
.Prerequisites
5757

58-
* 4 vCPUs, 8 GiB RAM, and 40 GB persistent storage.
58+
* 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.
5959
* OpenShift Container Platform 4.12-4.14 installed.
6060
* You must be logged in as a user with `cluster-admin` permissions.
6161

@@ -83,7 +83,7 @@ The most commonly used CR settings are listed in this table:
8383
|Description
8484

8585
|`cache_data_volume_size`
86-
|`100 GiB`
86+
|`100 Gi`
8787
|Size requested for the cache volume; ignored when `rwx_supported=false`
8888

8989
|`cache_storage_class`
@@ -99,27 +99,27 @@ The most commonly used CR settings are listed in this table:
9999
|Flag to indicate whether namespace isolation using network policies is enabled
100100

101101
|`hub_database_volume_size`
102-
|`5 GiB`
102+
|`5 Gi`
103103
|Size requested for the Hub database volume
104104

105105
|`hub_bucket_volume_size`
106-
|`100 GiB`
106+
|`100 Gi`
107107
|Size requested for the Hub bucket volume
108108

109109
|`hub_bucket_storage_class`
110110
|Default storage class
111111
|Storage class used for the bucket volume
112112

113113
|`keycloak_database_data_volume_size`
114-
|`1 GiB`
114+
|`1 Gi`
115115
|Size requested for the Keycloak database volume
116116

117117
|`pathfinder_database_data_volume_size`
118-
|`1 GiB`
118+
|`1 Gi`
119119
|Size requested for the Pathfinder database volume
120120

121121
|`maven_data_volume_size`
122-
|`100 GiB`
122+
|`100 Gi`
123123
|Size requested for the Maven m2 cache volume; deprecated in {ProductShortName} 6.0.1
124124

125125
|`rwx_storage_class`
@@ -212,34 +212,34 @@ When installed on https://developers.redhat.com/products/openshift-local/overvie
212212
.OpenShift Local {ProductShortName} memory requirements
213213
[cols="25%,75%", options="header"]
214214
|====
215-
|Memory (GiB)
215+
|Memory (Gi)
216216
|Description
217217

218218

219-
|`10`
219+
|`10Gi`
220220
|{ProductShortName} cannot run the analysis due to insufficient memory
221221

222-
|`11`
222+
|`11Gi`
223223
|{ProductShortName} cannot run the analysis due to insufficient memory
224224

225-
|`12`
225+
|`12Gi`
226226
|*{ProductShortName} works and the analysis is completed in approximately 3 minutes*
227227

228-
|`15`
228+
|`15Gi`
229229
|{ProductShortName} works and the analysis is completed in less than 2 minutes
230230

231-
|`20`
231+
|`20Gi`
232232
|{ProductShortName} works quickly and the analysis is completed in less than 1 minute
233233
|====
234234

235-
The test results indicate that the minimum amount of memory for running {ProductShortName} on OpenShift Local is *12 GiB*.
235+
The test results indicate that the minimum amount of memory for running {ProductShortName} on OpenShift Local is *12 GB*.
236236

237237
[NOTE]
238238
====
239239
** The tests were performed by running the {ProductShortName} binary analysis through the {WebName}.
240240
** All the analyses used the `tackle-testapp` binary.
241241
** All the tests were conducted on an OpenShift Local cluster without the monitoring tools installed.
242-
** Installing the cluster monitoring tools requires an additional 5 GiB of memory.
242+
** Installing the cluster monitoring tools requires an additional 5 GB of memory.
243243
====
244244

245245
[id="eviction-threshold_{context}"]

docs/topics/mta-7-configuration-web-console-on-ocp-local.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ The following table shows the recommended minimum configurations of {rh-ocp-loca
66

77
[width="100%",cols="25%,25%,25%",options="header",]
88
|===
9-
|Memory (GiB)
9+
|Memory (Gi)
1010
|CPU
11-
|Disk sze (GiB)
11+
|Disk sze (Gi)
1212

13-
|20
13+
|`20Gi`
1414
|5
15-
|110
15+
|`110Gi`
1616

17-
|20
17+
|`20Gi`
1818
|5
19-
|35, with the {ProductShortName} Operator configurations `cache_data_volume_size` and `hub_bucket_volume_size` set to 5GiB.
19+
|`35Gi`, with the {ProductShortName} Operator configurations `cache_data_volume_size` and `hub_bucket_volume_size` set to `5Gi`.
2020
|===

docs/topics/mta-7-installing-web-console-on-ocp-local.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ The `crc start` command starts the {rh-ocp-local} instance and configured contai
165165

166166
|-d, –disk-size
167167
|uint
168-
|Total size in GiB of the disk used by the instance
168+
|Total size in GB of the disk used by the instance
169169
|31
170170

171171
|-h, –help
@@ -175,7 +175,7 @@ The `crc start` command starts the {rh-ocp-local} instance and configured contai
175175

176176
|-m, –memory
177177
|int
178-
|MiB of memory to assign to the instance
178+
|`Mi` of memory to assign to the instance
179179
|10752
180180

181181
|-n, –nameserver
@@ -216,9 +216,9 @@ It also offers the following global flags:
216216

217217
|===
218218

219-
The default configuration creates a virtual machine (VM) with 4 virtual CPUs, a disk size of 31 GiB, and 10 GiB of RAM. However, this default configuration is not sufficent to stably run {ProductShortName}.
219+
The default configuration creates a virtual machine (VM) with 4 virtual CPUs, a disk size of 31 GB, and 10 GB of RAM. However, this default configuration is not sufficent to stably run {ProductShortName}.
220220

221-
To increase the number of virtual CPUs to 6, the disk-size to 200 GiB, and the memory to 20 GiB, run `crc config` as follows:
221+
To increase the number of virtual CPUs to 6, the disk-size to 200 GB, and the memory to 20 GB, run `crc config` as follows:
222222
+
223223
[source,terminal]
224224
----
@@ -228,7 +228,7 @@ crc config set cpus 6
228228
+
229229
[source,terminal]
230230
----
231-
crc config set disk-size 200
231+
crc config set disk-size 200
232232
----
233233

234234
+

docs/topics/mta-7-installing-web-console-on-openshift.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,22 @@ To successfully deploy, the {ProductShortName} Operator requires 2 RWO persisten
3030
|Description
3131

3232
|`hub database`
33-
|10 GiB
33+
|`10Gi`
3434
|RWO
3535
|Hub database
3636

3737
|`hub bucket`
38-
|100 GiB
38+
|`100Gi`
3939
|RWX
4040
|Hub file storage; required if the `rwx_supported` configuration option is set to `true`
4141

4242
|`keycloak postgresql`
43-
|1 GiB
43+
|`1Gi`
4444
|RWO
4545
|Keycloak back end database
4646

4747
|`cache`
48-
|100 GiB
48+
|`100Gi`
4949
|RWX
5050
|Maven m2 cache; required if the `rwx_supported` configuration option is set to `true`
5151
|====
@@ -57,7 +57,7 @@ You can install the {ProductName} ({ProductShortName}) and the {WebName} on Red
5757

5858
.Prerequisites
5959

60-
* 4 vCPUs, 8 GiB RAM, and 40 GiB persistent storage.
60+
* 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.
6161
* Any cloud services or self-hosted edition of Red Hat OpenShift on versions 4.13-4.15.
6262
* You must be logged in as a user with `cluster-admin` permissions.
6363

@@ -87,7 +87,7 @@ The most commonly used CR settings are listed in this table:
8787
|Description
8888

8989
|`cache_data_volume_size`
90-
|`100 GiB`
90+
|`100Gi`
9191
|Size requested for the cache volume; ignored when `rwx_supported=false`
9292

9393
|`cache_storage_class`
@@ -103,27 +103,27 @@ The most commonly used CR settings are listed in this table:
103103
|Flag to indicate whether namespace isolation using network policies is enabled
104104

105105
|`hub_database_volume_size`
106-
|`10 GiB`
106+
|`10Gi`
107107
|Size requested for the Hub database volume
108108

109109
|`hub_bucket_volume_size`
110-
|`100 GiB`
110+
|`100Gi`
111111
|Size requested for the Hub bucket volume
112112

113113
|`hub_bucket_storage_class`
114114
|Default storage class
115115
|Storage class used for the bucket volume
116116

117117
|`keycloak_database_data_volume_size`
118-
|`1 GiB`
118+
|`1Gi`
119119
|Size requested for the Keycloak database volume
120120

121121
|`pathfinder_database_data_volume_size`
122-
|`1 GiB`
122+
|`1Gi`
123123
|Size requested for the Pathfinder database volume
124124

125125
|`maven_data_volume_size`
126-
|`100 GiB`
126+
|`100Gi`
127127
|Size requested for the Maven m2 cache volume; deprecated in {ProductShortName} 6.0.1
128128

129129
|`rwx_storage_class`
@@ -147,15 +147,15 @@ The most commonly used CR settings are listed in this table:
147147
|Maximum number of CPUs the pod is allowed to use
148148

149149
|`analyzer_container_limits_memory`
150-
|`4GiB`
150+
|`4Gi`
151151
|Maximum amount of memory the pod is allowed to use. You can increase this limit if the pod displays `OOMKilled` errors.
152152

153153
|`analyzer_container_requests_cpu`
154154
|`1`
155155
|Minimum number of CPUs the pod needs to run
156156

157157
|`analyzer_container_requests_memory`
158-
|`4GiB`
158+
|`4Gi`
159159
|Minimum amount of memory the pod needs to run
160160
|====
161161

@@ -222,13 +222,13 @@ To prevent out-of-memory events and protect nodes, use the `--eviction-hard` set
222222

223223
.Example of node memory allocation settings
224224

225-
- Node capacity: `32 GiB`
225+
- Node capacity: `32Gi`
226226

227-
- `--system-reserved` setting: `3 GiB`
227+
- `--system-reserved` setting: `3Gi`
228228

229-
- `--eviction-hard` setting: `100 MiB`
229+
- `--eviction-hard` setting: `100Mi`
230230

231-
The amount of memory available for running pods on this node is 28.9 GiB. This amount is calculated by subtracting the `system-reserved` and `eviction-hard` values from the overall capacity of the node. If the memory usage exceeds this amount, the node starts evicting pods.
231+
The amount of memory available for running pods on this node is 28.9 GB. This amount is calculated by subtracting the `system-reserved` and `eviction-hard` values from the overall capacity of the node. If the memory usage exceeds this amount, the node starts evicting pods.
232232

233233

234234
[id="mta-7-red-hat-single-sign-on_{context}"]

docs/topics/mta-requirements-for-java-analyzer.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
[id="mta-requirements-for-java-analyzer_{context}"]
77
= Adding minimum requirements for Java analyzer and discovery
88

9-
There is a minimum requirement for the Java analyzer, and also the discovery task, which by default is set to 2 GiB.
9+
There is a minimum requirement for the Java analyzer, and also the discovery task, which by default is set to 2 GB.
1010

11-
While this minimum requirement can be lowered to 1.5 GiB, it is not recommended.
11+
While this minimum requirement can be lowered to 1.5 GB, it is not recommended.
1212

13-
You can also increase this minimum requirement to more than 2 GiB.
13+
You can also increase this minimum requirement to more than 2 GB.
1414

1515
[source, yaml]
1616
----

docs/topics/mta-rn-upgrade-notes-7-0-0.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ The following are upgrade notes for {ProductFullName}
1010

1111
.Hub database volume size
1212

13-
In version 7.0.0 of {ProductShortName}, the default size of the hub database volume has been increased to 10GiB.
13+
In version 7.0.0 of {ProductShortName}, the default size of the hub database volume has been increased to 10GB.
1414

15-
If your storage class does not support volume expansion, then an upgrade from 6.2.1 to 7.0.0 will result in a failure due to the operator trying to change the volume size from 5GiB to 10GiB.
15+
If your storage class does not support volume expansion, then an upgrade from 6.2.1 to 7.0.0 will result in a failure due to the operator trying to change the volume size from 5GB to 10GB.
1616

1717
To avoid this issue, you can directly set the volume size by setting:
1818

docs/topics/mta-rn-upgrade-notes-7-0-1.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Enable the legacy Pathfinder questionnaire to see the completed status of assess
2525

2626
.Hub database volume size
2727

28-
In version 7.0.1 of {ProductShortName}, the default size of the hub database volume has been increased to 10GiB.
28+
In version 7.0.1 of {ProductShortName}, the default size of the hub database volume has been increased to 10GB.
2929

30-
If your storage class does not support volume expansion, then an upgrade from 6.2.1 to 7.0.1 will result in a failure due to the operator trying to change the volume size from 5GiB to 10GiB.
30+
If your storage class does not support volume expansion, then an upgrade from 6.2.1 to 7.0.1 will result in a failure due to the operator trying to change the volume size from 5GB to 10GB.
3131

3232
To avoid this issue, you can directly set the volume size by setting:
3333

docs/topics/mta-rn-upgrade-notes-7-0-2.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Enable the legacy Pathfinder questionnaire to see the completed status of assess
2525

2626
.Hub database volume size
2727

28-
In version 7.0.2 of {ProductShortName}, the default size of the hub database volume has been increased to 10GiB.
28+
In version 7.0.2 of {ProductShortName}, the default size of the hub database volume has been increased to 10GB.
2929

30-
If your storage class does not support volume expansion, then an upgrade from 6.2.1 to 7.0.2 will result in a failure due to the operator trying to change the volume size from 5GiB to 10GiB.
30+
If your storage class does not support volume expansion, then an upgrade from 6.2.1 to 7.0.2 will result in a failure due to the operator trying to change the volume size from 5GB to 10GB.
3131

3232
To avoid this issue, you can directly set the volume size by setting:
3333

0 commit comments

Comments
 (0)