File: proc_configuring-the-instance.adoc

package info (click to toggle)
golang-github-crc-org-crc 2.34.0%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,548 kB
  • sloc: sh: 398; makefile: 326; javascript: 40
file content (52 lines) | stat: -rw-r--r-- 1,466 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
= Configuring the instance

Use the `cpus` and `memory` properties to configure the default number of vCPUs and amount of memory available to the {prod} instance, respectively.

Alternatively, the number of vCPUs and amount of memory can be assigned using the `--cpus` and `--memory` flags to the `{bin} start` command, respectively.

[IMPORTANT]
====
You cannot change the configuration of a running {prod} instance.
To enable configuration changes, you must stop the running instance and start it again.
====

.Procedure
* To configure the number of vCPUs available to the instance:
+
[subs="+quotes,attributes"]
----
$ {bin} config set cpus __<number>__
----
+
The default value for the `cpus` property is `4`.
The number of vCPUs to assign must be greater than or equal to the default.

* To start the instance with the desired number of vCPUs:
+
[subs="+quotes,attributes"]
----
$ {bin} start --cpus __<number>__
----

* To configure the memory available to the instance:
+
[subs="+quotes,attributes"]
----
$ {bin} config set memory __<number-in-mib>__
----
+
[NOTE]
====
Values for available memory are set in mebibytes (MiB).
One gibibyte (GiB) of memory is equal to 1024 MiB.
====
+
The default value for the `memory` property is `9216`.
The amount of memory to assign must be greater than or equal to the default.

* To start the instance with the desired amount of memory:
+
[subs="+quotes,attributes"]
----
$ {bin} start --memory __<number-in-mib>__
----