Update docs for Advanced Bare Metal cluster configuration: #8831
Conversation
We changed to embedded images which necessitated the doc update. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>
eks-distro-bot
added
the
size/XL
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8831 +/- ##
=======================================
Coverage 73.66% 73.66%
=======================================
Files 578 578
Lines 36618 36618
=======================================
Hits 26973 26973
Misses 7919 7919
Partials 1726 1726 ☔ View full report in Codecov by Sentry. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jacobweinstock The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
| @@ -481,7 +468,7 @@ spec: | |||
| version: "0.1" | |||
| ``` | |||
|
|
|||
| ### RHEL TinkerbellTemplateConfig example | |||
| ### Redhat | |||
There was a problem hiding this comment.
We are a bit inconsistent with how we use "Red Hat" in our docs. I'd suggest using "Red Hat" if you mean the company, "Red Hat Enterprise Linux" if you mean the OS, or "redhat" if you mean the option you use on the command line. If you mean to include other RHEL clones, maybe say something like "Red Hat Enterprise Linux or compatible OS".
| By creating your own custom Tinkerbell actions, you can add to or modify the installed operating system so those changes take effect when the installed system first starts (from a reboot or pivot). | ||
| The following example shows how to add a .deb package (`openssl`) to an Ubuntu installation: | ||
|
|
||
| The following example shows how to add a .deb package (`openssl`) to a Redhat installation: |
There was a problem hiding this comment.
Probably "Red Hat", but see my note about different ways to refer to it.
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Co-authored-by: Chris Negus <striker57@gmail.com>
Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>
Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>
Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>
|
/lgtm |
| Pay special attention to the `BOOTCONFIG_CONTENTS` environment section below if you wish to set up console redirection for the kernel and systemd. | ||
| If you are only using a direct attached monitor as your primary display device, no additional configuration is needed here. | ||
| However, if you need all boot output to be shown via a server's serial console for example, extra configuration should be provided inside `BOOTCONFIG_CONTENTS`. | ||
| Each Action has its own set of environment variables that are used to configure the Action. EKS Anywhere embeds a set of images into HookOS. This means that when these images are used in an Action they will not be pulled from any external registry. No external network communication is needed to use them. These Actions are prefixed with `127.0.0.1/embedded`. |
There was a problem hiding this comment.
does user still have the option to pull images from public ecr like in the example before? If yes do we want to add an example of pulling from public ecr?
There was a problem hiding this comment.
Yes. Users can pull images from anywhere they want. I think if that wasn't clear then I should update the doc to make that more clear.
In regard to providing an explicit example for pulling from ECR, I don't think we should. The whole idea of the embedded images is that pulling from ECR is not necessary. Also, there is not "latest" images in ECR for all the images. Each release we do has a new ECR location for images. Keeping these up to date in the docs adds to the already full load of work required for each release and we have opted to not do this. This would also mean that any exact reference provided in the docs would quickly be out of date.
Issue #, if available:
Description of changes:
We changed to embedded images which necessitated the doc update.
Testing (if applicable):
Documentation added/planned (if applicable):
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.