From adda2b7df9e8342174d7208e93806631fb2740ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20B=C3=BCchse?= Date: Fri, 28 Jun 2024 18:15:16 +0200 Subject: [PATCH 1/3] Copy current cloud table from standards repo (#209) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Matthias Büchse --- standards/certification/overview.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/standards/certification/overview.md b/standards/certification/overview.md index ca417b5ea2..11ccf9eaf6 100644 --- a/standards/certification/overview.md +++ b/standards/certification/overview.md @@ -13,12 +13,12 @@ This is a list of clouds that we test on a nightly basis against the certificate | Name | Description | Operator | _SCS-compatible IaaS_ Compliance | HealthMon | | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------: | -| [gx-scs](https://github.com/SovereignCloudStack/docs/blob/main/community/cloud-resources/plusserver-gx-scs.md) | Dev environment provided for SCS & GAIA-X context | plusserver GmbH | [![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-gx-scs-v2.yml?label=v2)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-gx-scs-v2.yml) | [HM](https://health.gx-scs.sovereignit.cloud:3000/) | +| [gx-scs](https://github.com/SovereignCloudStack/docs/blob/main/community/cloud-resources/plusserver-gx-scs.md) | Dev environment provided for SCS & GAIA-X context | plusserver GmbH | [![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-gx-scs-v3.yml?label=v3)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-gx-scs-v3.yml) | [HM](https://health.gx-scs.sovereignit.cloud:3000/) | | [pluscloud open](https://www.plusserver.com/en/products/pluscloud-open)
- prod1
- prod2
- prod3
- prod4 | Public cloud for customers (4 regions) | plusserver GmbH |  
[![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-pco-prod1-v2.yml?label=v2)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-pco-prod1-v2.yml)
[![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-pco-prod2-v2.yml?label=v2)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-pco-prod2-v2.yml)
[![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-pco-prod3-v2.yml?label=v2)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-pco-prod3-v2.yml)
[![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-pco-prod4-v2.yml?label=v2)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-pco-prod4-v2.yml) |  
[HM1](https://health.prod1.plusserver.sovereignit.cloud:3000/d/9ltTEmlnk/openstack-health-monitor2?orgId=1&var-mycloud=plus-pco)
[HM2](https://health.prod1.plusserver.sovereignit.cloud:3000/d/9ltTEmlnk/openstack-health-monitor2?orgId=1&var-mycloud=plus-prod2)
[HM3](https://health.prod1.plusserver.sovereignit.cloud:3000/d/9ltTEmlnk/openstack-health-monitor2?orgId=1&var-mycloud=plus-prod3)
[HM4](https://health.prod1.plusserver.sovereignit.cloud:3000/d/9ltTEmlnk/openstack-health-monitor2?orgId=1&var-mycloud=plus-prod4) | | [Wavestack](https://www.noris.de/wavestack-cloud/) | Public cloud for customers | noris network AG/Wavecon GmbH | [![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-wavestack-v3.yml?label=v3)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-wavestack-v3.yml) | [HM](https://health.wavestack1.sovereignit.cloud:3000/) | | [REGIO.cloud](https://regio.digital) | Public cloud for customers | OSISM GmbH | [![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-regio-a-v4.yml?label=v4)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-regio-a-v4.yml) | broken | | [CNDS](https://cnds.io/) | Public cloud for customers | [artcodix UG](https://artcodix.com/) | [![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-artcodix-v3.yml?label=v3)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-artcodix-v3.yml) | [HM](https://ohm.muc.cloud.cnds.io/) | -| [aov.cloud](https://aov.de/) | Community cloud for customers | aov IT.Services GmbH | (soon) | [HM](https://health.aov.cloud/) | +| [aov.cloud](https://www.aov.de/) | Community cloud for customers | aov IT.Services GmbH | (soon) | [HM](https://health.aov.cloud/) | | PoC WG-Cloud OSBA | Cloud PoC for FITKO (yaook-based) | Cloud&Heat Technologies GmbH | [![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-poc-wgcloud-v4.yml?label=v4)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-poc-wgcloud-v4.yml) | [HM](https://health.poc-wgcloud.osba.sovereignit.cloud:3000/d/9ltTEmlnk/openstack-health-monitor2?var-mycloud=poc-wgcloud&orgId=1) | | PoC KDO | Cloud PoC for FITKO | KDO Service GmbH / OSISM GmbH | [![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-poc-kdo-v4.yml?label=v4)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-poc-kdo-v4.yml) | (soon) | -| [syseleven](https://www.syseleven.de/en/products-services/openstack-cloud/)
- dus2
- ham1 | Public OpenStack Cloud (2 SCS regions) | SysEleven GmbH |  
[![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-syseleven-dus2-v4.yml?label=v4)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-syseleven-dus2-v4.yml)
[![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-syseleven-ham1-v4.yml?label=v4)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-syseleven-ham1-v4.yml) |  
(soon)
(soon) | +| [syseleven](https://www.syseleven.de/en/products-services/openstack-cloud/)
- dus2
- ham1 | Public OpenStack Cloud (2 SCS regions) | SysEleven GmbH |  
[![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-syseleven-dus2-v3.yml?label=v3)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-syseleven-dus2-v3.yml)
[![Compliance Status](https://img.shields.io/github/actions/workflow/status/SovereignCloudStack/standards/check-syseleven-ham1-v3.yml?label=v3)](https://github.com/SovereignCloudStack/standards/actions/workflows/check-syseleven-ham1-v3.yml) |  
(soon)
(soon) | From 3797288158b2bc7cf39095caa2a0aff56d39f9ae Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 15 Jul 2024 08:55:51 +0200 Subject: [PATCH 2/3] Bump braces from 3.0.2 to 3.0.3 (#206) Bumps [braces](https://github.com/micromatch/braces) from 3.0.2 to 3.0.3. - [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md) - [Commits](https://github.com/micromatch/braces/compare/3.0.2...3.0.3) --- updated-dependencies: - dependency-name: braces dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Max Wolfs --- package-lock.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/package-lock.json b/package-lock.json index bcb67f0135..9ccc9d85b5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5317,11 +5317,11 @@ } }, "node_modules/braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", "dependencies": { - "fill-range": "^7.0.1" + "fill-range": "^7.1.1" }, "engines": { "node": ">=8" @@ -8636,9 +8636,9 @@ } }, "node_modules/fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", "dependencies": { "to-regex-range": "^5.0.1" }, From 6f6856993b2694c19e7c593a6e31689988e17225 Mon Sep 17 00:00:00 2001 From: Joshua Irmer <62890337+joshuai96@users.noreply.github.com> Date: Tue, 16 Jul 2024 09:51:23 +0200 Subject: [PATCH 3/3] Feat: Add status page docs (#207) * feat: add status page docs Signed-off-by: Joshua Irmer * add new deployment docs Signed-off-by: Joshua Irmer * split openapi and api docs Signed-off-by: Joshua Irmer * fix broken link Point status page link to status page category Signed-off-by: Joshua Irmer * add openapi overview to concepts category Signed-off-by: Joshua Irmer * add all API docs Signed-off-by: Joshua Irmer * add admin authentication docs Signed-off-by: Joshua Irmer * add monitoring deployment docs Signed-off-by: Joshua Irmer --------- Signed-off-by: Joshua Irmer --- docs.package.json | 14 ++++- sidebarsDocs.js | 72 +++++++++++++++++++--- static/data/architecturalOverviewData.json | 2 +- 3 files changed, 79 insertions(+), 9 deletions(-) diff --git a/docs.package.json b/docs.package.json index 9abfd0a90f..f7e78a585c 100644 --- a/docs.package.json +++ b/docs.package.json @@ -46,7 +46,19 @@ "repo": "SovereignCloudStack/status-page-openapi", "source": "docs", "target": "docs/04-operating-scs/components", - "label": "status-page" + "label": "status-page-openapi" + }, + { + "repo": "SovereignCloudStack/status-page-api", + "source": "docs", + "target": "docs/04-operating-scs/components", + "label": "status-page-api" + }, + { + "repo": "SovereignCloudStack/status-page-deployment", + "source": "docs", + "target": "docs/04-operating-scs/components", + "label": "status-page-deployment" }, { "repo": "SovereignCloudStack/k8s-observability", diff --git a/sidebarsDocs.js b/sidebarsDocs.js index 3d68410455..5198751765 100644 --- a/sidebarsDocs.js +++ b/sidebarsDocs.js @@ -214,15 +214,70 @@ const sidebarsDocs = { items: [ { type: 'category', - label: 'Status Page API', + label: 'Status Page', link: { type: 'generated-index' }, items: [ - 'operating-scs/components/status-page/docs/overview', - 'operating-scs/components/status-page/docs/component_overview', - 'operating-scs/components/status-page/docs/components', - 'operating-scs/components/status-page/docs/levels_of_consensus' + { + type: 'category', + label: 'Concepts', + link: { + type: 'generated-index' + }, + items: [ + 'operating-scs/components/status-page-openapi/docs/overview', + 'operating-scs/components/status-page-openapi/docs/components', + 'operating-scs/components/status-page-openapi/docs/levels_of_consensus', + 'operating-scs/components/status-page-openapi/docs/component_overview' + ] + }, + { + type: 'category', + label: 'API', + link: { + type: 'generated-index' + }, + items: [ + 'operating-scs/components/status-page-api/docs/overview', + 'operating-scs/components/status-page-api/docs/requirements', + 'operating-scs/components/status-page-api/docs/quickstart', + 'operating-scs/components/status-page-api/docs/configuration', + 'operating-scs/components/status-page-api/docs/requests', + 'operating-scs/components/status-page-api/docs/example-requests', + 'operating-scs/components/status-page-api/docs/contribute' + ] + }, + { + type: 'category', + label: 'Deployment', + link: { + type: 'generated-index' + }, + items: [ + 'operating-scs/components/status-page-deployment/docs/overview', + 'operating-scs/components/status-page-deployment/docs/requirements', + 'operating-scs/components/status-page-deployment/docs/quickstart', + { + type: 'category', + label: 'Configuration', + link: { + type: 'generated-index' + }, + items: [ + 'operating-scs/components/status-page-deployment/docs/configuration', + 'operating-scs/components/status-page-deployment/docs/kind', + 'operating-scs/components/status-page-deployment/docs/k3s', + 'operating-scs/components/status-page-deployment/docs/scs-public' + ] + }, + 'operating-scs/components/status-page-deployment/docs/usage', + 'operating-scs/components/status-page-deployment/docs/monitoring', + 'operating-scs/components/status-page-deployment/docs/contribute', + 'operating-scs/components/status-page-deployment/docs/admin-authentication', + 'operating-scs/components/status-page-deployment/docs/faq' + ] + } ] }, { @@ -267,7 +322,7 @@ const sidebarsDocs = { 'operating-scs/components/automated-pentesting/overview', 'operating-scs/components/automated-pentesting/tools' ] - }, + } ] }, { @@ -354,7 +409,10 @@ const sidebarsDocs = { link: { type: 'generated-index' }, - items: ['iam/domain-manager-setup-and-usage', 'iam/SCS-example-setup-configuration-description'] + items: [ + 'iam/domain-manager-setup-and-usage', + 'iam/SCS-example-setup-configuration-description' + ] }, 'iam/intra-SCS-federation-setup-description-for-osism-doc-operations' ] diff --git a/static/data/architecturalOverviewData.json b/static/data/architecturalOverviewData.json index 2fcbc8d9a0..6de5069e67 100644 --- a/static/data/architecturalOverviewData.json +++ b/static/data/architecturalOverviewData.json @@ -8,7 +8,7 @@ "components": [ { "title": "Status Page", - "url": "/docs/operating-scs/components/status-page/docs/overview", + "url": "/docs/category/status-page", "mandatory": "true", "stable": "true" },