Skip to content

Latest commit

 

History

History
129 lines (87 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

129 lines (87 loc) · 3.37 KB
Raw

How to contribute

Developer documentation for Altinn 3 Kubernetes operators.

Here are some important resources:

Reporting Issues

Open our Github issue tracker and choose an appropriate issue template.

Feel free to query existing issues before creating a new one.

Contributing changes

Local development

Prerequisites

  • go version v1.22.0+
  • docker version 17.03+.
  • kubectl version v1.11.3+.
  • Access to a Kubernetes v1.11.3+ cluster.

To Deploy on the cluster

Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/altinn-k8s-operator:tag

NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.

Install the CRDs into the cluster:

make install

Deploy the Manager to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/altinn-k8s-operator:tag

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

NOTE: Ensure that the samples has default values to test it out.

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

Project Distribution

Following are the steps to build the installer and distribute this project to users.

  1. Build the installer for the image built and published in the registry:
make build-installer IMG=<some-registry>/altinn-k8s-operator:tag

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

  1. Using the installer

Users can just run kubectl apply -f to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/<org>/altinn-k8s-operator/<tag or branch>/dist/install.yaml

Contributing

// TODO: doc

Upgrading

If kubebuilder bumps major version, in some cases there is not much to do. Still, it might be worth it to

  • Upgrade kubebuilder CLI
  • Scaffold a new project
  • Generate some CRD that we use
  • Inspect diff with this repo
  • Case-insensitive search for version to make sure hardcoded versions are up to date
  • Run all builds, tests, lints etc..

That way we don't get stuck on old versions of the scaffold forever.. Example for v3 -> v4 upgrade of CLI:

mkdir altinn-k8s-operator2
cd altinn-k8s-operator2
kubebuilder init --plugins go/v4 --domain altinn.studio --owner "Altinn" --repo "github.com/Altinn/altinn-k8s-operator" --project-name "altinn-k8s-operator"
kubebuilder create api --group resources --version v1alpha1 --kind MaskinportenClient
make manifests