VMware: Update the README.md and add a QUICKSTART-VMWARE
#1559
Conversation
|
^ Missed a pair of quotes. :) |
|
^ Rebase and fix merge conflict |
|
^ Addressed @jpculp 's feedback and added a commit to fix the stylized quotes in the README |
| The following will download and verify the root role itself: | ||
|
|
||
| ``` | ||
| curl -O "https://cache.bottlerocket.aws/root.json" |
There was a problem hiding this comment.
As we rotate the root, we'll need to figure out how to keep this up to date. Probably just as a runbook step since the root rotation isn't super frequent.
QUICKSTART-VMWARE.md
Outdated
| ``` | ||
| cat <<EOF > userdata.toml | ||
| [settings.kubernetes] | ||
| api-server = "${API_SERVER:-<API_SERVER>}" |
There was a problem hiding this comment.
I'm not sure the default-value syntax with placeholders are valuable here. I think it's clear that we're using the values that we produced above, and that that one could paste something into this if they preferred.
README.md
Outdated
| @@ -352,6 +363,10 @@ The following settings are set for you automatically by [pluto](sources/api/) ba | |||
| * `memory`: in mebibytes from the max num of pods on the instance. `memory_to_reserve = max_num_pods * 11 + 255`. | |||
| * `ephemeral-storage`: defaults to `1Gi`. | |||
|
|
|||
| For Kubernetes variants in AWS, the following settings are set for you automatically by [pluto](sources/api/). | |||
| * `settings.kubernetes.max-pods`: The maximum number of pods that can be scheduled on this node (limited by number of available IPv4 addresses) | |||
| * `settings.kubernetes.cluster-dns-ip`: The CIDR block of the primary network interface. | |||
There was a problem hiding this comment.
| * `settings.kubernetes.cluster-dns-ip`: The CIDR block of the primary network interface. | |
| * `settings.kubernetes.cluster-dns-ip`: Derived from the EKS IPV4 Service CIDR or the CIDR block of the primary network interface. |
|
I've got a fair number of comments coming as I work through this - mostly that the examples aren't super easy to copy/paste and run, which is important when there are this many manual steps. |
| You must be able to access vSphere, via webUI or some type of client. | ||
| We will use the CLI tool [`govc`](https://github.com/vmware/govmomi/tree/master/govc) to communicate with vSphere in this quide. | ||
| `govc` can use [environment variables or take arguments](https://github.com/vmware/govmomi/tree/master/govc#usage) to specify needed parameters. | ||
| For the purposes of this guide we will assume that the following environment variables are set to the proper values in your environment: |
There was a problem hiding this comment.
We also expect jq to be installed to work through the examples, and the AWS CLI to work through the optional steps to enable the control container.
|
^ Addressed all the comments! Thanks for the feedback. |
QUICKSTART-VMWARE.md
Outdated
|
|
||
| You'll need to install [`tuftool`](https://github.com/awslabs/tough/blob/develop/tuftool/README.md) to assist you with fetching the signed Bottlerocket OVA from the Bottlerocket TUF repository. | ||
|
|
||
| If you'd (optionally) like to make use of the control container, you'll need an AWS account, AWS CLI, and `jq` installed. |
There was a problem hiding this comment.
We also use jq to populate the network in the spec.
This adds a new QUICKSTART document for VMware, describing in depth how to get started launching Bottlerocket using the VMware platform.
This updates the top level README, adding additional details about VMware variants as well as linking to the VMware QUICKSTART document.
|
^ Added the |
Issue number:
Closes #1412
Description of changes:
Testing done:
Ran through the steps in the
QUICKSTARTw/ @jpculp.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.