CAPI IPAM Provider For Nutanix (CAIPAMX)

For user docs, please see [https://nutanix-cloud-native.github.io/cluster-api-ipam-provider-nutanix/].

See upstream documentation.

Development

Install tools

• Devbox
• Direnv
• Container Runtime for your Operating System

To deploy a local build, either an initial install or to update an existing deployment, run:

make dev.run-on-kind
eval $(make kind.kubeconfig)

Pro-tip: to redeploy without rebuilding the binaries, images, etc (useful if you have only changed the Helm chart for example), run:

make SKIP_BUILD=true dev.run-on-kind

Check the pod logs:

kubectl logs deployment/cluster-api-ipam-provider-nutanix -f

To delete the dev KinD cluster, run:

make kind.delete

CLI

CAIPAMX provides a binary for reservation and unreservation via the CLI. The caipamx binary can be downloaded from the releases page.

Alternatively run the following command to download the correct executable for your local machine:

curl -fsSL https://github.com/nutanix-cloud-native/cluster-api-ipam-provider-nutanix/releases/download/v0.4.0/caipamx_v0.4.0_"$(uname -s | tr '[:upper:]' '[:lower:]')"_"$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/')".tar.gz | tar xzv -- caipamx

Reserving an IP

$ caipamx reserve --help
Reserve IP addresses in a subnet

Usage:
  caipamx reserve [flags]

Flags:
  -h, --help   help for reserve

Global Flags:
      --aos-cluster string      Nutanix AOS cluster to reserve IPs in, either UUID or name
      --password string         Password for Nutanix Prism Central (also configurable via NUTANIX_PASSWORD environment variable)
      --prism-endpoint string   Address of Nutanix Prism Central
      --subnet string           Subnet to reserve IPs in, either UUID or name
      --user string             Username for Nutanix Prism Central (also configurable via NUTANIX_USER environment variable)

All flags other than --cluster are required.

Reserve a single IP in the specified subnet

caipamx reserve <FLAGS>

Reserve specific IPs in the specified subnet

caipamx reserve <FLAGS> <IP> [<IP>...]

Reserve a specific range of IPs in the specified subnet

caipamx reserve <FLAGS> <IP_FROM>-<IP-TO>

Unreserve an IP

$ caipamx unreserve --help
Unreserve IP addresses in a subnet

Usage:
  caipamx unreserve [flags]

Flags:
  -h, --help   help for unreserve

Global Flags:
      --aos-cluster string      Nutanix AOS cluster to reserve IPs in, either UUID or name
      --password string         Password for Nutanix Prism Central (also configurable via NUTANIX_PASSWORD environment variable)
      --prism-endpoint string   Address of Nutanix Prism Central
      --subnet string           Subnet to reserve IPs in, either UUID or name
      --user string             Username for Nutanix Prism Central (also configurable via NUTANIX_USER environment variable)

Unreserve specific IPs in the specified subnet

caipamx unreserve <FLAGS> <IP> [<IP>...]

Unreserve a specific range of IPs in the specified subnet

caipamx unreserve <FLAGS> <IP_FROM>-<IP-TO>