Skip to content

A Control Plane Rest API for the OKDP platform.

License

OKDP/okdp-server

Repository files navigation

ci Release okdp-ui KuboCD License Apache2

OKDP Server is the backend API for the OKDP Platform , providing a unified REST API for managing deployments, clusters, projects, GitOps repositories, and package catalogs. It powers the OKDP Control Plane UI, exposing a consistent API to interact with Kubernetes and Git-based deployment environments.

Test the Rest API

The easiest way to start testing the OKDP Rest API is by using the okdp sandbox:

The sandbox provides a local, preconfigured OKDP environment — including the necessary front end services, dependencies, and sample data — so you can quickly validate and interact with the Rest API without setting up the entire platform manually.

Developing/Testing locally

This project is configured with a Dev Container for a consistent development environment.

Using Makefile

make help (or make)
make run

Using docker compose

  1. Manually add the following entry in /etc/hosts
127.0.0.1       keycloak
  1. Start docker compose using your robot account token to access private registries:
docker-compose rm -f
docker-compose up --build
  1. Open swagger UI at: http://localhost:8092/

Authenticate with Swagger using OAuth2/authorizationCode with PKCE

Username Password
dev1 user
adm1 user
view1 user