-
Notifications
You must be signed in to change notification settings - Fork 7
Update Operator Docs Introduction #109
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
Merged
Merged
Changes from all commits
Commits
Show all changes
41 commits
Select commit
Hold shift + click to select a range
33a9f29
remove deprecated parts
maxwolfs 6d84d7d
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 17e2ec3
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs aca16f7
Merge branch 'feat/upgrade-docusaurus' into feat/refactor-operator-in…
maxwolfs 1ab788b
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 02f19ff
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs a2511dc
fix linkg
maxwolfs 3cd7e04
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs e7c2e67
feat: add cluster stacks description
jschoone 8f4a3cc
Apply suggestions from code review
maxwolfs b064ae9
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs c69579a
refactor components for better reuse with json
maxwolfs e081a3f
import architecture component
maxwolfs 63c7354
Merge branch 'feat/refactor-operator-introduction' of github.com:Sove…
maxwolfs d04b81f
fix loading
maxwolfs 1ab591d
Apply suggestions from code review
maxwolfs 27e697d
add first single components to overview component
maxwolfs 4547b29
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 1710bed
Adjust model
maxwolfs 84d34e3
add custom data plugin
maxwolfs df59a6c
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 1ac36ae
fix url
maxwolfs 19175b1
Merge branch 'feat/refactor-operator-introduction' of github.com:Sove…
maxwolfs 6023d54
fix url
maxwolfs e5e30c9
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 9503fd8
fix: typo
jschoone 4dfc4ac
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 2183f58
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 2fedd24
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 39387ca
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 14ce818
fix calendar link
maxwolfs c6f7f71
Add container registry docs and display it on the overview map (#143)
matofeder 5e781eb
Add monitoring docs and display it on the overview map (#144)
matofeder cc779fc
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 712ce92
Add CSPO docs and display it on the overview map (#149)
matofeder 0103e8e
Merge branch 'main' into feat/refactor-operator-introduction
maxwolfs 93e7914
fix component sizing
maxwolfs 9f0f03f
Merge branch 'feat/refactor-operator-introduction' of github.com:Sove…
maxwolfs f727688
Apply suggestions from code review
maxwolfs bd191b2
Add missing k8s-cluster-api-provider doc pages (#152)
chess-knight 5d36fc3
fix title
maxwolfs File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
maxwolfs marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.