Skip to content

Commit 80ec908

Browse files
authored
Merge pull request #172 from agtogna/readme-clusterctl-incluster
📖 Update README.md
2 parents 0fbb922 + 7bbfd32 commit 80ec908

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
This is a IPAM provider for Cluster API that manages pools of IP addresses using Kubernetes resources. It serves as a reference implementation for IPAM providers, but can also be used as a simple replacement for DHCP.
44

5+
## Setup via clusterctl
6+
7+
This release comes with clusterctl support. Since it's not added to the list of built-in providers yet, you'll need to add the following to your `~/.cluster-api/clusterctl.yaml` if you want to install it using `clusterctl init --ipam incluster`:
8+
9+
```yaml
10+
providers:
11+
- name: in-cluster
12+
url: https://github.com/kubernetes-sigs/cluster-api-ipam-provider-in-cluster/releases/latest/ipam-components.yaml
13+
type: IPAMProvider
14+
```
15+
516
## Usage
617
718
This provider comes with a `InClusterIPPool` resource to specify the pools from which addresses should be assigned. You can provide an address range using start and end addresses, as well as a prefix length, or a set of addresses with the prefix and gateway.

0 commit comments

Comments
 (0)