Skip to content

Commit 5614511

Browse files
committed
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, and links to the top-level OSISM documentation categories rather than individual guides. - 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, identity-federation-in-scs) and update the architecture overview data so the IaaS tiles link to the OSISM tool pages. 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 <klare@osism.tech>
1 parent c8626b1 commit 5614511

9 files changed

Lines changed: 68 additions & 61 deletions

File tree

contributor-docs/operations/iam/identity-federation-in-scs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ to achieve that goal. To simplify connecting the different parts of SCS
1313
to customer owned IAM solutions, SCS deploys Keycloak as central Identity
1414
Provider (IdP) service.
1515

16-
Currently this is deployed automatically only in the [osism/testbed](https://docs.scs.community/docs/iaas/guides/deploy-guide/examples/testbed/),
17-
which provides [its own documentation for authentication with OIDC](https://docs.scs.community/docs/iaas/guides/deploy-guide/examples/testbed#authentication-with-oidc).
16+
Currently this is deployed automatically only in the [OSISM testbed](https://osism.tech/docs/testbed/),
17+
which provides [its own documentation](https://osism.tech/docs/testbed/).
1818

1919
The following sections describe how this is done.
2020

docs.package.json

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,12 @@
55
"target": "docs",
66
"label": "06-releases"
77
},
8-
{
9-
"repo": "osism/osism.github.io",
10-
"source": "docs/guides/operations-guide/openstack/tools/*",
11-
"target": "docs/02-iaas/components",
12-
"label": ""
13-
},
148
{
159
"repo": "SovereignCloudStack/standards",
1610
"source": ["Standards/*.md", "Tests/scs-*.yaml"],
1711
"target": "standards",
1812
"label": ""
1913
},
20-
{
21-
"repo": "osism/osism.github.io",
22-
"source": "docs/guides",
23-
"target": "docs/02-iaas/",
24-
"label": ""
25-
},
26-
{
27-
"repo": "osism/osism.github.io",
28-
"source": "docs/testbed",
29-
"target": "docs/02-iaas/deployment-examples",
30-
"label": ""
31-
},
3214
{
3315
"repo": "SovereignCloudStack/k8s-harbor",
3416
"source": "docs",

docs/01-getting-started/preinstall-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ For the download of installation data such as container images, operating system
126126
either access to publicly accessible networks must be provided or a caching proxy or a dedicated
127127
repository server must be provided directly from the network for "Node communication".
128128

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

131131
TBD:
132132

docs/02-iaas/deployment-examples/artcodix/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,4 @@ the faster storage data can be replicated between nodes. This usually leads to i
158158

159159
## How to continue
160160

161-
After implementing the recommended deployment example hardware, you can continue with the [deployment guide](https://docs.scs.community/docs/iaas/guides/deploy-guide/).
161+
After implementing the recommended deployment example hardware, you can continue with the OSISM [deployment guide](https://osism.tech/docs/guides/deploy-guide/).

docs/02-iaas/index.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: IaaS Layer
3+
sidebar_position: 1
4+
---
5+
6+
# IaaS Layer
7+
8+
The SCS reference implementation of the Infrastructure-as-a-Service (IaaS) layer
9+
was built with [**OSISM**](https://osism.tech/docs). It builds on
10+
[OpenStack](https://openstack.org/) for compute, network and identity services and
11+
[Ceph](https://ceph.io/) for storage. The OpenStack deployment is based on
12+
[Kolla](https://opendev.org/openstack/kolla) (container images) and
13+
[kolla-ansible](https://opendev.org/openstack/kolla-ansible), which OSISM wraps with
14+
additional Ansible playbooks and tooling to deploy and operate the whole stack.
15+
16+
OSISM is the reference implementation, but not the only way to build an
17+
SCS-compatible cloud. SCS is a
18+
[modular software stack](https://sovereigncloudstack.org/en/modular-software-stack/):
19+
today, more than one implementation exists to build SCS-compatible clouds, and
20+
compliance is defined by the [standards](/standards) rather than by a single stack.
21+
22+
:::info
23+
24+
OSISM maintains its own, authoritative documentation. Rather than mirroring it
25+
here (and letting the copy drift out of date), this page links directly to the
26+
relevant sections of the official [OSISM documentation](https://osism.tech/docs/).
27+
28+
:::
29+
30+
## OSISM documentation
31+
32+
- [Getting started](https://osism.tech/docs/) — introduction and overview of OSISM.
33+
- [Concepts](https://osism.tech/docs/concepts/) — architecture and core components.
34+
- [Guides](https://osism.tech/docs/guides/) — deployment, configuration, operations,
35+
upgrade, troubleshooting and user guides.
36+
- [Testbed](https://osism.tech/docs/testbed/) — the fastest way to try SCS: a full
37+
virtual SCS/OSISM installation you can deploy on top of an existing OpenStack cloud.
38+
- [Release Notes](https://osism.tech/docs/release-notes/) — per-release notes and
39+
upgrade information.
40+
- [Appendix](https://osism.tech/docs/appendix/) — CLI reference, security advisories
41+
and supported standards.
42+
43+
## In this section
44+
45+
Alongside the OSISM reference, SCS maintains a few IaaS resources of its own:
46+
47+
- **Guides** — SCS user-facing best practices, such as configuring
48+
[security groups](/docs/iaas/guides/user-guide/security-groups)
49+
and creating [user data backups](/docs/iaas/guides/user-guide/user-data-backups).
50+
- **Deployment examples** — real-world setups such as the
51+
[artcodix](/docs/iaas/deployment-examples/artcodix/) production deployment and
52+
the SCS [turnkey hardware landscape](/docs/turnkey-solution/hardware-landscape/).

docs/08-faq/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ IaaS stands for Infrastructure as a Service, providing virtualized computing res
4747

4848
## How is the IaaS layer structured?
4949

50-
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)
50+
IaaS typically comprises virtual machines, storage, and network resources, all offered as scalable services. [Find the architecture here](https://docs.scs.community/docs/iaas/)
5151

5252
## What does KaaS mean?
5353

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

6262
**As a Cloud Service Provider**:
6363

64-
- **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)
64+
- **Testbed**: Use the SCS test environment to experiment. [Link to the OSISM testbed](https://osism.tech/docs/testbed/)
6565

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

docs/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ SCS is built, backed, and operated by an active open-source community worldwide.
1818

1919
### Virtualization (IaaS) Layer
2020

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

2325
#### Reference Implementation Testbed
2426

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

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

3838
#### Examples for real deployments
3939

sidebarsDocs.js

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ const sidebarsDocs = {
88
type: 'category',
99
label: 'IaaS Layer',
1010
link: {
11-
type: 'generated-index'
11+
type: 'doc',
12+
id: 'iaas/index'
1213
},
1314
items: [
1415
{
@@ -21,34 +22,6 @@ const sidebarsDocs = {
2122
}
2223
]
2324
},
24-
{
25-
type: 'category',
26-
label: 'Components',
27-
link: {
28-
type: 'generated-index'
29-
},
30-
items: [
31-
{
32-
type: 'category',
33-
label: 'Openstack Image Manager',
34-
link: {
35-
id: 'iaas/components/image-manager/index',
36-
type: 'doc'
37-
},
38-
items: [
39-
{
40-
type: 'doc',
41-
id: 'iaas/components/image-manager/update'
42-
}
43-
]
44-
},
45-
{
46-
type: 'doc',
47-
label: 'Openstack Flavor Manager',
48-
id: 'iaas/components/flavor-manager'
49-
}
50-
]
51-
},
5225
{
5326
type: 'category',
5427
label: 'Deployment Examples',

static/data/architecturalOverviewData.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,18 +71,18 @@
7171
{
7272
"title": "IaaS Layer",
7373
"body": "SCS offers OpenStack infrastructure solutions based on KVM virtualization to deploy VM workloads and enabling the container layer optionally.",
74-
"url": "/docs/category/iaas-layer",
74+
"url": "/docs/iaas/",
7575
"buttonText": "Learn More",
7676
"components": [
7777
{
7878
"title": "Image Manager",
79-
"url": "/docs/iaas/components/image-manager",
79+
"url": "https://osism.tech/docs/guides/operations-guide/openstack/tools/image-manager",
8080
"mandatory": "true",
8181
"stable": "true"
8282
},
8383
{
8484
"title": "Flavor Manager",
85-
"url": "/docs/iaas/components/flavor-manager",
85+
"url": "https://osism.tech/docs/guides/operations-guide/openstack/tools/flavor-manager",
8686
"mandatory": "true",
8787
"stable": "true"
8888
}

0 commit comments

Comments
 (0)