Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 3.08 KB

crud.md

File metadata and controls

58 lines (35 loc) · 3.08 KB
Raw

CRUD for Claudie

This document describes how the user manages/communicates with Claudie deployed in a Kubernetes cluster.

Claudie has a component called Frontend, which functions like an entrypoint to Claudie. Frontend uses k8s-sidecar, which is configured to pull secrets with a label claudie.io/input-manifest and save them to Frontend's file system. Frontend then picks them up and applies them to Claudie.

Create

In order to create (apply) a new input manifest, the user needs to create a new secret in the namespace where Claudie is deployed. This secret needs needs to have:

  • a label claudie.io/input-manifest
  • a unique field name
    • IMPORTANT: If two secrets share the same data field name, the manifest saved by k8s-sidecar gets overwritten, which may in turn lead to (unwanted) deletion of infrastructure.

Example

If you define an input manifest called claudie-manifest.yaml (see the example here) and apply it by:

  1. Creating the secret by running

    kubectl create secret generic input-manifest --from-file=input-manifest.yaml -n claudie

  2. Labeling the secret with label claudie.io/input-manifest by running

    kubectl label secret input-manifest claudie.io/input-manifest=my-fancy-manifest -n claudie

Read

The user and Claudie both share a single "source of truth" for the input manifests - Kubernetes secrets. Created in the Claudie namespace, they are accessible by both the user and Claudie. This makes users store input manifests in an IaC manner and can easily be configured for GitOps synchronization (i.e. via FluxCD).

Update

When you want to update the input manifest, you can edit/reapply the secret with the updated input manifest inside of it (the secret name and the data field name will stay the same). k8s-sidecar notices the change in the secret data and subsequently updates the file inside Frontend's file system. Frontend then applies it to Claudie and the update of the defined infrastructure is underway.

Delete

If you wish to destroy your cluster along with the infrastructure, you can remove the cluster definition block from the input-manifest and update the k8s secret accordingly. If you wish to delete all of the clusters defined in an input-manifest, you simply need to delete the k8s secret containing the manifest. Both events will trigger the deletion process. This process deletes the current infrastructure and it also deletes all data related to the particular input manifest.

Outputs

Claudie outputs two secrets in the namespace where it is deployed, after a successful run of the (input) manifest:

  • kubeconfigs,
  • cluster metadata to your clusters.

The names of the secrets are derived as follows: <cluster-name>-<cluster-hash>-{kubeconfig,metadata}. The secrets can be accessed by printing and base64-decoding them.

Example of how to decode a secret:

kubectl get secrets -n claudie <cluster-name>-<cluster-hash>-kubeconfig -o jsonpath='{.data.secretdata}' | base64 -d > your_kubeconfig.yaml