Documentation: Add and update documentation for metal variants #2205
Conversation
HARDWARE.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| # Bottlerocket test hardware | |||
There was a problem hiding this comment.
I feel like this could be consolidated with the PROVISIONING-METAL doc, and I wonder if that one should be called QUICKSTART-METAL.
There was a problem hiding this comment.
IMHO, the hardware felt worthy of it's own doc rather than buried in other metal documentation.
Re: QUICKSTART-METAL, I opted not to create a "quickstart" type doc since provisioning bare metal machines isn't really prescriptive like we can be with AWS variants; "run this command to start an instance", etc.
There was a problem hiding this comment.
IMHO, the hardware felt worthy of it's own doc rather than buried in other metal documentation.
Re: QUICKSTART-METAL, I opted not to create a "quickstart" type doc since provisioning bare metal machines isn't really prescriptive like we can be with AWS variants; "run this command to start an instance", etc.
Makes sense. I'm still wondering if HARDWARE.md and PROVISIONING-METAL.md should be consolidated instead of being separate documents. Maybe METAL.md?
|
^ addresses @etungsten 's comments |
|
HARDWARE.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| # Bottlerocket test hardware | |||
There was a problem hiding this comment.
IMHO, the hardware felt worthy of it's own doc rather than buried in other metal documentation.
Re: QUICKSTART-METAL, I opted not to create a "quickstart" type doc since provisioning bare metal machines isn't really prescriptive like we can be with AWS variants; "run this command to start an instance", etc.
Makes sense. I'm still wondering if HARDWARE.md and PROVISIONING-METAL.md should be consolidated instead of being separate documents. Maybe METAL.md?
PROVISIONING-METAL.md
Outdated
| Settings prefixed with `init` are added to the kernel command line after the `--`, but before any existing init parameters. | ||
|
|
||
| In the example below, two console devices are set up, and `systemd`'s log level is set to `debug`. | ||
| It is important to note that the kernel will output to both console devices, but `systemd` outputs to the last device in line (`ttyS1,115200n8` in the example below). |
There was a problem hiding this comment.
Maybe add this note below, although it feels a bit discursive.
|
^ Address all comments |
| The Bottlerocket SDK provides the `bootconfig` CLI tool, which is used to create a Boot Configuration initrd. | ||
| To create the Boot Configuration initrd, create a config file named `bootconfig-input` containing your desired key/value pair kernel and init arguments. | ||
|
|
||
| Then run the following (you will need Docker installed): |
There was a problem hiding this comment.
Should we also mention the related cargo make tasks as another option in addition to the docker run commands?
|
^ Fix the HP model number in the supported hardware table |
|
^ I made a mistake with the HP model number, it's correct now. |
This adds a new file SUPPORTED-HARDWARE.md meant to document the hardware that Bottlerocket is currently tested on, as well as hardware known by the community to work with Bottlerocket.
This adds a new document that describes the files and process needed to provision Bottlerocket on a bare metal machine.
Updates README.md to add some additional information for metal variants.
|
^ Addresses the last few nits |
Description of changes:
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.