Skip to content

Commit 988c62d

Browse files
authored
Merge pull request #784 from cprivitere/doc-flavor
📖 Update flavor documentation to better explain EMLB and other VIP Manager options.
2 parents 8ff0b6e + 448c6c7 commit 988c62d

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/experiences/flavors.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# Flavors & Custom Templates
22

3-
## Kube-VIP
3+
The main use of flavors in the Cluster API Provider Packet project is to choose which type of VIP Management you'd like to use in your cluster.
4+
5+
## VIP Choices
6+
7+
The VIP Management choice affects what will manage the floating IP that points to your control plane nodes. We currently support:
8+
9+
- EMLB managed
10+
- CPEM managed
11+
- Kube-VIP managed
412

513
### API Server VIP Management Choice
614

7-
By default CPEM will be used to manage the EIP that serves as the VIP for the api-server. Other flavors include kube-vip and Equinix Metal Load Balancer.
15+
By default CPEM will be used to manage the EIP that serves as the VIP for the api-server. This mode uses CPEM to manage an EIP address and assign it to one of the control plane nodes and move it as needed as nodes are created/destroyed.
816

917
### Choosing Equinix Metal Load Balancer
1018

19+
This mode creates an Equinix Metal Load Balancer and adds the control plane nodes to an origin pool behind the load balancer.
20+
1121
To use Equinix Metal Load Balancer, when generating the template with `clusterctl`, pass in the `--flavor emlb` flag. For example, your `clusterctl generate` command might look like the following:
1222

1323
```sh
@@ -22,6 +32,8 @@ clusterctl generate cluster capi-quickstart \
2232

2333
### Choosing Kube-VIP
2434

35+
This mode lets Kube-VIP manage a floating EIP address by using BGP to update the routing table of the network.
36+
2537
To use kube-vip, when generating the template with `clusterctl`, pass in the `--flavor kube-vip` flag. For example, your `clusterctl generate` command might look like the following:
2638

2739
```sh
@@ -50,7 +62,7 @@ The workflow triggered by that command summarized here:
5062

5163
1. Based on the `--infrastructure` option it goes to the right repository and it
5264
looks for the `latest` release. At the time I am writing it is
53-
[v0.3.0](gh-release-v030).
65+
[v0.9.0](https://github.com/kubernetes-sigs/cluster-api-provider-packet/releases/tag/v0.9.0).
5466
2. `clusterctl` lookup a file called `cluster-template.yaml` from the release artifacts
5567
3. `clusterctl` uses `cluster-template.yaml` plus a set of environment variables
5668
that you can find described in the README.md to generate the cluster
@@ -84,5 +96,3 @@ automation. Here a few examples:
8496

8597
If you want to change operating system you have to change the `OS` field
8698
for the `PacketMachineTemplate` resource.
87-
88-
[gh-release-v030]: https://github.com/kubernetes-sigs/cluster-api-provider-packet/releases/tag/v0.3.0

0 commit comments

Comments
 (0)