Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 2.79 KB

setup.md

File metadata and controls

105 lines (71 loc) · 2.79 KB
Raw

Local Development Setup

Requirements

  • go >= 1.20
  • git, make and kubectl
  • Kustomize
  • Access to a Kubernetes cluster (Minikube, kind or a real cluster)

Clone the Repository

To bring up and start locally the ironcore project for development purposes you first need to clone the repository.

git clone git@github.com:ironcore-dev/ironcore.git
cd ironcore

Install cert-manager

If there is no cert-manager present in the cluster it needs to be installed.

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.8.0/cert-manager.yaml

Install APIs into the Cluster

Your Kubernetes API server needs to know about the APIs which come with the ironcore project. To install the APIs your cluster, run

make install

Note: This requires the APISERVER_IMG (Makefile default set to apiserver) to be pullable from your kubernetes cluster. For local development with kind, a make target that builds and loads the api server image and then applies the manifests is available via

make kind-install

Note: In case that there are multiple environments running, ensure that kind get clusters is pointing to the default kind cluster.

Start the Controller Manager

The controller manager can be started via the following command

make run

Apply Sample Manifests

The config/samples folder contains samples for all APIs supported by this project. You can apply any of the samples by running

kubectl apply -f config/samples/SOME_RESOURCE.yaml

Rebuilding API Type and Manifests

Everytime a change has been done to any of the types definitions, the corresponding manifests and generated code pieces have to be rebuilt.

make generate
make manifests

Note: Make sure your APIs are up-to-date by running make install / make kind-install after your code / manifests have been regenerated.

Setup formatting tools

The project uses gofmt and goimports for formatting. gofmt is used with default settings. While goimports should be used with --local github.com/ironcore-dev flag, so that goimports would sort ironcore pkgs separately.

You can automate running formatting tools in your IDE.

  • VSCode -- add following to the settings.json:
    "go.formatTool": "goimports",
    "gopls": {
        "formatting.local": "github.com/ironcore-dev",
    },
  • Goland -- go to File -> Settings -> Tools -> File Watchers and replace contents of Arguments with --local github.com/ironcore -w $FilePath$

Cleanup

To remove the APIs from your cluster, simply run

make uninstall

--8<-- "hack/docs/abbreviations.md"