Skip to content

Commit

Permalink
Add Documentation for osImageURL field added to machine config for ba…
Browse files Browse the repository at this point in the history
…remetal

Signed-off-by: Rahul Ganesh <[email protected]>
  • Loading branch information
Rahul Ganesh committed Oct 26, 2023
1 parent 36a789f commit 9d9305a
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/content/en/docs/getting-started/baremetal/bare-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 9d9305a

Please sign in to comment.