From 003eb9efad66b31173cd0d6b34abca92d8be5393 Mon Sep 17 00:00:00 2001 From: Jan Klare Date: Tue, 21 Jul 2026 12:37:19 +0000 Subject: [PATCH 1/2] iaas: reference OSISM instead of copying docs The IaaS Layer of the docs is not maintained within the SCS community repositories: at build time getDocs.js cloned osism/osism.github.io and copied three trees verbatim into docs/02-iaas/ (the OpenStack tools, the whole guides tree, and the testbed). These were partial, drifting copies of osism.tech/docs that went stale and mixed with the few pages that are maintained in this repository. Stop mirroring OSISM and instead present it as the stack the SCS IaaS reference implementation was built with, linking out to the official OSISM documentation: - Remove the three osism/osism.github.io entries from docs.package.json so no OSISM content is copied on build. - Add an SCS-authored landing page (docs/02-iaas/index.md) that frames OSISM (OpenStack, Ceph, Kolla/kolla-ansible) as the reference implementation, notes that SCS is a modular software stack with more than one implementation nowadays, links to the top-level OSISM documentation categories, and surfaces the Image Manager and Flavor Manager tools OSISM provides for SCS standard compliance. - Point the IaaS Layer sidebar category at the new landing page and drop the Components sub-category (image/flavor manager were OSISM pulls). - Repoint every internal link that targeted the removed OSISM copies to osism.tech (index.mdx, faq, artcodix, preinstall-checklist) and update the architecture overview data so the IaaS tiles link to the OSISM tool pages. In identity-federation-in-scs, point the Keycloak reference to OSISM's Keycloak component docs instead of the testbed, since Keycloak is no longer deployed by the OSISM testbed. Guides and Deployment Examples now resolve to only the pages maintained in this repository (security groups, user data backups, artcodix). Verified with a production build: no IaaS-related broken links remain and all outbound OSISM/scs.community links resolve. DocImpact Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Jan Klare --- .../iam/identity-federation-in-scs.md | 8 +-- docs.package.json | 18 ------ .../preinstall-checklist.md | 2 +- .../deployment-examples/artcodix/index.mdx | 2 +- docs/02-iaas/index.md | 60 +++++++++++++++++++ docs/08-faq/index.mdx | 4 +- docs/index.mdx | 10 ++-- sidebarsDocs.js | 31 +--------- static/data/architecturalOverviewData.json | 6 +- 9 files changed, 78 insertions(+), 63 deletions(-) create mode 100644 docs/02-iaas/index.md diff --git a/contributor-docs/operations/iam/identity-federation-in-scs.md b/contributor-docs/operations/iam/identity-federation-in-scs.md index 5fd7b1cc11..ebec60f00f 100644 --- a/contributor-docs/operations/iam/identity-federation-in-scs.md +++ b/contributor-docs/operations/iam/identity-federation-in-scs.md @@ -10,11 +10,11 @@ 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. diff --git a/docs.package.json b/docs.package.json index 954fc710c7..ef6b9d6a1f 100644 --- a/docs.package.json +++ b/docs.package.json @@ -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", diff --git a/docs/01-getting-started/preinstall-checklist.md b/docs/01-getting-started/preinstall-checklist.md index 10db31b085..87ee69d32c 100644 --- a/docs/01-getting-started/preinstall-checklist.md +++ b/docs/01-getting-started/preinstall-checklist.md @@ -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: diff --git a/docs/02-iaas/deployment-examples/artcodix/index.mdx b/docs/02-iaas/deployment-examples/artcodix/index.mdx index 8b6312db82..b6ecd0b35f 100644 --- a/docs/02-iaas/deployment-examples/artcodix/index.mdx +++ b/docs/02-iaas/deployment-examples/artcodix/index.mdx @@ -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/). diff --git a/docs/02-iaas/index.md b/docs/02-iaas/index.md new file mode 100644 index 0000000000..a2c1ab3895 --- /dev/null +++ b/docs/02-iaas/index.md @@ -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://ceph.io/) 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/). diff --git a/docs/08-faq/index.mdx b/docs/08-faq/index.mdx index ad59e97e68..f690d75c64 100644 --- a/docs/08-faq/index.mdx +++ b/docs/08-faq/index.mdx @@ -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? @@ -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? diff --git a/docs/index.mdx b/docs/index.mdx index ca1db6123b..168abfc810 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -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 @@ -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 diff --git a/sidebarsDocs.js b/sidebarsDocs.js index 28855cf806..93f7175f4a 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -8,7 +8,8 @@ const sidebarsDocs = { type: 'category', label: 'IaaS Layer', link: { - type: 'generated-index' + type: 'doc', + id: 'iaas/index' }, items: [ { @@ -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', diff --git a/static/data/architecturalOverviewData.json b/static/data/architecturalOverviewData.json index e5fffb0462..5d13e7572a 100644 --- a/static/data/architecturalOverviewData.json +++ b/static/data/architecturalOverviewData.json @@ -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" } From 368d5c48674a9b9f2460d3406ae4a4fb00d36c4d Mon Sep 17 00:00:00 2001 From: Jan Klare Date: Tue, 21 Jul 2026 13:09:42 +0000 Subject: [PATCH 2/2] docs: fix broken links flagged by the link checker The CI markdown-link-check validates every link in the files touched by the previous commit and reported three dead links, two of them pre-existing in files this branch already modified: - identity-federation-in-scs: the OpenStack Federation via OpenID-Connect link pointed at the old /dev-docs/ route, which now 404s; the section lives under /contributor-docs/. - preinstall-checklist: the "are contributing" self-link used a malformed github.com/.../docs/docs/... path (404); point it at the blob/main URL. - iaas landing page: https://ceph.io/ returns 500 to the checker; use https://www.ceph.io/en/, which resolves. Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Jan Klare --- contributor-docs/operations/iam/identity-federation-in-scs.md | 2 +- docs/01-getting-started/preinstall-checklist.md | 2 +- docs/02-iaas/index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/contributor-docs/operations/iam/identity-federation-in-scs.md b/contributor-docs/operations/iam/identity-federation-in-scs.md index ebec60f00f..de879fda93 100644 --- a/contributor-docs/operations/iam/identity-federation-in-scs.md +++ b/contributor-docs/operations/iam/identity-federation-in-scs.md @@ -21,7 +21,7 @@ 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 diff --git a/docs/01-getting-started/preinstall-checklist.md b/docs/01-getting-started/preinstall-checklist.md index 87ee69d32c..c368c7b003 100644 --- a/docs/01-getting-started/preinstall-checklist.md +++ b/docs/01-getting-started/preinstall-checklist.md @@ -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 diff --git a/docs/02-iaas/index.md b/docs/02-iaas/index.md index a2c1ab3895..f78742b565 100644 --- a/docs/02-iaas/index.md +++ b/docs/02-iaas/index.md @@ -8,7 +8,7 @@ sidebar_position: 1 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://ceph.io/) for storage. The OpenStack deployment is based on +[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.