Skip to content

Commit 0603995

Browse files
rohanKanojiagbraad
authored andcommitted
doc : Add detailed sections about CRC presets
+ Add dedicated sections about currently supported CRC presets, with some introduction and clear steps on how to create a cluster with that particular preset. + Add a table in About Presets section containing preset value and minimum system requirements. In my opinion, it's better to list the requirements like this rather than linking a different document. Signed-off-by: Rohan Kumar <rohaan@redhat.com>
1 parent 2eef6cf commit 0603995

File tree

1 file changed

+83
-11
lines changed

1 file changed

+83
-11
lines changed

modules/ROOT/pages/using.adoc

Lines changed: 83 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,93 @@
77

88
[role="_abstract"]
99
{prod} presets represent a managed container runtime, and the lower bounds of system resources required by the instance to run it.
10-
{prod} offers presets for:
11-
12-
`openshift`:: {ocp}
13-
`okd`:: {okd}
14-
`microshift`:: {ushift}
10+
Here are various supported presets for {prod} along with their minimum system requirements:
11+
12+
[cols="5,5,5,5,5", options="header"]
13+
|===
14+
| Preset Name | Description | CPUs | RAM | Disk space
15+
16+
| `openshift`
17+
| {ocp}
18+
| 4
19+
| 10.5 GB
20+
| 35 GB
21+
22+
| `okd`
23+
| {okd}
24+
| 4
25+
| 10.5 GB
26+
| 35 GB
27+
28+
| `microshift`
29+
| {ushift}
30+
| 2
31+
| 4 GB
32+
| 35 GB
33+
|===
1534

1635
On {msw} and {mac}, the {prod} guided installer prompts you for your desired preset.
1736
On Linux, the {ocp} preset is selected by default.
18-
You can change this selection using the [command]`{bin} config` command before running the [command]`{bin} setup` command.
19-
Only one preset can be active at a time.
2037

21-
[role="_additional-resources"]
22-
.Additional resources
23-
* xref:installing.adoc#minimum-system-requirements[Minimum system requirements].
24-
* xref:configuring.adoc#changing-the-selected-preset[Changing the selected preset].
38+
TIP: You can change this selection using the [command]`{bin} config` command before running the [command]`{bin} setup` command.
39+
40+
IMPORTANT: Only one preset can be active at a time.
41+
42+
Let's take a look into each of these presets in detail:
43+
44+
[id='openshift-preset']
45+
=== {openshift}
46+
47+
`openshift` preset creates a minimal, single-node cluster for https://www.redhat.com/en/technologies/cloud-computing/openshift/container-platform[Red Hat OpenShift Container Platform]. This cluster is very similar to
48+
real https://www.redhat.com/en/technologies/cloud-computing/openshift/container-platform[Red Hat OpenShift Container Platform] set up in cloud environments like AWS, GCP, Azure etc. It's only meant to be used
49+
for development and testing purposes.
50+
51+
This preset is the default preset used by {prod} if not explicit preset is configured.
52+
53+
If you want to configure this preset, you can do it like this:
54+
[source,shell]
55+
----
56+
$ crc delete # Remove previous cluster (if present)
57+
$ crc config set preset openshift # Configure to use openshift preset
58+
$ crc setup # Initialize environment for cluster
59+
$ crc start # Start the cluster
60+
----
61+
62+
[id='okd-preset']
63+
=== {okd}
64+
65+
{okd} preset creates a minimal, single-node cluster for https://okd.io/docs/project/about[OpenShift Kubernetes Distribution]. It
66+
is an upstream, community-driven project that provides the core components needed to run Kubernetes. It has similar requirements
67+
to the OpenShift Container Platform preset.
68+
69+
If you want to configure this preset, you can do it like this:
70+
[source,shell]
71+
----
72+
$ crc delete # Remove previous cluster (if present)
73+
$ crc config set preset okd # Configure to use okd preset
74+
$ crc setup # Initialize environment for cluster
75+
$ crc start # Start the cluster
76+
----
77+
78+
[id='microshift-preset']
79+
=== {ushift}
80+
81+
https://www.redhat.com/en/topics/edge-computing/microshift[{ushift}] is a lightweight Kubernetes container orchestration
82+
solution designed by https://www.redhat.com/en[Red Hat]. It's essentially a smaller, more resource-efficient version of
83+
https://www.redhat.com/en/technologies/cloud-computing/openshift[Red Hat OpenShift], optimized for edge computing.
84+
85+
NOTE: This preset shouldn't be confused with {openshift} preset. It is tailored for environments with limited resources. {openshift} on
86+
the other hand, is a full-featured platform designed for larger-scale deployments and comprehensive management. For more details, please
87+
refer to https://github.com/openshift/microshift#user-documentation[{ushift} documentation].
88+
89+
If you want to configure this preset, you can do it like this:
90+
[source,shell]
91+
----
92+
$ crc delete # Remove previous cluster (if present)
93+
$ crc config set preset microshift # Configure to use microshift preset
94+
$ crc setup # Initialize environment for cluster
95+
$ crc start # Start the cluster
96+
----
2597

2698
[id='setting-up']
2799
== Setting up {prod}

0 commit comments

Comments
 (0)