mneverov / cluster-cidr-controller

cluster-cidr-controller

Out of tree implementation of https://github.com/kubernetes/enhancements/tree/master/keps/sig-network/2593-multiple-cluster-cidrs

It allows users to use an ipam-controller that allocates IP ranges to Nodes, setting the node.spec.PodCIDRs fields The ipam-controller is configured via CRDs

cluster-cidr-controller's Issues

Adjust Repo to New Name: node-ipam-controller

It was decided to go with node-ipam-controller name.
This repository should be renamed and refactored accordingly. See also #14

Move networking.x-k8s.io from ClusterRole to Role

Currently, access to networking.x-k8s.io is defined as ClusterRole, whereas it can be limited to a namespace devoted to the controller.

Acceptance Criteria

• access to networking.x-k8s.io is defined in a namespaced role
• ClusterCIDR type is namespaced
• check templates if they need to be changed too

Add Helm Charts

Cleanup kubebuilder generated files except roles and CRD.
Add helm charts so the controller can be deployed in k8s cluster.
Adjust makefile so that it uses update-codegen instead of controller-gen.

Create binary that can be deployed in a cluster

This looks good, but we also need to provide users with the capability to use it independently, take per example a look at this project of mine https://github.com/aojea/kindnet

It has a Dockerfile and provides a manifests to install it.

It also has a github action to run e2e tests https://github.com/aojea/kindnet/tree/master/.github/workflows

Great work, we are close

Add E2E Tests

See kindnet as a reference.
Release should depend on e2e tests.

Open Questions:

• What should be tested? Run full e2e.test from k8s on kind that is ran with --allocate-node-cidrs=false (see kind config)?

Add Readme

Should contain description what controller is for and instruction how to run it.

Port Integration tests

See ipam_test and main_test in k8s.

Set Up Validation

Validation is ported, but not linked anywhere. Originally, it was set up via internal storage registry. It is too cumbersome to set up ApiServer just to have validation.

Options: webhooks or k8s CEL.

Add health and readiness endpoints

In #15 health and readiness probes were added. Please implement health and readiness endpoints so the status of the controller is updated.

Provide CRDs

The golang types exist, but users need to be able to deploy them as a CRD, commonly people use https://github.com/kubernetes-sigs/kubebuilder for these things

Align Boilerplate File Header

Currently, it is empty, but files that are ported from k8s have different year in Copyright 2022 The Kubernetes Authors.
Decide if there should be "k8s authors" header or not. Align year.