Clean up airgapped docs #6672

csplinter · 2023-09-11T16:15:08Z

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov · 2023-09-11T16:26:06Z

Codecov Report

Patch coverage has no change and project coverage change: -0.01% ⚠️

Comparison is base (82807d0) 75.63% compared to head (9ee91e4) 75.62%.
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6672      +/-   ##
==========================================
- Coverage   75.63%   75.62%   -0.01%     
==========================================
  Files         473      473              
  Lines       38219    38234      +15     
==========================================
+ Hits        28907    28916       +9     
- Misses       7717     7721       +4     
- Partials     1595     1597       +2

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

chrisnegus

Just a few comments.

chrisnegus · 2023-09-11T16:29:28Z

docs/content/en/docs/clustermgmt/cluster-upgrades/airgapped-upgrades.md

+- **The upgraded version of the `eksctl anywhere` CLI installed on the Admin machine**
+- Docker running on the Admin machine
+- At least 80GB in storage space on the Admin machine to temporarily store the EKS Anywhere images locally before importing them to your local registry. Currently, when downloading images, EKS Anywhere pulls all dependencies for all infrastructure providers and supported Kubernetes versions.
+- The download and import images commands must be run on an amd64 machine to import amd64 images to the registry mirror.


Are you saying that the Admin machine (where I believe these commands will be run) must be an amd64 machine? Aren't some macOS machines arm-based? If so, should we note that in Admin machine requirements for someone wanting to do airgapped?

@d8660091 thoughts?

When a user runs "download images" in their admin machine, the "docker pull" will run to pull the images. And since "docker pull" only pull images matching the admin machine's arch, arm64 admin machine will eventually upload only arm64 images to the registry mirror. So admin machine needs to be amd64

So I guess I think the requirement is if you're running in an airgapped environment, you need to have an amd64 admin machine

I added the following note to the admin machine page

If you are running in an airgapped environment, the Admin machine must be amd64.

chrisnegus · 2023-09-11T16:35:02Z

docs/content/en/docs/clustermgmt/cluster-upgrades/airgapped-upgrades.md

-   eksctl anywhere import images -i images.tar -r <registryUrl> \
-      --bundles ./eks-anywhere-downloads/bundle-release.yaml
-   ```
+>**_NOTE:_** If you are running EKS Anywhere on bare metal, you must configure `osImageURL` and `hookImagesURLPath` in your EKS Anywhere cluster specification with the location of the upgraded node operating system image and hook OS image. For details, reference the [bare metal configuration documentation.]({{< relref "../../getting-started/baremetal/bare-spec/#osimageurl" >}})


I've tried to use "Bare Metal" with initial caps, so it looks more like an EKS Anywhere provider, rather than just a reference to a piece of hardware. Right now, the docs are somewhat inconsistent, so maybe we should make a choice.

It's not an official product name so we should not use capitalization. See Vipin's original blog https://aws.amazon.com/blogs/containers/introducing-bare-metal-deployments-for-amazon-eks-anywhere/

Sure. That's your call. We can begin dismantling those as we run into them.

docs/content/en/docs/getting-started/airgapped/_index.md

chrisnegus · 2023-09-11T16:50:46Z

docs/content/en/docs/getting-started/airgapped/_index.md

+- An existing [Admin machine]({{< relref "../install" >}})
+- Docker running on the Admin machine
+- At least 80GB in storage space on the Admin machine to temporarily store the EKS Anywhere images locally before importing them to your local registry. Currently, when downloading images, EKS Anywhere pulls all dependencies for all infrastructure providers and supported Kubernetes versions.
+- The download and import images commands must be run on an amd64 machine to import amd64 images to the registry mirror.


Same question about Admin machine requirements for airgapped as above.

chrisnegus · 2023-09-11T17:41:35Z

docs/content/en/docs/getting-started/airgapped/airgap-steps.md

+   tar -xvf eks-anywhere-downloads.tar.gz
+   ```
+
+1. Download the EKS Anywhere image dependencies to the Admin machine. This command may take several minutes (10+) to complete. To monitor the progress of the command, you can run with the `-v 6` command line argument, which will show details of the images that are being pulled. Docker must be running for the following command to succeed.


Looks like you are assuming they are using another machine besides the Admin machine. Should we say that somewhere in the prerequisites?

This is the Admin machine ... I'm not sure exactly what you mean by "assuming they are using another machine". We can remove the statement about Docker if that's what's causing the confusion here

No. You fixed the issue by saying that the Admin machine must be amd64 to do airgapped. There was a sentence that you deleted that said that the images commands "need to be run on an amd64 machine to import amd64 images to the registry mirror." It didn't say Admin machine.

docs/content/en/docs/packages/prereq.md

Co-authored-by: Chris Negus <[email protected]>

csplinter · 2023-09-12T19:05:35Z

note to self need to clarify packages page for configuring PBC

does the --dst-cert expect the actual cert or a path to the cert file?
Path

Do we need to configure this on the already existing pbc or create a new one with these values?
Both way should work

Update: added in commit 9ee91e4

chrisnegus · 2023-09-13T18:50:22Z

/lgtm

eks-distro-bot · 2023-09-14T14:51:45Z

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

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:

docs/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

csplinter · 2023-09-14T14:52:14Z

/cherry-pick release-0.17

eks-distro-pr-bot · 2023-09-14T14:52:16Z

@csplinter: once the present PR merges, I will cherry-pick it on top of release-0.17 in a new PR and assign it to you.

In response to this:

/cherry-pick release-0.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

eks-distro-pr-bot · 2023-09-14T14:53:48Z

@csplinter: #6672 failed to apply on top of branch "release-0.17":

Applying: cleanup airgapped docs
.git/rebase-apply/patch:207: trailing whitespace.
   
.git/rebase-apply/patch:220: trailing whitespace.
1. Import images to the local registry mirror using the following command. Set `REGISTRY_MIRROR_URL` to the url of the local registry mirror you created in the previous step. This command may take several minutes to complete. To monitor the progress of the command, you can run with the `-v 6` command line argument.  
.git/rebase-apply/patch:230: trailing whitespace.
   
.git/rebase-apply/patch:233: trailing whitespace.
      <br /> 
.git/rebase-apply/patch:271: trailing whitespace.
EKS Anywhere supports many different types of infrastructure including VMWare vSphere, bare metal, Snow, Nutanix, and Apache CloudStack. You can also run EKS Anywhere on Docker for dev/test use cases only. EKS Anywhere clusters can only run on a single infrastructure provider. For example, you cannot have some vSphere nodes, some bare metal nodes, and some Snow nodes in a single EKS Anywhere cluster. Management clusters also must run on the same infrastructure provider as workload clusters. 
warning: squelched 1 whitespace error
warning: 6 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	docs/content/en/docs/getting-started/baremetal/bare-prereq.md
M	docs/content/en/docs/getting-started/optional/registrymirror.md
Falling back to patching base and 3-way merge...
Auto-merging docs/content/en/docs/getting-started/optional/registrymirror.md
Auto-merging docs/content/en/docs/getting-started/baremetal/bare-prereq.md
CONFLICT (content): Merge conflict in docs/content/en/docs/getting-started/baremetal/bare-prereq.md
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 cleanup airgapped docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-0.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

chrisnegus · 2023-09-15T21:13:34Z

/cherry-pick release-0.17

eks-distro-pr-bot · 2023-09-15T21:14:09Z

@chrisnegus: #6672 failed to apply on top of branch "release-0.17":

Applying: cleanup airgapped docs
.git/rebase-apply/patch:207: trailing whitespace.
   
.git/rebase-apply/patch:220: trailing whitespace.
1. Import images to the local registry mirror using the following command. Set `REGISTRY_MIRROR_URL` to the url of the local registry mirror you created in the previous step. This command may take several minutes to complete. To monitor the progress of the command, you can run with the `-v 6` command line argument.  
.git/rebase-apply/patch:230: trailing whitespace.
   
.git/rebase-apply/patch:233: trailing whitespace.
      <br /> 
.git/rebase-apply/patch:271: trailing whitespace.
EKS Anywhere supports many different types of infrastructure including VMWare vSphere, bare metal, Snow, Nutanix, and Apache CloudStack. You can also run EKS Anywhere on Docker for dev/test use cases only. EKS Anywhere clusters can only run on a single infrastructure provider. For example, you cannot have some vSphere nodes, some bare metal nodes, and some Snow nodes in a single EKS Anywhere cluster. Management clusters also must run on the same infrastructure provider as workload clusters. 
warning: squelched 1 whitespace error
warning: 6 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	docs/content/en/docs/getting-started/baremetal/bare-prereq.md
Falling back to patching base and 3-way merge...
Auto-merging docs/content/en/docs/getting-started/baremetal/bare-prereq.md
CONFLICT (content): Merge conflict in docs/content/en/docs/getting-started/baremetal/bare-prereq.md
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 cleanup airgapped docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-0.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

chrisnegus · 2023-09-15T21:19:44Z

/cherry-pick release-0.17

eks-distro-pr-bot · 2023-09-15T21:20:18Z

@chrisnegus: #6672 failed to apply on top of branch "release-0.17":

Applying: cleanup airgapped docs
.git/rebase-apply/patch:207: trailing whitespace.
   
.git/rebase-apply/patch:220: trailing whitespace.
1. Import images to the local registry mirror using the following command. Set `REGISTRY_MIRROR_URL` to the url of the local registry mirror you created in the previous step. This command may take several minutes to complete. To monitor the progress of the command, you can run with the `-v 6` command line argument.  
.git/rebase-apply/patch:230: trailing whitespace.
   
.git/rebase-apply/patch:233: trailing whitespace.
      <br /> 
.git/rebase-apply/patch:271: trailing whitespace.
EKS Anywhere supports many different types of infrastructure including VMWare vSphere, bare metal, Snow, Nutanix, and Apache CloudStack. You can also run EKS Anywhere on Docker for dev/test use cases only. EKS Anywhere clusters can only run on a single infrastructure provider. For example, you cannot have some vSphere nodes, some bare metal nodes, and some Snow nodes in a single EKS Anywhere cluster. Management clusters also must run on the same infrastructure provider as workload clusters. 
warning: squelched 1 whitespace error
warning: 6 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	docs/content/en/docs/getting-started/baremetal/bare-prereq.md
Falling back to patching base and 3-way merge...
Auto-merging docs/content/en/docs/getting-started/baremetal/bare-prereq.md
CONFLICT (content): Merge conflict in docs/content/en/docs/getting-started/baremetal/bare-prereq.md
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 cleanup airgapped docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-0.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

cleanup airgapped docs

d561291

csplinter added area/docs Documentation docathon labels Sep 11, 2023

github-actions bot added the documentation label Sep 11, 2023

eks-distro-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 11, 2023

chrisnegus reviewed Sep 11, 2023

View reviewed changes

csplinter and others added 3 commits September 11, 2023 12:53

wording change to first sentence

8bc27fe

Co-authored-by: Chris Negus <[email protected]>

fix typo

0ed0eeb

Co-authored-by: Chris Negus <[email protected]>

wording change in second paragraph

a88fbd2

Co-authored-by: Chris Negus <[email protected]>

csplinter added 2 commits September 13, 2023 12:27

add amd64 note to Admin machine page

5d58b93

packages clarifications

9ee91e4

eks-distro-bot assigned chrisnegus Sep 13, 2023

eks-distro-bot added the lgtm label Sep 13, 2023

csplinter added the approved label Sep 14, 2023

csplinter merged commit 3c98b48 into aws:main Sep 14, 2023
5 checks passed

chrisnegus mentioned this pull request Sep 26, 2023

Cherry-pick of PR6672 #6729

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up airgapped docs #6672

Clean up airgapped docs #6672

csplinter commented Sep 11, 2023

codecov bot commented Sep 11, 2023 •

edited

Loading

chrisnegus left a comment

chrisnegus Sep 11, 2023

csplinter Sep 11, 2023

d8660091 Sep 11, 2023 •

edited

Loading

csplinter Sep 11, 2023

csplinter Sep 13, 2023

chrisnegus Sep 11, 2023

csplinter Sep 11, 2023

chrisnegus Sep 13, 2023

chrisnegus Sep 11, 2023

chrisnegus Sep 11, 2023

csplinter Sep 11, 2023

chrisnegus Sep 13, 2023

csplinter commented Sep 12, 2023 •

edited

Loading

chrisnegus commented Sep 13, 2023

eks-distro-bot commented Sep 14, 2023

csplinter commented Sep 14, 2023

eks-distro-pr-bot commented Sep 14, 2023

eks-distro-pr-bot commented Sep 14, 2023

chrisnegus commented Sep 15, 2023

eks-distro-pr-bot commented Sep 15, 2023

chrisnegus commented Sep 15, 2023

eks-distro-pr-bot commented Sep 15, 2023

Clean up airgapped docs #6672

Clean up airgapped docs #6672

Conversation

csplinter commented Sep 11, 2023

codecov bot commented Sep 11, 2023 • edited Loading

Codecov Report

chrisnegus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

d8660091 Sep 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csplinter commented Sep 12, 2023 • edited Loading

chrisnegus commented Sep 13, 2023

eks-distro-bot commented Sep 14, 2023

csplinter commented Sep 14, 2023

eks-distro-pr-bot commented Sep 14, 2023

eks-distro-pr-bot commented Sep 14, 2023

chrisnegus commented Sep 15, 2023

eks-distro-pr-bot commented Sep 15, 2023

chrisnegus commented Sep 15, 2023

eks-distro-pr-bot commented Sep 15, 2023

codecov bot commented Sep 11, 2023 •

edited

Loading

d8660091 Sep 11, 2023 •

edited

Loading

csplinter commented Sep 12, 2023 •

edited

Loading