Overview#
Target audience: Integrators and operators.
Assemble individual services#
The SCL Management System is meant to be configured and deployed via NixOS modules.
Warning
To enforce user access restrictions, the SCL API:
- MUST be deployed behind a properly configured OpenAPI Proxy
that realises the Infrastructure Management API. The required OpenAPI Specification intended for
this use case is available as
scl.ima-openapi. - MUST be deployed with a properly configured IAM service that will be used by the Infrastructure Management API to perform authorization checks. See How-to configure Keycloak as an example.
Each service described in the architecture section can be instantiated via a dedicated module. All modules are documented in the reference section of the documentation.
| Service | Module Name | Note |
|---|---|---|
| Compute API | scl.computeApi |
- |
| etcd | etcd |
- |
| SCL API | scl.api |
- |
| L2 network controller | scl.local-l2-net-ctrl |
- |
| L3 network controller | scl.local-l3-net-ctrl |
- |
| Image registry | scl.vm-image-registry |
Don't use in production |
| Node L2 network API | scl.node-l2-net-api |
- |
| VM scheduler | scl.scheduler-ctrl |
- |
| VM controller | scl.vm-ctrl |
- |
| Volume controller | scl.local-vol-ctrl |
Deprecated and only for single-node |
Warning
scl.vm-image-registryis solely designed for testing and MUST NOT be used in production.
Manage Nodes and other SCL Objects with sclctl#
sclctl is a CLI client for the SCL API. Operators are responsible for
de/registering (compute) Nodes that are in turn used to run VMs. See
the sclctl reference for configuration
instructions and examples.
Troubleshoot#
Instructions about how to check the health of SCL components and introspect the state of the system is provided in the tourbleshooting section.