Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
62 lines (44 loc) · 1.34 KB

DEVELOPMENT.md

File metadata and controls

62 lines (44 loc) · 1.34 KB

Development guide

Commit messages

We use Conventional Commits specification for commit messages to automate the release process. The spec is enforced by github action based validation.

Running development cluster

You can use KIND to get a local cluster for development.

cat <<EOF > kind-poc-cluster.yaml
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
name: poc
nodes:
- role: control-plane
- role: worker
- role: worker
featureGates:
  InPlacePodVerticalScaling: true 
EOF
kind create cluster --config kind-poc-cluster.yaml

Deploying development version

  1. Install CRDs on a cluster

    make install

  2. Build docker image

    make docker-build IMG=kube-startup-cpu-boost:dev

  3. Load docker image to development cluster

    kind load docker-image --name poc kube-startup-cpu-boost:dev

  4. Enable development logging and other options if needed

    In config/default/kustomization.yaml uncomment the dev patch:

    # Uncomment below for development
- manager_config_dev_patch.yaml

    Adapt the config/default/manager_config_dev_patch.yaml if needed.

  5. Deploy controller on a cluster

    make deploy IMG=docker.io/library/kube-startup-cpu-boost:dev