Skip to content

Latest commit

 

History

History
266 lines (202 loc) · 10.7 KB

README_DEVELOPERS.md

File metadata and controls

266 lines (202 loc) · 10.7 KB
Raw

Kuberpult Readme for developers

Introduction

Unlike ArgoCD, Kuberpult is not triggered based on push to the repository. It is triggered by REST api instead (or ui which, in turn, calls the REST api). When a /release endpoint is called with the manifest files, it checks the repository for additional information (ArgoCD related), then commits and pushes the manifests to the repository which is then handled by ArgoCD. For full usage instructions, please check the readme.

Install dev tools

It is split into two parts. The backend logic is in the cd-service. The frontend is also split into two parts (but they are both deployed as one microservice), the frontend-service that provides the REST backing for the ui, and the ui-service with the actual ui. The cd-service takes the URL of the repository to watch from the environment variable KUBERPULT_GIT_URL and the branch to watch from the environment variable KUBERPULT_GIT_BRANCH.

Prerequisite software

Setup builder image

You need a builder image that is tagged as latest to build services locally. The following command should do this for you.

  • make builder

There's no need to push the image.

Setup and run instructions (with docker-compose)

  • in services/cd-service, initialize a bare repository with the name repository_remote
cd services/cd-service
git init --bare repository_remote
cd ../..
  • This repository is bare, to populate it, fill it with data as described in README.md or freiheit-com#95
  • the value of environment variables are defaulted to KUBERPULT_GIT_URL=./repository_remote and KUBERPULT_GIT_BRANCH=master
  • run the following command to start all the services required.
make kuberpult

For details on how to fill the repo, see the Readme for testdata

  • the cd-service is available at localhost:8080. And Kuberpult ui is available at localhost:3000

Build and run kuberpult with Earthly

  • Download Earthly binary and add it to your PATH.
  • In the root of the repository run make kuberpult-earthly. This will build the services (frontend/cd/ui) in a containerised environment and run docker-compose using the built images.

GRCP Calls (with docker-compose setup)

Most calls can be made directly from the UI. To make specific calls for manual testing, install evans.

When the services are running with docker-compose, start evans like this:

evans --host localhost --port 8443 -r

header author-name=YXV0aG9y
header author-email=YXV0aG9yQGF1dGhvcg==
package api.v1
service DeployService

api.v1.DeployService@localhost:8443> call Deploy
environment (TYPE_STRING) => development
application (TYPE_STRING) => app-alerting-service
version (TYPE_UINT64) => 91
ignoreAllLocks (TYPE_BOOL) => false
✔ Queue
{}

Why the author headers?

With a recent change, the cd-service now always expect author headers to be set, both in grpc and http endpoints. /release is the exception to that, but it logs a warning, when there is no author. (And of course /health is another exception). The frontend-service is now the only point that knows about default-author (see helm chart git.author.name & git.author.email). The frontend-service can be called with headers, then those will be used. If none are found, we use the default headers from the helm chart.

Test that setup was done correctly

  • for adding changes and testing releasing, clone the repository_remote folder.
  • calling curl command to /release api with form data for the manifest file should have updated the remote repository with a new release.
  • view the changes in ui as well
cd services/cd-service
git clone ./repository_remote repository_checkedout
cd repository_checkedout
touch manifest.yaml
# This should cause the release to be pushed to the git repository
curl --form-string 'application=helloworld' --form 'manifests[development][email protected]' localhost:8080/release
git pull
cd ../../..

Unit tests

Go tests would be part of the same package as the main code, but ending the file names with _test.go. When adding new test cases, please use table driven tests

To run tests, the root makefile has the test command, which runs the test commands in services/cd-service/Makefile and services/frontend-service/Makefile, which, in turn, run tests for go and pnpm files.

make test

When there are build issues in the test code, it will show up as a build failure during make test with the proper error.

When a single test case fails, the test case shows up with the corresponding error.

For a more verbose version, you could go into the service directory and run the tests manually in verbose mode.

cd services/cd-service
go test ./... -v

Installation outside of docker

Podman and podman-compose

If you use Podman (and podman-compose) instead (e.g. on macOS), you might need to specify user: 0 for each container. because otherwise the process in the container does not have access to the filesystem mounted from the user's home directory into the container. Using UID 0 should be fine with Podman, as it (unlike Docker) runs the container with the privileges of the current user (the UID of the current user is mapped to UID 0 inside the container). e.g.:

backend:
    build: infrastructure/docker/backend
    container_name: kuberpult-cd-service
    ports:
      - "8080:8080"
      - "8443:8443"
>>> user: 0
    volumes:
      - .:/kp/kuberpult

prerequisite software

  • docker - for docker build for cd-service - optional
  • node - ensure you're using an LTS version (or use nvm) Ideally use the same version as in the package.json
  • pnpm

Libraries required

  • libgit2 >= 1.0 download tar file and follow instructions here: https://github.com/libgit2/libgit2#installation it worked for me to run: (the instructions are slightly different)

    sudo apt-get install libssl-dev
mkdir build && cd build
cmake ..
sudo cmake --build . --target install

    Afterwards, set your library path, e.g.: export LD_LIBRARY_PATH='/usr/local/lib/'

    For m1 mac: brew and macports don't have the version of libgit2 that we need (1.3.0) so what we do is we install macports, then travel back in timie to when 1.3.0 was the latest and then install it.

Get macports repo

git clone https://github.com/macports/macports-ports.git cd macports-ports

Travel back in time to when libgit2 version was 1.3.0

git checkout b2b896fb904cfd14d8d6f3063c0b620b52b94f31

Install libgit2

cd devel/libgit2 sudo port install

Convince package config that we do infact have libgit2 (change to rc file of whichever shell you use)

echo "export PKG_CONFIG_PATH=/opt/local/lib/pkgconfig" >> ~/.zshrc source ~/.zshrc


-  libsqlite3

On ubuntu: install the apt package `libsqlite3-dev`
On mac: install the macports package `sqlite3`


- Chart Testing:
- install `helm`, `Yamale`, `Yamllint` as prerequisites to `ct` from https://github.com/helm/chart-testing#installation
- then follow the instructions to install `ct`
- golang >= 1.16
- protoc >=3.15
- buf from https://docs.buf.build/installation

## Setup and Run

### With makefiles

- in `services/cd-service`, initialize a bare repository with the name `repository_remote`

```bash
cd services/cd-service
git init --bare repository_remote

To run the services: make kuberpult

releasing a new version

Releases are half-automated via GitHub actions.

Go to the release workflow pipeline and trigger "run pipeline" on the main branch.

Changelog generation and semantic versioning

Use conventional commits to make your changes show up in the changelog. In short:

  • fix will create a PATCH level semantic version
  • feat will create MINOR level semantic version
  • adding a ! will mark a breaking change and create a MAJOR level semantic version

In addition to fix, feat and breaking changes, the following types can be considered, but are currently not allowed in kuberpult:

  • revert
  • perf
  • docs
  • test
  • refactor
  • style
  • chore
  • build
  • ci

The changelog and the version is generated with go-semantic-release via its github action and it generates the changelogs with the default generator.

Notes

  • there is a dev image based on alpine in docker/build. You can start a shell in the image using the ./dmake command.

  • The first version of this tool was written using go-git v5. Sadly the performance was abysmal. Adding a new manifest took > 20 seconds. Therefore, we switched to libgit2, which is much faster but less ergonomic.

Running locally with 2 images

The normal docker-compose.yml file starts 3 containers: cd-service, frontend-service, ui. The file docker-compose.tpl.yml starts 2 containers: cd-service and frontend+ui in one. In the helm chart, there are also only 2 containers.

Pros of running 2 containers:

  • closer to the "real world", meaning the helm chart
  • You can (manually) test things like path redirects much better

Cons of running 2 containers:

  • There's no UI hot-reload

To run with 2 containers (you need to run this with every change):

# replace "sven" with any other prefix or your choice:
docker-compose stop
PREFIX=sven-e
VERSION=$(git describe --always --long --tags)
export IMAGE_REGISTRY=europe-west3-docker.pkg.dev/fdc-public-docker-registry/kuberpult 
IMAGENAME="$IMAGE_REGISTRY"/kuberpult-cd-service:"$PREFIX"-"$VERSION" make docker -C services/cd-service/
IMAGENAME="$IMAGE_REGISTRY"/kuberpult-frontend-service:"$PREFIX"-"$VERSION" make docker -C services/frontend-service/
IMAGE_TAG_CD="$PREFIX"-"$VERSION" IMAGE_TAG_FRONTEND="$PREFIX"-"$VERSION" dc -f ./docker-compose.tpl.yml up -d --remove-orphans

Now open a browser to http://localhost:8081/.