Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions contributor-docs/operations/iam/identity-federation-in-scs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ administration of user identities to the organizational entities that the
users are part of. Usually that's customer organizations but it could also
be the operator itself. Federation protocols like OpenID Connect can be used
to achieve that goal. To simplify connecting the different parts of SCS
to customer owned IAM solutions, SCS deploys Keycloak as central Identity
Provider (IdP) service.
to customer owned IAM solutions, the SCS reference implementation uses
Keycloak as central Identity Provider (IdP) service.

Currently this is deployed automatically only in the [osism/testbed](https://docs.scs.community/docs/iaas/guides/deploy-guide/examples/testbed/),
which provides [its own documentation for authentication with OIDC](https://docs.scs.community/docs/iaas/guides/deploy-guide/examples/testbed#authentication-with-oidc).
Keycloak is available as a [component of OSISM](https://osism.tech/docs/concepts/components/keycloak/)
that operators can enable and configure as the central IdP.

The following sections describe how this is done.

## 1. IaaS / OpenStack

To provide Infrastrucure as a Service SCS builds upon
OpenStack. See section [OpenStack Federation via OpenID-Connect](https://docs.scs.community/dev-docs/operations/iam/openstack-federation-via-oidc)
OpenStack. See section [OpenStack Federation via OpenID-Connect](https://docs.scs.community/contributor-docs/operations/iam/openstack-federation-via-oidc)
for more details on identity federation for OpenStack.

## 2. CaaS
Expand Down
18 changes: 0 additions & 18 deletions docs.package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,12 @@
"target": "docs",
"label": "06-releases"
},
{
"repo": "osism/osism.github.io",
"source": "docs/guides/operations-guide/openstack/tools/*",
"target": "docs/02-iaas/components",
"label": ""
},
{
"repo": "SovereignCloudStack/standards",
"source": ["Standards/*.md", "Tests/scs-*.yaml"],
"target": "standards",
"label": ""
},
{
"repo": "osism/osism.github.io",
"source": "docs/guides",
"target": "docs/02-iaas/",
"label": ""
},
{
"repo": "osism/osism.github.io",
"source": "docs/testbed",
"target": "docs/02-iaas/deployment-examples",
"label": ""
},
{
"repo": "SovereignCloudStack/k8s-harbor",
"source": "docs",
Expand Down
4 changes: 2 additions & 2 deletions docs/01-getting-started/preinstall-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ of questions or a task list that should be discussed, clarified and processed in
_Opensource benefits from the collaboration of its users and its developers._

For this reason, we are collecting questions, important topics to be clarified and hints to make it easier for users of the Sovereign Cloud Stack to increase the success with it.
Therefore we would be very pleased if specific experiences from users, implementers and operators [are contributing](https://github.com/SovereignCloudStack/docs/docs/01-getting-started/preinstall-checklist.md) to this list.
Therefore we would be very pleased if specific experiences from users, implementers and operators [are contributing](https://github.com/SovereignCloudStack/docs/blob/main/docs/01-getting-started/preinstall-checklist.md) to this list.

## General

Expand Down Expand Up @@ -126,7 +126,7 @@ For the download of installation data such as container images, operating system
either access to publicly accessible networks must be provided or a caching proxy or a dedicated
repository server must be provided directly from the network for "Node communication".

The [Configuration Guide](https://docs.scs.community/docs/iaas/guides/configuration-guide/proxy) provides more detailed information on how this can be configured.
The OSISM [Proxy Configuration Guide](https://osism.tech/docs/guides/configuration-guide/proxy/) provides more detailed information on how this can be configured.

TBD:

Expand Down
2 changes: 1 addition & 1 deletion docs/02-iaas/deployment-examples/artcodix/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,4 @@ the faster storage data can be replicated between nodes. This usually leads to i

## How to continue

After implementing the recommended deployment example hardware, you can continue with the [deployment guide](https://docs.scs.community/docs/iaas/guides/deploy-guide/).
After implementing the recommended deployment example hardware, you can continue with the OSISM [deployment guide](https://osism.tech/docs/guides/deploy-guide/).
60 changes: 60 additions & 0 deletions docs/02-iaas/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: IaaS Layer
sidebar_position: 1
---

# IaaS Layer

The SCS reference implementation of the Infrastructure-as-a-Service (IaaS) layer
was built with [**OSISM**](https://osism.tech/docs). It builds on
[OpenStack](https://openstack.org/) for compute, network and identity services and
[Ceph](https://www.ceph.io/en/) for storage. The OpenStack deployment is based on
[Kolla](https://opendev.org/openstack/kolla) (container images) and
[kolla-ansible](https://opendev.org/openstack/kolla-ansible), which OSISM wraps with
additional Ansible playbooks and tooling to deploy and operate the whole stack.

OSISM is the reference implementation, but not the only way to build an
SCS-compatible cloud. SCS is a
[modular software stack](https://sovereigncloudstack.org/en/modular-software-stack/):
today, more than one implementation exists to build SCS-compatible clouds, and
compliance is defined by the [standards](/standards) rather than by a single stack.

:::info

OSISM maintains its own, authoritative documentation. Rather than mirroring it
here (and letting the copy drift out of date), this page links directly to the
relevant sections of the official [OSISM documentation](https://osism.tech/docs/).

:::

## OSISM documentation

- [Getting started](https://osism.tech/docs/) — introduction and overview of OSISM.
- [Concepts](https://osism.tech/docs/concepts/) — architecture and core components.
- [Guides](https://osism.tech/docs/guides/) — deployment, configuration, operations,
upgrade, troubleshooting and user guides.
- [Testbed](https://osism.tech/docs/testbed/) — the fastest way to try SCS: a full
virtual SCS/OSISM installation you can deploy on top of an existing OpenStack cloud.
- [Release Notes](https://osism.tech/docs/release-notes/) — per-release notes and
upgrade information.
- [Appendix](https://osism.tech/docs/appendix/) — CLI reference, security advisories
and supported standards.

## OpenStack tools

As part of the reference implementation, OSISM maintains these tools to meet the
SCS standards for image and flavor management:

- [Image Manager](https://osism.tech/docs/guides/operations-guide/openstack/tools/image-manager)
- [Flavor Manager](https://osism.tech/docs/guides/operations-guide/openstack/tools/flavor-manager)

## In this section

Alongside the OSISM reference, SCS maintains a few IaaS resources of its own:

- **Guides** — SCS user-facing best practices, such as configuring
[security groups](/docs/iaas/guides/user-guide/security-groups)
and creating [user data backups](/docs/iaas/guides/user-guide/user-data-backups).
- **Deployment examples** — real-world setups such as the
[artcodix](/docs/iaas/deployment-examples/artcodix/) production deployment and
the SCS [turnkey hardware landscape](/docs/turnkey-solution/hardware-landscape/).
4 changes: 2 additions & 2 deletions docs/08-faq/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ IaaS stands for Infrastructure as a Service, providing virtualized computing res

## How is the IaaS layer structured?

IaaS typically comprises virtual machines, storage, and network resources, all offered as scalable services. [Find the architecture here](https://docs.scs.community/docs/category/iaas-layer)
IaaS typically comprises virtual machines, storage, and network resources, all offered as scalable services. [Find the architecture here](https://docs.scs.community/docs/iaas/)

## What does KaaS mean?

Expand All @@ -61,7 +61,7 @@ KaaS refers to Kubernetes as a Service, where providers offer Kubernetes Cluster

**As a Cloud Service Provider**:

- **Testbed**: Use the SCS test environment to experiment. [Link to Testbed/deployment example](https://docs.scs.community/docs/iaas/deployment-examples/cloud-in-a-box/advanced-guides/testbed)
- **Testbed**: Use the SCS test environment to experiment. [Link to the OSISM testbed](https://osism.tech/docs/testbed/)

## I want to use an SCS Cloud! How do I get started?

Expand Down
10 changes: 5 additions & 5 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ SCS is built, backed, and operated by an active open-source community worldwide.

### Virtualization (IaaS) Layer

The SCS IaaS Reference Implementation is based on [OSISM](https://osism.tech/).
The SCS IaaS reference implementation was built with [OSISM](https://osism.tech/docs).
See the [IaaS Layer](/docs/iaas/) section for an overview and links
to the official OSISM documentation.

#### Reference Implementation Testbed

Expand All @@ -30,10 +32,8 @@ pieces such as database, message queueing, ceph, monitoring and logging, IAM, th
on top of an existing OpenStack IaaS platform, ideally one that allows for nested
virtualization.

Read the [testbed docs](/docs/iaas/deployment-examples/testbed) to learn how to get the
testbed running. Please read carefully through the
[deployment](/docs/iaas/deployment-examples/testbed#deployment) section of the
manual.
Read the [OSISM testbed docs](https://osism.tech/docs/testbed/) to learn how to get
the testbed running.

#### Examples for real deployments

Expand Down
31 changes: 2 additions & 29 deletions sidebarsDocs.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ const sidebarsDocs = {
type: 'category',
label: 'IaaS Layer',
link: {
type: 'generated-index'
type: 'doc',
id: 'iaas/index'
},
items: [
{
Expand All @@ -21,34 +22,6 @@ const sidebarsDocs = {
}
]
},
{
type: 'category',
label: 'Components',
link: {
type: 'generated-index'
},
items: [
{
type: 'category',
label: 'Openstack Image Manager',
link: {
id: 'iaas/components/image-manager/index',
type: 'doc'
},
items: [
{
type: 'doc',
id: 'iaas/components/image-manager/update'
}
]
},
{
type: 'doc',
label: 'Openstack Flavor Manager',
id: 'iaas/components/flavor-manager'
}
]
},
{
type: 'category',
label: 'Deployment Examples',
Expand Down
6 changes: 3 additions & 3 deletions static/data/architecturalOverviewData.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,18 +71,18 @@
{
"title": "IaaS Layer",
"body": "SCS offers OpenStack infrastructure solutions based on KVM virtualization to deploy VM workloads and enabling the container layer optionally.",
"url": "/docs/category/iaas-layer",
"url": "/docs/iaas/",
"buttonText": "Learn More",
"components": [
{
"title": "Image Manager",
"url": "/docs/iaas/components/image-manager",
"url": "https://osism.tech/docs/guides/operations-guide/openstack/tools/image-manager",
"mandatory": "true",
"stable": "true"
},
{
"title": "Flavor Manager",
"url": "/docs/iaas/components/flavor-manager",
"url": "https://osism.tech/docs/guides/operations-guide/openstack/tools/flavor-manager",
"mandatory": "true",
"stable": "true"
}
Expand Down
Loading