From 146f6aaf48bec1ddf7162304c29558395f91debe Mon Sep 17 00:00:00 2001 From: josephineSei <128813814+josephineSei@users.noreply.github.com> Date: Tue, 26 Mar 2024 11:01:00 +0100 Subject: [PATCH 1/5] Create mandatory-and-supported-os-services.md first draft for the OpenStack services lists Signed-off-by: josephineSei <128813814+josephineSei@users.noreply.github.com> --- .../mandatory-and-supported-os-services.md | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/02-iaas/mandatory-and-supported-os-services.md diff --git a/docs/02-iaas/mandatory-and-supported-os-services.md b/docs/02-iaas/mandatory-and-supported-os-services.md new file mode 100644 index 0000000000..73c38ab335 --- /dev/null +++ b/docs/02-iaas/mandatory-and-supported-os-services.md @@ -0,0 +1,56 @@ +# SCS mandatory and supported OpenStack services + +There are many OpenStack services that can be applied on IaaS-Level. +Those services have differences in the quality of their implementation and liveness and some of them may be easily omitted when creating an IaaS-Deployment. +To fulfill all SCS-provided standards there are only some of those services required. +More but not all OpenStack services are tested or integrated in the reference implementation. +This document will give readers insight about how the SCS looks at all the OpenStack services. +If a cloud consists of all mandatory and maybe some supported OpenStack services it can be tested for SCS-compliance. +Any unsupported services will not be tested. + +## Mandatory OpenStack services + +The following OpenStack services MUST be present in SCS-compliant IaaS-Deployments: + +| OpenStack Service | description | +|-----|-----| +| **Cinder** | Block Storage service | +| **Glance** | Image service | +| **Keystone** | Identity service | +| **Neutron** | Networking service | +| **Nova** | Compute service | +| **OpenstackSDK** | Multi-cloud Python SDK and CLI for End Users | +| **Oslo** | Common libraries | +| **Placement** | Hardware Describing Service for Nova | + +## Supported OpenStack services + +The following services MAY be present in SCS-compliant IaaS-Deployment and their integration had been tested by the SCS: + +| OpenStack Service | description | comment | +|-----|-----|-------| +| **Barbican** | Key Manager service | maybe a future mandatory service | +| **Ceilometer** | Telemetry service | | +| **Designate** | DNS service | | +| **Gnocchi** | Time Series Database service | needed for Ceilometer | +| **Heat** | Orchestration service | **maybe unsupported?** | +| **Horizon** | Dashboard | | +| **Ironic** | Bare Metal libraries | | +| **Octavia** | Load-balancer service | | +| **Swift** | Object Storage service | if not used, move to unsupported | +| **Skyline** | Dashboard | if not used, move to unsupported | + +## Unsupported OpenStack services + +All other OpenStack services that are not mentioned in the mandatory or supported lists are not tested for their integration and behavior by the SCS. +Those services MAY be used in IaaS-Deployments but the SCS will not assume they are present and potential issues that occur during the deploying or usage have to be handled by the CSP alone. + +There are still some notable services, that might come into the supported list, when there will be enough CSPs wanting this. +This list is not exhaustive: + +| OpenStack Service | description | comment | +|-----|-----|-------| +| **Cloudkitty** | Rating/Billing service | was requested once but not seen in production | +| **Magnum** | Container Infrastructure Management service | | +| **Manila** | Shared File Systems service | sometimes requestes | +| **Freezer** | Backup, Restore, and Disaster Recovery service | interesting service, that some people on upstream want to revive | From 27221f83ce1f5422a19e097cb62cce74d1973ed6 Mon Sep 17 00:00:00 2001 From: josephineSei <128813814+josephineSei@users.noreply.github.com> Date: Mon, 22 Apr 2024 10:51:00 +0200 Subject: [PATCH 2/5] Update mandatory-and-supported-os-services.md Signed-off-by: josephineSei <128813814+josephineSei@users.noreply.github.com> --- docs/02-iaas/mandatory-and-supported-os-services.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/02-iaas/mandatory-and-supported-os-services.md b/docs/02-iaas/mandatory-and-supported-os-services.md index 73c38ab335..f070750312 100644 --- a/docs/02-iaas/mandatory-and-supported-os-services.md +++ b/docs/02-iaas/mandatory-and-supported-os-services.md @@ -21,6 +21,7 @@ The following OpenStack services MUST be present in SCS-compliant IaaS-Deploymen | **Nova** | Compute service | | **OpenstackSDK** | Multi-cloud Python SDK and CLI for End Users | | **Oslo** | Common libraries | +| **Octavia** | Load-balancer service | | **Placement** | Hardware Describing Service for Nova | ## Supported OpenStack services @@ -30,13 +31,15 @@ The following services MAY be present in SCS-compliant IaaS-Deployment and their | OpenStack Service | description | comment | |-----|-----|-------| | **Barbican** | Key Manager service | maybe a future mandatory service | +| **Cloudkitty** | Rating/Billing service | maybe move to unsupported | | **Ceilometer** | Telemetry service | | | **Designate** | DNS service | | | **Gnocchi** | Time Series Database service | needed for Ceilometer | | **Heat** | Orchestration service | **maybe unsupported?** | | **Horizon** | Dashboard | | | **Ironic** | Bare Metal libraries | | -| **Octavia** | Load-balancer service | | +| **Manila** | Shared File Systems service | | +| **Masakari** | Instances High Availability service | | | **Swift** | Object Storage service | if not used, move to unsupported | | **Skyline** | Dashboard | if not used, move to unsupported | From 176675399bc0b374a5c0ef54f6eded94dda6c688 Mon Sep 17 00:00:00 2001 From: josephineSei <128813814+josephineSei@users.noreply.github.com> Date: Thu, 25 Apr 2024 07:50:25 +0200 Subject: [PATCH 3/5] Update mandatory-and-supported-os-services.md Signed-off-by: josephineSei <128813814+josephineSei@users.noreply.github.com> --- .../02-iaas/mandatory-and-supported-os-services.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/02-iaas/mandatory-and-supported-os-services.md b/docs/02-iaas/mandatory-and-supported-os-services.md index f070750312..8c90f625cb 100644 --- a/docs/02-iaas/mandatory-and-supported-os-services.md +++ b/docs/02-iaas/mandatory-and-supported-os-services.md @@ -1,11 +1,11 @@ # SCS mandatory and supported OpenStack services -There are many OpenStack services that can be applied on IaaS-Level. -Those services have differences in the quality of their implementation and liveness and some of them may be easily omitted when creating an IaaS-Deployment. -To fulfill all SCS-provided standards there are only some of those services required. +There are many OpenStack APIs and their services that can be applied on IaaS-Level. +These services have differences in the quality of their implementation and liveness and some of them may be easily omitted when creating an IaaS-Deployment. +To fulfill all SCS-provided standards there are only some of these APIs required. More but not all OpenStack services are tested or integrated in the reference implementation. This document will give readers insight about how the SCS looks at all the OpenStack services. -If a cloud consists of all mandatory and maybe some supported OpenStack services it can be tested for SCS-compliance. +If a cloud provides all mandatory and maybe some supported OpenStack APIs and implementation of their services it can be tested for SCS-compliance. Any unsupported services will not be tested. ## Mandatory OpenStack services @@ -19,10 +19,9 @@ The following OpenStack services MUST be present in SCS-compliant IaaS-Deploymen | **Keystone** | Identity service | | **Neutron** | Networking service | | **Nova** | Compute service | -| **OpenstackSDK** | Multi-cloud Python SDK and CLI for End Users | -| **Oslo** | Common libraries | | **Octavia** | Load-balancer service | | **Placement** | Hardware Describing Service for Nova | +| **S3 API object storage** | No formal standard exists, many implementations: Swift, RadosGW, minio... | ## Supported OpenStack services @@ -40,7 +39,6 @@ The following services MAY be present in SCS-compliant IaaS-Deployment and their | **Ironic** | Bare Metal libraries | | | **Manila** | Shared File Systems service | | | **Masakari** | Instances High Availability service | | -| **Swift** | Object Storage service | if not used, move to unsupported | | **Skyline** | Dashboard | if not used, move to unsupported | ## Unsupported OpenStack services @@ -53,7 +51,5 @@ This list is not exhaustive: | OpenStack Service | description | comment | |-----|-----|-------| -| **Cloudkitty** | Rating/Billing service | was requested once but not seen in production | | **Magnum** | Container Infrastructure Management service | | -| **Manila** | Shared File Systems service | sometimes requestes | | **Freezer** | Backup, Restore, and Disaster Recovery service | interesting service, that some people on upstream want to revive | From 94706dcb58e70ea0893533fdf1cd9b72368db8f7 Mon Sep 17 00:00:00 2001 From: josephineSei <128813814+josephineSei@users.noreply.github.com> Date: Fri, 3 May 2024 09:16:03 +0200 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Sven Co-authored-by: Markus Hentsch <129268441+markus-hentsch@users.noreply.github.com> Signed-off-by: josephineSei <128813814+josephineSei@users.noreply.github.com> --- docs/02-iaas/mandatory-and-supported-os-services.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/02-iaas/mandatory-and-supported-os-services.md b/docs/02-iaas/mandatory-and-supported-os-services.md index 8c90f625cb..0f30acfefd 100644 --- a/docs/02-iaas/mandatory-and-supported-os-services.md +++ b/docs/02-iaas/mandatory-and-supported-os-services.md @@ -36,18 +36,18 @@ The following services MAY be present in SCS-compliant IaaS-Deployment and their | **Gnocchi** | Time Series Database service | needed for Ceilometer | | **Heat** | Orchestration service | **maybe unsupported?** | | **Horizon** | Dashboard | | -| **Ironic** | Bare Metal libraries | | +| **Ironic** | Bare Metal provisioning service | | | **Manila** | Shared File Systems service | | | **Masakari** | Instances High Availability service | | | **Skyline** | Dashboard | if not used, move to unsupported | ## Unsupported OpenStack services -All other OpenStack services that are not mentioned in the mandatory or supported lists are not tested for their integration and behavior by the SCS. -Those services MAY be used in IaaS-Deployments but the SCS will not assume they are present and potential issues that occur during the deploying or usage have to be handled by the CSP alone. +All other OpenStack services that are not mentioned in the mandatory or supported lists are not tested for their integration and behavior by the SCS community. +Those services may be integrated into IaaS deployments by a CSP on their own responsibility but the SCS will not assume they are present and potential issues that occur during deployment or usage have to be handled by the CSP on their own accord. +The SCS standard offers no guarantees for compatibility or reliability of services categorized as unsupported in conjunction with an SCS-conformant infrastructure. -There are still some notable services, that might come into the supported list, when there will be enough CSPs wanting this. -This list is not exhaustive: +Some notable but currently unsupported services which address popular use cases are listed below (list not exhaustive): | OpenStack Service | description | comment | |-----|-----|-------| From e27188d2191acb6be724e85316c24afeb6958ea4 Mon Sep 17 00:00:00 2001 From: josephineSei <128813814+josephineSei@users.noreply.github.com> Date: Fri, 3 May 2024 09:53:36 +0200 Subject: [PATCH 5/5] Update mandatory-and-supported-os-services.md remove comments from tables, add warning regarding S3 and rephrase the first paragraph for the Supported list. Signed-off-by: josephineSei <128813814+josephineSei@users.noreply.github.com> --- .../mandatory-and-supported-os-services.md | 47 +++++++++++-------- 1 file changed, 28 insertions(+), 19 deletions(-) diff --git a/docs/02-iaas/mandatory-and-supported-os-services.md b/docs/02-iaas/mandatory-and-supported-os-services.md index 0f30acfefd..703c40a803 100644 --- a/docs/02-iaas/mandatory-and-supported-os-services.md +++ b/docs/02-iaas/mandatory-and-supported-os-services.md @@ -23,23 +23,32 @@ The following OpenStack services MUST be present in SCS-compliant IaaS-Deploymen | **Placement** | Hardware Describing Service for Nova | | **S3 API object storage** | No formal standard exists, many implementations: Swift, RadosGW, minio... | +:::caution + +S3 API implementations may differ in certain offered features. +CSPs must publicly describe, which implementation they use in their deployment. +Users should always research whether a needed feature is supported in the offered implementation. + +::: + ## Supported OpenStack services -The following services MAY be present in SCS-compliant IaaS-Deployment and their integration had been tested by the SCS: - -| OpenStack Service | description | comment | -|-----|-----|-------| -| **Barbican** | Key Manager service | maybe a future mandatory service | -| **Cloudkitty** | Rating/Billing service | maybe move to unsupported | -| **Ceilometer** | Telemetry service | | -| **Designate** | DNS service | | -| **Gnocchi** | Time Series Database service | needed for Ceilometer | -| **Heat** | Orchestration service | **maybe unsupported?** | -| **Horizon** | Dashboard | | -| **Ironic** | Bare Metal provisioning service | | -| **Manila** | Shared File Systems service | | -| **Masakari** | Instances High Availability service | | -| **Skyline** | Dashboard | if not used, move to unsupported | +The following services MAY be present in SCS-compliant IaaS-Deployment and they are considered in the SCS standards. +Most of these services (except Cloudkitty, Gnocchi and Masakari) have been integrated and tested by the SCS reference implementation: + +| OpenStack Service | description | +|-----|-----| +| **Barbican** | Key Manager service | +| **Cloudkitty** | Rating/Billing service | +| **Ceilometer** | Telemetry service | +| **Designate** | DNS service | +| **Gnocchi** | Time Series Database service | +| **Heat** | Orchestration service | +| **Horizon** | Dashboard | +| **Ironic** | Bare Metal provisioning service | +| **Manila** | Shared File Systems service | +| **Masakari** | Instances High Availability service | +| **Skyline** | Dashboard | ## Unsupported OpenStack services @@ -49,7 +58,7 @@ The SCS standard offers no guarantees for compatibility or reliability of servic Some notable but currently unsupported services which address popular use cases are listed below (list not exhaustive): -| OpenStack Service | description | comment | -|-----|-----|-------| -| **Magnum** | Container Infrastructure Management service | | -| **Freezer** | Backup, Restore, and Disaster Recovery service | interesting service, that some people on upstream want to revive | +| OpenStack Service | description | +|-----|-----| +| **Magnum** | Container Infrastructure Management service | +| **Freezer** | Backup, Restore, and Disaster Recovery service |