From 9d9305af67d1faeb02343a24271c44ac99259477 Mon Sep 17 00:00:00 2001 From: Rahul Ganesh Date: Thu, 26 Oct 2023 12:29:35 -0700 Subject: [PATCH] Add Documentation for osImageURL field added to machine config for baremetal Signed-off-by: Rahul Ganesh --- .../content/en/docs/getting-started/baremetal/bare-spec.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/content/en/docs/getting-started/baremetal/bare-spec.md b/docs/content/en/docs/getting-started/baremetal/bare-spec.md index 444a6a8e5f323..094557c354006 100644 --- a/docs/content/en/docs/getting-started/baremetal/bare-spec.md +++ b/docs/content/en/docs/getting-started/baremetal/bare-spec.md @@ -261,6 +261,13 @@ spec: ### osFamily (required) Operating system on the machine. Permitted values: `bottlerocket`, `ubuntu`, `redhat` (Default: `bottlerocket`). +### osImageURL +Optional field to replace the default Bottlerocket operating system. EKS Anywhere can only auto-import Bottlerocket. In order to use Ubuntu or Redhat see [building baremetal node images]({{< relref "../../osmgmt/artifacts/#build-bare-metal-node-images" >}}) +to learn more on building and using Ubuntu with an EKS Anywhere cluster. This field is also useful if you want to provide a customized operating system image or simply host the standard image locally. + +>**_NOTE:_** If specified for a single Machine Config, osImageURL has to be specified for all the Machine Configs. +osImageURL field cannot be specified both at the DatacenterConfig and MachineConfig objects. + ### templateRef (optional) Identifies the template that defines the actions that will be applied to the TinkerbellMachineConfig. See TinkerbellTemplateConfig fields below.