Skip to content

Commit

Permalink
docs: handle upstream/downtsream variations
Browse files Browse the repository at this point in the history
Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
  • Loading branch information
themr0c authored and gbraad committed Jun 29, 2023
1 parent 3bc3be0 commit 884ba9a
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 5 deletions.
1 change: 0 additions & 1 deletion docs/antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,3 @@ asciidoc:
odo-docs-url-single-component: "{openshift-docs-url}/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.html"
telemetry-notice-url: https://developers.redhat.com/article/tool-data-collection
rhel-resolved-docs: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/configuring_and_managing_networking/using-different-dns-servers-for-different-domains_configuring-and-managing-networking

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* {ocp}
* {okd}
* {ushift}
* Podman container runtime
17 changes: 17 additions & 0 deletions docs/modules/getting_started/examples/snip_crc_preset_names.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.Preset names
|===
| Name | Preset

| `openshift`
| {ocp}

| `okd`
| {okd}

| `microshift`
| {ushift}

| `podman`
| Podman container runtime

|===
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.Preset and architecture compatibility
|===
| Preset | AMD64 | Intel 64 | M1

| {ocp}
| yes
| yes
| yes

| {okd}
| yes
| yes
| no

| {ushift}
| yes
| yes
| yes

| Podman container runtime
| yes
| yes
| yes

|===
4 changes: 3 additions & 1 deletion docs/modules/getting_started/partials/con_about-presets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

[role="_abstract"]
{prod} presets represent a managed container runtime, and the lower bounds of system resources required by the instance to run it.
{prod} offers presets for {ocp}, {okd}, {ushift} and the Podman container runtime.
{prod} offers presets for:

include::example$snip_crc_preset_list.adoc[]

On {msw} and {mac}, the {prod} guided installer prompts you for your desired preset.
On Linux, the {ocp} preset is selected by default.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ To enable preset changes, you must delete the existing instance and start a new
$ {bin} config set preset __<name>__
----
+
Valid preset names are `openshift` for {ocp}, `okd` for {okd} and `podman` for the Podman container runtime.
Valid preset names are:
+
include::example$snip_crc_preset_names.adoc[]

[role="_additional-resources"]
.Additional resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
[id="minimum-system-requirements-hardware_{context}"]
== Hardware requirements

{prod} is supported on AMD64, Intel 64 processor and M1 architectures.
The {okd} preset is not supported on the M1 architecture.
{prod} is supported on these architectures:

include::example$snip_crc_preset_platforms.adoc[]

{prod} does not support nested virtualization.

Depending on the desired container runtime, {prod} requires the following system resources:
Expand Down

0 comments on commit 884ba9a

Please sign in to comment.