CloudAPI Documentation

Overview

The CloudAPI Operator builds on top of kcp to provide a higher level resource for creating workspaces, apibindings, metadata resources and maintain them during the lifecycle.

Primary Goals:

• Agnostic: Work on whatever cloud platform you want
• Declarative Management: Leverage Kubernetes-native declarative configuration for lifecycle management

---
config:
  layout: elk
---
flowchart LR
 subgraph subGraph0["Declarative Layer"]
        Onboarding["Onboarding (User Input)"]
        Spec["spec:<br>- id<br>status:<br>- clusterUrl<br>- kubeConfigSecret"]
  end
 subgraph subGraph1["kcp Root"]
        Workspace["Workspace-<id><br>(Minimal Params)"]
  end
  subgraph subGraph2["kcp Workspace Cluster"]
        Cluster["logicalCluster"]
  end
 subgraph Configuration["Configuration & Secrets"]
        Config["Config"]
        RootSecret["Kubeconfig (kcp Root)"]
        WorkspaceSecret@{ shape: procs, label: "Workspace Secrets (e.g. kubeConfigs)"}
  end
    Onboarding -- contains --> Spec
    Spec -- generates --> Workspace
    Spec -- references --> WorkspaceSecret
    Workspace -- creates --> Cluster

Hold "Alt" / "Option" to enable pan & zoom

Quickstart

To get started check out our Quickstart instructions, then dive into the WorkspaceClaim guide to understand how workspaces are provisioned.

Contributing

We ❤️ our contributors! If you're interested in helping us out, please head over to our Contributing guide.