From 884ba9ac06cb7aa8da5440d6e5ff75fbbefb9df1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 27 Jun 2023 14:33:18 +0200 Subject: [PATCH] docs: handle upstream/downtsream variations MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- docs/antora-playbook.yml | 1 - .../examples/snip_crc_preset_list.adoc | 4 +++ .../examples/snip_crc_preset_names.adoc | 17 +++++++++++++ .../examples/snip_crc_preset_platforms.adoc | 25 +++++++++++++++++++ .../partials/con_about-presets.adoc | 4 ++- .../proc_changing-the-selected-preset.adoc | 4 ++- .../ref_minimum-system-requirements.adoc | 6 +++-- 7 files changed, 56 insertions(+), 5 deletions(-) create mode 100644 docs/modules/getting_started/examples/snip_crc_preset_list.adoc create mode 100644 docs/modules/getting_started/examples/snip_crc_preset_names.adoc create mode 100644 docs/modules/getting_started/examples/snip_crc_preset_platforms.adoc diff --git a/docs/antora-playbook.yml b/docs/antora-playbook.yml index 19ef7ee470..bed8803234 100644 --- a/docs/antora-playbook.yml +++ b/docs/antora-playbook.yml @@ -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 - diff --git a/docs/modules/getting_started/examples/snip_crc_preset_list.adoc b/docs/modules/getting_started/examples/snip_crc_preset_list.adoc new file mode 100644 index 0000000000..c26dc67e5d --- /dev/null +++ b/docs/modules/getting_started/examples/snip_crc_preset_list.adoc @@ -0,0 +1,4 @@ +* {ocp} +* {okd} +* {ushift} +* Podman container runtime diff --git a/docs/modules/getting_started/examples/snip_crc_preset_names.adoc b/docs/modules/getting_started/examples/snip_crc_preset_names.adoc new file mode 100644 index 0000000000..677c508ceb --- /dev/null +++ b/docs/modules/getting_started/examples/snip_crc_preset_names.adoc @@ -0,0 +1,17 @@ +.Preset names +|=== +| Name | Preset + +| `openshift` +| {ocp} + +| `okd` +| {okd} + +| `microshift` +| {ushift} + +| `podman` +| Podman container runtime + +|=== diff --git a/docs/modules/getting_started/examples/snip_crc_preset_platforms.adoc b/docs/modules/getting_started/examples/snip_crc_preset_platforms.adoc new file mode 100644 index 0000000000..01aae92ae6 --- /dev/null +++ b/docs/modules/getting_started/examples/snip_crc_preset_platforms.adoc @@ -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 + +|=== diff --git a/docs/modules/getting_started/partials/con_about-presets.adoc b/docs/modules/getting_started/partials/con_about-presets.adoc index f80bb805e1..95649d298b 100644 --- a/docs/modules/getting_started/partials/con_about-presets.adoc +++ b/docs/modules/getting_started/partials/con_about-presets.adoc @@ -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. diff --git a/docs/modules/getting_started/partials/proc_changing-the-selected-preset.adoc b/docs/modules/getting_started/partials/proc_changing-the-selected-preset.adoc index fa6830fded..0429df4e76 100644 --- a/docs/modules/getting_started/partials/proc_changing-the-selected-preset.adoc +++ b/docs/modules/getting_started/partials/proc_changing-the-selected-preset.adoc @@ -22,7 +22,9 @@ To enable preset changes, you must delete the existing instance and start a new $ {bin} config set preset ____ ---- + -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 diff --git a/docs/modules/getting_started/partials/ref_minimum-system-requirements.adoc b/docs/modules/getting_started/partials/ref_minimum-system-requirements.adoc index 2e07c94d15..783f3981a1 100644 --- a/docs/modules/getting_started/partials/ref_minimum-system-requirements.adoc +++ b/docs/modules/getting_started/partials/ref_minimum-system-requirements.adoc @@ -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: