Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Operator Docs Introduction #109

Merged
merged 41 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
33a9f29
remove deprecated parts
maxwolfs Nov 8, 2023
6d84d7d
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Nov 8, 2023
17e2ec3
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Nov 8, 2023
aca16f7
Merge branch 'feat/upgrade-docusaurus' into feat/refactor-operator-in…
maxwolfs Nov 9, 2023
1ab788b
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Nov 20, 2023
02f19ff
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Dec 12, 2023
a2511dc
fix linkg
maxwolfs Dec 12, 2023
3cd7e04
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Jan 10, 2024
e7c2e67
feat: add cluster stacks description
jschoone Jan 10, 2024
8f4a3cc
Apply suggestions from code review
maxwolfs Jan 10, 2024
b064ae9
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Jan 12, 2024
c69579a
refactor components for better reuse with json
maxwolfs Jan 12, 2024
e081a3f
import architecture component
maxwolfs Jan 12, 2024
63c7354
Merge branch 'feat/refactor-operator-introduction' of github.com:Sove…
maxwolfs Jan 12, 2024
d04b81f
fix loading
maxwolfs Jan 12, 2024
1ab591d
Apply suggestions from code review
maxwolfs Jan 17, 2024
27e697d
add first single components to overview component
maxwolfs Jan 17, 2024
4547b29
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Jan 18, 2024
1710bed
Adjust model
maxwolfs Jan 18, 2024
84d34e3
add custom data plugin
maxwolfs Jan 25, 2024
df59a6c
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Jan 25, 2024
1ac36ae
fix url
maxwolfs Jan 25, 2024
19175b1
Merge branch 'feat/refactor-operator-introduction' of github.com:Sove…
maxwolfs Jan 25, 2024
6023d54
fix url
maxwolfs Jan 25, 2024
e5e30c9
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Jan 26, 2024
9503fd8
fix: typo
jschoone Jan 30, 2024
4dfc4ac
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Feb 1, 2024
2183f58
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Feb 7, 2024
2fedd24
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Feb 8, 2024
39387ca
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Feb 13, 2024
14ce818
fix calendar link
maxwolfs Feb 13, 2024
c6f7f71
Add container registry docs and display it on the overview map (#143)
matofeder Feb 19, 2024
5e781eb
Add monitoring docs and display it on the overview map (#144)
matofeder Feb 20, 2024
cc779fc
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Feb 28, 2024
712ce92
Add CSPO docs and display it on the overview map (#149)
matofeder Feb 29, 2024
0103e8e
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs Feb 29, 2024
93e7914
fix component sizing
maxwolfs Feb 29, 2024
9f0f03f
Merge branch 'feat/refactor-operator-introduction' of github.com:Sove…
maxwolfs Feb 29, 2024
f727688
Apply suggestions from code review
maxwolfs Mar 1, 2024
bd191b2
Add missing k8s-cluster-api-provider doc pages (#152)
chess-knight Mar 1, 2024
5d36fc3
fix title
maxwolfs Mar 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions docs.package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -25,10 +31,7 @@
},
{
"repo": "SovereignCloudStack/standards",
"source": [
"Standards/*.md",
"Tests/scs-*.yaml"
],
"source": ["Standards/*.md", "Tests/scs-*.yaml"],
"target": "standards",
"label": ""
},
Expand All @@ -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"
}
]
182 changes: 0 additions & 182 deletions docs/index.md

This file was deleted.

81 changes: 81 additions & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
@@ -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).
3 changes: 2 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading
Loading