Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add VM Prerequisites to Getting Started Guide #267

Merged
merged 2 commits into from
Nov 24, 2021
Merged

Add VM Prerequisites to Getting Started Guide #267

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cac6e5
Add VM Prerequisites to Getting Started Guide
anusha94 Nov 24, 2021
4a8e045
Fix conntrack typo
anusha94 Nov 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,31 @@ done
### Register BYOH host to management cluster

---
#### VM Prerequisites
- The following packages must be pre-installed on the VMs
- socat
- ebtables
- ethtool
- conntrack
- You can install these with
``` shell
sudo apt-get install socat ebtables ethtool conntrack
```
- The output of `hostname` should be added to `/etc/hosts`

Example:
```shell
$ hostname
node01

$ cat /etc/hosts
127.0.0.1 localhost
127.0.0.1 node01
...
```

If you are trying this on your own hosts, then for each host
1. Download the [byoh-hostagent-linux-amd64](https://github.com/vmware-tanzu/cluster-api-provider-bringyourownhost/releases/download/v0.1.0-alpha.1/byoh-hostagent-linux-amd64)
1. Download the [byoh-hostagent-linux-amd64](https://github.com/vmware-tanzu/cluster-api-provider-bringyourownhost/releases/download/v0.1.0-alpha.2/byoh-hostagent-linux-amd64)
2. Copy the management cluster `kubeconfig` file as `management.conf`
3. Start the agent
```shell
Expand Down Expand Up @@ -150,7 +173,7 @@ Running the following command(on the host where you execute `clusterctl` in prev
```shell
$ CONTROL_PLANE_ENDPOINT_IP=10.10.10.10 clusterctl generate cluster byoh-cluster \
--infrastructure byoh \
--kubernetes-version v1.22.0 \
--kubernetes-version v1.22.3 \
shamsher31 marked this conversation as resolved.
Show resolved Hide resolved
--control-plane-machine-count 1 \
--worker-machine-count 1 > cluster.yaml

Expand Down Expand Up @@ -188,7 +211,7 @@ after that you should see your nodes turn into ready:
```shell
$ KUBECONFIG=byoh-cluster.kubeconfig kubectl get nodes
NAME STATUS ROLES AGE VERSION
byoh-cluster-8siai8 Ready master 5m v1.21.2
byoh-cluster-8siai8 Ready master 5m v1.22.3

```

Expand Down