Skip to content

resource-model.md

Latest commit

 

History

History
110 lines (92 loc) · 3.51 KB

resource-model.md

File metadata and controls

110 lines (92 loc) · 3.51 KB
Raw

Substrate Resource Model

Substrate exposes resources through two APIs:

  • a gRPC API (pkg/proto/ateapipb/ateapi.proto), served by the Substrate API server. Its resources follow the API Style Guide.
  • The Kubernetes API, through CRDs in pkg/api/v1alpha1, for managing compute infrastructure. Its resources follow the Kubernetes API conventions

Scope and parent

Every resource belongs either to the whole Substrate installation or to a single atespace. A global resource, such as an Atespace or a Worker, belongs to the whole Substrate installation. An atespace-scoped resource, such as an Actor or a Tag, belongs to one atespace, and atespaces keep their resources apart from each other.

Some resources exist only as part of another resource. These are subresources, and the resource they belong to is their parent. For example, an EgressPolicy is part of an Actor. A subresource is always reached through its parent and goes away when its parent does.

A subresource's parent can also be Global, which stands for the whole Substrate installation. Global is not a resource. It is the root of the hierarchy below.

Hierarchy

Global
├── AccessPolicy "default"         subresource (singleton)
├── Atespace
│   ├── AccessPolicy "default"     subresource (singleton)
│   ├── ActorTemplate
│   ├── Actor
│   │   └── EgressPolicy "default" subresource (singleton)
│   └── Tag
└── Worker
    └── ActorAssignment            subresource (one per hosted Actor, managed by Substrate)

Top-level resources

Resource Scope Cardinality Written by
Atespace Global 0..N Clients
ActorTemplate Atespace 0..N Clients
Actor Atespace 0..N Clients
Tag Atespace 0..N Clients
Worker Global 0..N Substrate

Subresources

Subresource Parent Cardinality Written by
EgressPolicy Actor 0..1, named default Clients
AccessPolicy Global 0..1, named default Clients
AccessPolicy Atespace 0..1, named default Clients
ActorAssignment Worker 0..N Substrate

Kubernetes resources

CRD Scope
WorkerPool Namespaced
SandboxConfig Cluster
CSIDriverConfig Cluster

Relationships

classDiagram
    namespace kube-apiserver {
        class WorkerPool {
            <<CRD>>
        }
        class SandboxConfig {
            <<CRD>>
        }
        class WorkerPod
    }

    namespace substrate-api-server {
        class Atespace
        class AtespaceAccessPolicy
        class ActorTemplate
        class Actor
        class EgressPolicy
        class Tag
        class Worker
        class ActorAssignment
    }

    Atespace "1" *-- "0..1" AtespaceAccessPolicy
    Atespace "1" o-- "*" ActorTemplate
    Atespace "1" o-- "*" Actor
    Atespace "1" o-- "*" Tag
    Actor "1" *-- "0..1" EgressPolicy
    Worker "1" *-- "*" ActorAssignment
    Actor "*" --> "1" ActorTemplate : actor_template
    Actor "*" --> "0..1" Tag : source_tag
    Tag "*" --> "1" Actor : source_actor
    ActorAssignment "0..1" --> "1" Actor : actor
    ActorTemplate ..> WorkerPool : worker_selector
    WorkerPool ..> SandboxConfig : sandboxClasses
    WorkerPool "1" *-- "*" WorkerPod
    Worker "1" --> "1" WorkerPod
Loading