Update Operator Docs Introduction (SovereignCloudStack#109)

* remove deprecated parts Signed-off-by: Max Wolfs <[email protected]> * fix linkg Signed-off-by: Max Wolfs <[email protected]> * feat: add cluster stacks description Signed-off-by: Jan Schoone <[email protected]> * Apply suggestions from code review Co-authored-by: Jan Schoone <[email protected]> Signed-off-by: Max Wolfs <[email protected]> * refactor components for better reuse with json Signed-off-by: Max Wolfs <[email protected]> * import architecture component Signed-off-by: Max Wolfs <[email protected]> * fix loading Signed-off-by: Max Wolfs <[email protected]> * Apply suggestions from code review Co-authored-by: Filip Dobrovolný <[email protected]> Signed-off-by: Max Wolfs <[email protected]> * add first single components to overview component Signed-off-by: Max Wolfs <[email protected]> * Adjust model Signed-off-by: Max Wolfs <[email protected]> * add custom data plugin Signed-off-by: Max Wolfs <[email protected]> * fix url Signed-off-by: Max Wolfs <[email protected]> * fix url Signed-off-by: Max Wolfs <[email protected]> * fix: typo Signed-off-by: Jan Schoone <[email protected]> * fix calendar link Signed-off-by: Max Wolfs <[email protected]> * Add container registry docs and display it on the overview map (SovereignCloudStack#143) Signed-off-by: Matej Feder <[email protected]> * Add monitoring docs and display it on the overview map (SovereignCloudStack#144) Signed-off-by: Matej Feder <[email protected]> * Add CSPO docs and display it on the overview map (SovereignCloudStack#149) Signed-off-by: Matej Feder <[email protected]> * fix component sizing Signed-off-by: Max Wolfs <[email protected]> * Apply suggestions from code review Co-authored-by: Roman Hros <[email protected]> Signed-off-by: Max Wolfs <[email protected]> * Add missing k8s-cluster-api-provider doc pages (SovereignCloudStack#152) Signed-off-by: Roman Hros <[email protected]> * fix title Co-authored-by: Roman Hros <[email protected]> Signed-off-by: Max Wolfs <[email protected]> --------- Signed-off-by: Max Wolfs <[email protected]> Signed-off-by: Jan Schoone <[email protected]> Signed-off-by: Matej Feder <[email protected]> Signed-off-by: Roman Hros <[email protected]> Co-authored-by: Jan Schoone <[email protected]> Co-authored-by: Filip Dobrovolný <[email protected]> Co-authored-by: Matej Feder <[email protected]> Co-authored-by: Roman Hros <[email protected]>
JuanPTM · Jun 3, 2024 · a8022ec · a8022ec
1 parent 01649bd
commit a8022ec
Show file tree

Hide file tree

Showing 15 changed files with 638 additions and 306 deletions.
diff --git a/docs.package.json b/docs.package.json
@@ -17,6 +17,12 @@
     "target": "docs/03-container/components",
     "label": "k8s-cluster-api-provider"
   },
+  {
+    "repo": "SovereignCloudStack/cluster-stack-provider-openstack",
+    "source": "docs",
+    "target": "docs/03-container/components/cluster-stacks/components",
+    "label": "cluster-stack-provider-openstack"
+  },
   {
     "repo": "SovereignCloudStack/status-page-openapi",
     "source": "docs",
@@ -25,10 +31,7 @@
   },
   {
     "repo": "SovereignCloudStack/standards",
-    "source": [
-      "Standards/*.md",
-      "Tests/scs-*.yaml"
-    ],
+    "source": ["Standards/*.md", "Tests/scs-*.yaml"],
     "target": "standards",
     "label": ""
   },
@@ -37,5 +40,17 @@
     "source": "docs/guides",
     "target": "docs/02-iaas/",
     "label": ""
+  },
+  {
+    "repo": "SovereignCloudStack/k8s-harbor",
+    "source": "docs",
+    "target": "docs/03-container/components",
+    "label": "container-registry"
+  },
+  {
+    "repo": "SovereignCloudStack/k8s-observability",
+    "source": "docs",
+    "target": "docs/04-operating-scs/components",
+    "label": "monitoring"
   }
 ]
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/index.mdx b/docs/index.mdx
@@ -0,0 +1,81 @@
+---
+title: Introduction
+sidebar_position: 1
+---
+
+import ArchitecturalModel from '../src/components/ArchitecturalModel'
+
+## About
+
+The Sovereign Cloud Stack combines the best of Cloud Computing in one unified standard.
+SCS is built, backed, and operated by an active open-source community worldwide.
+
+## Architectural Overview
+
+<ArchitecturalModel jsonFilePath="data/architecturalOverviewData.json" />
+
+## Use Cases and Deployment Examples
+
+### IaaS Layer
+
+#### Quick Start with Cloud-In-A-Box
+
+The fastest way to get in touch with SCS is to deploy a SCS cloud virtually. The Cloud-In-A-Box was built explicitly for this scenario. Check it out [here](/docs/iaas/guides/deploy-guide/examples/cloud-in-a-box)
+
+#### Reference Implementation Testbed
+
+This means that you set up an SCS test installation including all the infrastructure
+pieces such as database, message queueing, ceph, monitoring and logging, IAM, the
+[OpenStack](https://openstack.org/) core services, and (soon) the Container layer
+on top of an existing IaaS platform.
+
+The SCS IaaS reference implementation is based on [OSISM](https://osism.tech/). Read on the
+[OSISM testbed docs](https://docs.osism.de/testbed/) to learn how to get the
+testbed running. Please read carefully through the
+[deployment](https://docs.osism.de/testbed/deployment.html) section of the
+manual.
+
+### Container Layer
+
+#### K8s Cluster API Provider
+
+You can easily deploy the container layer on top of the testbed (or a production
+SCS cloud) checking out the code from
+[k8s-cluster-api-provider](https://github.com/SovereignCloudStack/k8s-cluster-api-provider/).
+
+#### Cluster Stacks
+
+With the Cluster Stacks, in the V2 KaaS reference implementation, we provide an opinionated optimized configuration of Kubernetes clusters. Through better packaging, integrated testing, and bundled configuration, SCS-based Kubernetes clusters provide easier individualization.  
+Throughout the R6 development cycle Cluster Stacks are taken from a technical preview to be [functional and available on top of the IaaS reference implementation](https://github.com/SovereignCloudStack/issues/milestone/8) as well to replace the V1 KaaS reference implementation [k8s-cluster-api-provider](https://github.com/SovereignCloudStack/k8s-cluster-api-provider/).  
+The Cluster Stacks can already be tried with the [demo](https://github.com/SovereignCloudStack/cluster-stacks-demo) repository. Although this is based on the not-production-ready Docker provider, the usage is the same for every provider.
+
+### Public SCS Clouds in production
+
+Find the current list of scs compatible clouds [here](https://docs.scs.community/standards/certification/overview#compliant-cloud-environments).
+
+### Development of SCS
+
+While the SCS project tracks the efforts across the released epics and user stories, the work on the code, whenever possible, happens upstream. As such, these repositories are usually not found in the SCS GitHub organization. SCS works directly in the following upstream projects:
+
+- CNCF projects,
+- OpenStack,
+- kolla-ansible,
+- OSISM and others.
+
+All code not pushed upstream can be found in the [SCS Github organization](https://github.com/SovereignCloudStack).
+
+### Issues and Bugs
+
+If you can identify the affected component, raise the issue against the relevant repository in the SovereignCloudStack or OSISM space. Otherwise, you can use the [issues repository](https://github.com/SovereignCloudStack/issues). We appreciate PRs as well as issues; please don't forget to sign off your contributions see [contributor guide](https://docs.scs.community/community).
+
+### Contribute and Connect
+
+Please see the [SCS contributor guide](https://docs.scs.community/community).
+
+### Releases and Roadmap
+
+See our Release Notes [here](https://docs.scs.community/docs/category/releases)
+
+## Standards, Conformity and Certification
+
+How to get compliant? What do I need to be compliant? What are the benefits? What does it involve? What to expect in the future? Learn more in the [standards section](https://docs.scs.community/standards).
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -90,7 +90,8 @@ const config = {
         sidebarPath: require.resolve('./sidebarsStandards.js')
       }
     ],
-    './src/plugins/docusaurus-plugin-matomo-analytics/index.js'
+    './src/plugins/docusaurus-plugin-matomo-analytics/index.js',
+    './src/plugins/docusaurus-plugin-global-data/index.js'
   ],
 
   themeConfig: