Secret Request Controller

A secret request metacontroller hook that handles requests for secrets from within the kubernetes cluster

Key Systems

NestJS Structure

classDiagram
  class AppModule
  class MetaModule
  class MetaController
  class MetaService
  class IngestionAdapterModule
  class IngestionAdapterService
  class Kubernetes
  
  AppModule *-- MetaModule    
  AppModule *-- IngestionAdapterModule
  IngestionAdapterModule *-- IngestionAdapterService
  MetaModule *-- MetaController
  MetaModule *-- MetaService
  MetaController ..> MetaService
  MetaService ..> IngestionAdapterService
  Kubernetes ..> MetaController: External

Environment Variables

Environment Variable	Description	Type	Default Value	Required
PORT	The port the service will listen on	`number`	`3000`

Installation

To install the metacontroller on your own environment you first need to install metacontroller using helm

example values file:

replicas: 2
commandArgs:
  - --zap-log-level=4
  - --discovery-interval=20s
  - --leader-election=true
  - --workers=10

helm install <name> oci://ghcr.io/metacontroller/metacontroller-helm --version=4.11.12 --values ./values.yaml

then install the controller manually

curl -s https://raw.githubusercontent.com/flowcore-io/service-core-secret-request-controller/main/crd/metacontroller-controller.yaml | kubectl apply -n flowcore -f -

or using helm

helm add repo flowcore https://flowcore-io.github.io/helm-charts
helm install secret-request-controller flowcore/secret-request-controller

Note: see the helm chart for more information

This will install the controller and the crds required to run the controller.

Usage

To use the controller you need to create a secret request object, they look like this and are cluster scoped:

apiVersion: flowcore.io/v1
kind: SecretRequest
metadata:
  name: my-secret-request
spec:
  sourceSecret:
    name: source-secret-name
    namespace: source-secret-namespace
  destinationSecret:
    name: destination-secret-name
    namespace: destination-secret-namespace

Development

To start using the project just configure it using:

Configuration

yarn install
yarn reconfigure

Testing

local testing requires a local kubernetes cluster to be running, this can be done using kind

brew install kind
kind create cluster --name local

Run

run with:

yarn start