Skip to main content

Overview

Scope of this document​

The Sovereign Cloud Stack software (reference implementation) consists of numerous modules. This is intentional, as we have various operators that have deployed preexisting technology or have specific requirements and expect SCS to fit into it. It is good practice to build technology in a modular way, as this allows different pieces to move at its own speed and ensures that work is invested into proper abstractions and interfaces to build a losely coupled system that is resilient.

That said, the most value is derived by operators that consume the complete stack. We thus provide an overview over all components and some hints of how to deploy them.

We start with the functional stack at the bottom, where a deployment on server hardware is automated.

Overview table​

LayerComponentSubcomponentPurposeStatusRequirementsDocumentation
InfraOSISMManager, Netbox, ...Lifecycle Manage deploymentProdHWhttps://docs.scs.community/docs/iaas/guides/configuration-guide/
OpsOSISMPrometheus, Netdata, AlertMgr, ...Monitor Infra layerProdHWhttps://docs.scs.community/docs/iaas/guides/concept-guide/#components-in-a-cluster
SDSOSISMcephStorage (Block, Object)ProdHWhttps://docs.scs.community/docs/iaas/guides/concept-guide/components/ceph
SDNOSISMOVNNetworkingProdHWhttps://docs.scs.community/docs/iaas/guides/concept-guide/components/sonic#-lifecycle-management-of-open-virtual-network-ovn-in-osism
IaaSOSISMOpenStackVirtualizationProdHWhttps://docs.scs.community/docs/iaas/guides/concept-guide/components/openstack
KaaSClusterStacksCAPI, CAPO, ClusterStacks, CSO, CSPOK8s cluster managementStableIaaShttps://docs.scs.community/docs/container/components/cluster-stacks/components/cluster-stacks/overview
PaaSRegistryharborContainer registryProdKaaShttps://docs.scs.community/docs/category/container-registry
APICentral APICentral APIAPI for IAM, IaaS, KaaSTech PreviewKaaShttps://scs.community/tech/2024/08/13/central-api-tech-preview-release/
OpsOS Health MonitorOSHM (old)IaaS monitorDeprecatedIaaShttps://docs.scs.community/docs/operating-scs/guides/openstack-health-monitor/Debian12-Install
OpsHealth MonitorOSHM (new)IaaS monitorStableIaaShttps://docs.scs.community/docs/category/scs-health-monitor
OpsHealth MonitorSCS monitoringK8s cluster monitorProdKaaShttps://docs.scs.community/docs/category/monitoring
OpsStatus PageSCS Status PagePublication of platform statusTechnical PreviewKaaShttps://docs.scs.community/docs/category/status-page
OpsMeteringSCS meteringUsage data collectionTech PreviewIaaShttps://docs.scs.community/docs/category/metering
OpsSCS ComplianceSCS compliance testsTestsuiteStableIaaS+KaaShttps://docs.scs.community/standards/scs-0004-v1-achieving-certification
CISCS pipelineszuulAutomation and validationStableIaaS (KaaS optional)https://docs.scs.community/community/tools/zuul
SecPentestingSCS PentestingAutomated security assessentStablezuulhttps://docs.scs.community/docs/operating-scs/components/automated-pentesting-iaas/overview#scs-automated-pentesting
IAMKeycloakKeycloakID provider and broker for federationStableIaaShttps://docs.scs.community/contributor-docs/operations/iam/identity-federation-in-scs

Legend for status:

  • Prod = Proven in numerous production environments
  • Stable = Stable release, fully supported, may not be removed without prior deprecation
  • Tech Preview = Technical preview, may not be depended upon yet and may undergo significant change or removal in the future
  • Deprecated = Still supported, but to be removed in the future

Notes:

  • OSISM comes with numerous components to manage the hardware deployment of the Infra and IaaS stack, such as homer (the portal), ARA, netbox, netdata, ... which are not all listed here. Their deployment is covered with a standard OSISM deployment and thus no separate deployment guides are linked here.
  • Similarly, Cluster Stacks, building on top of Kubernetes Cluster API, consists of a set of components that are all meant to be used together and are thus covered in one set of documents. This also includes the cluster-add-ons to integrate with the underlaying IaaS. Note that while Cluster Stack has been designed and implemented to work very well on SCS IaaS, it does also fully support other IaaS environments (such as e.g. docker for development or Hetzner for production).
  • The journey to provide seamless self-service federation across all layers of the SCS stack is a long one; while the IAM solution included is stable, it is still limited in scope, which has prevented broad adoption thus far. Work is underway to address this, which is reflected in the linked documentation.