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
Changes from 8 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
165 changes: 29 additions & 136 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,180 +3,73 @@ title: Introduction
sidebar_position: 1
---

[![Creative Commons Attribution-ShareAlike 4.0 International](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)

## 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.
As only the sum of different repositories complete the SCS Stack, it is important to have an easy and accessible documentation in one place.

## What is SCS? Why should I care?
## Architectual Overview

TODO

SCS describes a standard as well as a reference implementation of this standard.
## Use Cases and Depolyment Examples

Please see our [public web site](https://scs.community/) and specifically
the [About SCS](https://scs.community/About/) page.
### IaaS Layer

## The reference implementation
#### Quick Start with Cloud-In-A-Box

### Get it and test it: Testbed
The fastest way to get in touch with SCS is to deploy a SCS cloud virtually. The Cloud-In-A-Box was built explicitely for this scenario. Check it out [here](/docs/iaas/guides/deploy-guide/examples/cloud-in-a-box)

The easiest way to get in touch with SCS is to deploy a SCS cloud virtually.
#### Reference Implementation Testbed

This means that you set up a 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. Currently, only OpenStack is supported as IaaS under the SCS cloud
(so you end up using OpenStack on top of OpenStack — with nested virtualization
enabled, this performs decently). There is no fundamental limitation — just
noone has done the porting of the terraform recipes yet to AWS, libvirt,
VMware, ...
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.

The [Requirements:Cloud access subsection](https://docs.osism.de/testbed/deployment.html#cloud-access) also lists some clouds that we have
SCS running on and test regularly.
### Container Layer

#### k8s Cluster API Provider

You can easily deploy the container layer on top of the testbed (or a production
SCS cloud of course) checking out the code from
[k8s-cluster-api-provider](https://github.com/SovereignCloudStack/k8s-cluster-api-provider/).

## Existing SCS Clouds

A few production clouds are already based on SCS: betacloud and [pluscloud open](https://www.plusserver.com/en/products/pluscloud-open).
More will come soon.

CityNetwork, Open Telekom Cloud, OVH clouds are also known to support the
testbed well. (There are a few caveats with the latter two, but those are
documented and no blockers.) Read above mentioned
[Requirements:Cloud access](https://docs.osism.de/testbed/deployment.html#cloud-access)
subsections.

## Development of SCS

The work done in SCS is supposed to be fed back upstream — into the relevant
CNCF projects, into OpenStack, into kolla-ansible, into OSISM and others.
An OSISM deployment thus will bring you all the SCS greatness in the base
layer.
Whenever possible SCS works directly in the upstream projects. While the SCS
projects tracks the efforts across the released in [epics and userstories](https://github.com/orgs/SovereignCloudStack/projects),
the work on the code happens upstream - as such these repositories are usually
not found in the SCS namespace.

## Releases and Roadmap

### Release 0 (2021-07-15)

SCS R0 has been released on 2021-07-15 and bundles the work
accomplished by the community prior to the full start of the project.

See [Release Notes for R0](https://github.com/SovereignCloudStack/release-notes/blob/34d7ccb8f05b70cbb89f5995f9d10eab2ab8c052/Release0.md) for more information.

### Release 1 (2021-09-29)

R1 came quickly after R0 and was the first release to ship a production ready k8s stack
(with k8s cluster API), some identity federation integration and much improved
preconfiguration for monitoring and logging.

See [Release Notes for R1](https://github.com/SovereignCloudStack/release-notes/blob/34d7ccb8f05b70cbb89f5995f9d10eab2ab8c052/Release1.md) for more information.

### Release 2 (2022-03-23)

This release delivers vast improvements for bare metal automation
and the features in the container layers.
#### Cluster Stacks

See [Release Notes for R2](https://github.com/SovereignCloudStack/release-notes/blob/34d7ccb8f05b70cbb89f5995f9d10eab2ab8c052/Release2.md) for more information.
TODO

### Release 3 (2022-09-21)
### Public SCS Clouds in production

Release 3 features user federation, increase in deployment and upgrade
velocity by improving automated test coverage as well as bringing disk encryption
based on tang from the state of a technical preview to be fully supported.
Find the current number of scs compatible clouds [here](https://docs.scs.community/standards/certification/overview#compliant-cloud-environments)

See [Release Notes for R3](https://github.com/SovereignCloudStack/release-notes/blob/34d7ccb8f05b70cbb89f5995f9d10eab2ab8c052/Release3.md) for more information.
### Development of SCS

### Release 4 (2023-03-22)
While the SCS projects tracks the efforts across the released in epics and userstories, the work on the code happens upstream - as such these repositories are usually not found in the SCS GitHub organization. Whenever possible SCS works directly in the upstream projects into

The implemented open source components have been updated to the latest stable versions.
Among others, this includes OpenStack Zed, Kubernetes Cluster API 1.3.x, Cluster API Provider
for OpenStack 0.7.x, Kubernetes 1.26.x, and Ubuntu 22.04 LTS.
- CNCF projects,
- OpenStack,
- kolla-ansible,
- OSISM and others.

See [Release Notes for R4](https://github.com/SovereignCloudStack/release-notes/blob/34d7ccb8f05b70cbb89f5995f9d10eab2ab8c052/Release4.md) for more information.
### Issues and Bugs

### Release 5 (2023-09-20)
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).

The IaaS reference implementation now brings OpenStack 2023.1 (Antelope) and the default
Ceph version is Ceph Quincy - both components are enabled by the OSISM 6.0.0 release.
The container reference implementation has seen many updates is available as version 6.0.0,
with Kubernetes v1.24 - 1.27 being officially supported. Furthermore this release brings
the first technical preview of Cluster-Stack.

See [Release Notes for R5](https://github.com/SovereignCloudStack/release-notes/blob/364103536ab2c51435a078171c698d7967d7588d/Release5.md) for more information.

### Roadmap

We have a 6 month release cadence — R6 will follow in March 2024.
Until then, we will provide bugfixes and security fixes for R5.

We do work towards a model where our partners can actually follow our main
development branches — right now, our CI needs a bit more coverage though
to make this safe.

## Contribute and Connect
### Contribute and Connect

Please see the [SCS contributor guide](https://docs.scs.community/community).

## Standards, Conformity and Certification

We intend to work on a conformity test suite.

Right now, we are basically relying on upstream tests --
[RefStack](https://refstack.openstack.org/) (to perform
the [OpenStack trademark certification](https://refstack.openstack.org/#/guidelines)
tests formerly known as DefCore) and the Kubernetes CNCF conformance tests run through
[sonobuoy](https://sonobuoy.io/).
### Releases and Roadmap

We have specific [standards](https://github.com/SovereignCloudStack/standards/tree/main/Standards) aligned within the SCS community
(and have also sought feedback from the broader Gaia-X and OpenStack communities).
See our Release Notes [here](https://docs.scs.community/docs/category/releases)

Beyond this, we have a [draft document](https://github.com/SovereignCloudStack/standards/blob/main/Drafts/SCS-Spec.md) that captures our
view on how SCS compatible environments should look like. This one has not yet
seen sufficient review to be eligible for standardization. However, we appreciate
feedback (raise issues and PRs or start discussions).

## Issues and bugs

Please raise issues on github. 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).
Obviously we appreciate PRs even more than issues;
please don't forget to sign off your contributions (see
[contributor guide](https://docs.scs.community/community) ).

When reporting bugs, it is very useful to include some standard information
typically needed to analyze:

- What state of software (SCS) were you testing? What version numbers ... ?
- How does your environment look like (hardware, operating systems, etc.)?
- What did you do?
- What did you expect? What happened instead?
- Have you done this successfully before? What changed?
- Can this be reproduced? Occasionally? Reliably? How?
- Any analysis you have done? Experiments and their results? Log files?

## Other resources

Please check our main [web page](https://scs.community/).
If you are an onboarded SCS community member, find here a link to our
[nextcloud](https://scs.sovereignit.de/) (login required).
## Standards, Conformity and Certification

Our community interacts through our [github organization](https://github.com/sovereignCloudStack/),
on [mailing lists](https://scs.sovereignit.de/mailman3/postorius/lists/) as well as
chats [matrix.org:SCS](https://matrix.to/#/!TiDqlLmEUaXqTemaLc:matrix.org?via=matrix.org).
How to get compliant? With what am I compliant then? What are the benefits? What does it involve? What to expect in the future? Link to Standards Section: <https://docs.scs.community/standards>