adhar-control-plane

The API server for managing Adhar control plane.

Overview

The adhar-control-plane project provides a comprehensive API server for managing control plane resources. It leverages Upbound's Crossplane to manage cloud infrastructure and services declaratively. This README provides instructions for setting up, running, and managing your control plane using the up CLI tool.

Prerequisites

Before getting started, ensure you have the following prerequisites installed:

• Up CLI (v0.4.0 or later)
• Docker (for running local development environments)
• kubectl (for interacting with your Kubernetes cluster)
• kcl-cli (for running KCL scripts)
• kcl language server (for KCL language support in your IDE)

Getting Started

Add Dependencies (Provider/Configuration/Function)

Add the necessary dependencies to your project using the up CLI:

# Provider
up dependency add xpkg.upbound.io/upbound/provider-aws-s3:v1.16.0

# Configuration
up dependency add xpkg.upbound.io/upbound/platform-ref-aws:v1.2.0

# Function
up dependency add xpkg.upbound.io/crossplane-contrib/function-status-transformer:v0.4.0

Generate an example claim

up example generate

Generate the XRD

up xrd generate examples/bucket/example.yaml

Generate a project function

up function generate xcluster

Scaffold the composition from the XRD

up composition generate apis/xbuckets/definition.yaml

Generate an embedded function for composition

up function generate --language=kcl test-function apis/xbuckets/composition.yaml

login to Upbound

up login

Select Upbound context

up ctx

Running and testing your Control Plane Projects

up project run

Build your configuration deployment

up project build

Push your configuration

up project push

Update dependencies

up dependency update-cache

Clean dependencies

up dependency clean-cache