Skip to content

Commit 58e3c86

Browse files
toothstonetoothstone
committed
Move to v2
Signed-off-by: Friedrich Zahn <friedrich.zahn@alasca.cloud>
1 parent 8ec7b86 commit 58e3c86

3 files changed

Lines changed: 98 additions & 16 deletions

‎Standards/scs-0123-v1-mandatory-and-supported-IaaS-services.md‎

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,37 +26,45 @@ Any unsupported APIs will not be tested.
2626

2727
## Mandatory IaaS APIs
2828

29-
The following IaaS APIs MUST be present in SCS-compliant IaaS deployments and could be implemented with the corresponding OpenStack services.
30-
The endpoints of services MUST be findable through the `catalog list` of the identity API[^1].
29+
The following IaaS APIs MUST be present in SCS-compliant IaaS deployments and could be implemented with the corresponding OpenStack services:
3130

32-
| Mandatory API service type | corresponding OpenStack Service | description |
31+
| Mandatory API | corresponding OpenStack Service | description |
3332
|-----|-----|-----|
3433
| **block-storage** | Cinder | Block Storage service |
3534
| **compute** | Nova | Compute service |
3635
| **identity** | Keystone | Identity service |
3736
| **image** | Glance | Image service |
3837
| **load-balancer** | Octavia | Load-balancer service |
3938
| **network** | Neutron | Networking service |
40-
| **s3**[^2] | N/A | s3 compatible Object Storage service |
39+
| **s3** | S3 API object storage | Object Storage service |
40+
41+
:::caution
42+
43+
S3 API implementations may differ in certain offered features.
44+
CSPs must publicly describe the endpoints of their S3 solutions and which implementations they use in their deployment.
45+
Users should always research whether a needed feature is supported in the offered implementation.
4146

42-
Aliases for these service types are only permitted where defined by the [OpenStack Service Type Authority](https://specs.openstack.org/openstack/service-types-authority/#aliases-optional).
43-
Catalog entries SHOULD use the canonical service type, not aliases.
47+
:::
48+
49+
The endpoints of services MUST be findable through the `catalog list` of the identity API[^1].
50+
51+
[^1]: [Integrate into the service catalog of Keystone](https://docs.openstack.org/keystone/latest/contributor/service-catalog.html)
4452

4553
## Supported IaaS APIs
4654

47-
The following IaaS APIs MAY be present in SCS-compliant IaaS deployment, e.g. implemented through the corresponding OpenStack services, and are considered in the SCS standards.
55+
The following IaaS APIs MAY be present in SCS-compliant IaaS deployment, e.g. implemented thorugh the corresponding OpenStack services, and are considered in the SCS standards.
4856

49-
| Supported API service type | corresponding OpenStack Service | description |
57+
| Supported API | corresponding OpenStack Service | description |
5058
|-----|-----|-----|
51-
| **baremetal** | Ironic | Bare Metal provisioning service |
52-
| **rating** | CloudKitty | Rating/Billing service |
59+
| **bare-metal** | Ironic | Bare Metal provisioning service |
60+
| **billing** | CloudKitty | Rating/Billing service |
5361
| **dns** | Designate | DNS service |
54-
| **instance-ha** | Masakari | Instances High Availability service |
62+
| **ha** | Masakari | Instances High Availability service |
5563
| **key-manager** | Barbican | Key Manager service |
5664
| **object-store** | Swift | Object Store with different possible backends |
5765
| **orchestration** | Heat | Orchestration service |
58-
| **shared-file-system** | Manila | Shared File Systems service |
59-
| **time-series-database**[^2] | Gnocchi | Time Series Database service |
66+
| **shared-file-systems** | Manila | Shared File Systems service |
67+
| **time-series-database** | Gnocchi | Time Series Database service |
6068

6169
## Unsupported IaaS APIs
6270

@@ -68,5 +76,7 @@ The SCS standard offers no guarantees for compatibility or reliability of servic
6876

6977
[The OpenStack Services](https://www.openstack.org/software/)
7078

71-
[^1]: [Integrate into the service catalog of Keystone](https://docs.openstack.org/keystone/latest/contributor/service-catalog.html)
72-
[^2]: These service types have not been assigned by the OpenStack Service Type Authority
79+
## Conformance Tests
80+
81+
The presence of the mandatory OpenStack APIs will be tested in [this test-script](https://github.com/SovereignCloudStack/standards/blob/main/Tests/iaas/scs_0123_mandatory_services/mandatory_services.py)
82+
The test will further check whether the object-store endpoint is compatible to s3.

‎Standards/scs-0123-v2-services.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: Mandatory and Supported IaaS Services
3+
type: Standard
4+
status: Draft
5+
track: IaaS
6+
---
7+
8+
## Introduction
9+
10+
To be SCS-compliant a Cloud Service Provider (CSP) has to fulfill all SCS standards.
11+
Some of those standards are broad and consider all APIs of all services on the IaaS-Layer like the consideration of a [role standard](https://github.com/SovereignCloudStack/issues/issues/396).
12+
There exist many services on that layer and for a first step they need to be limited to have a clear scope for the standards and the Cloud Service Providers following them.
13+
For this purpose, this standard will establish lists for mandatory services whose APIs have to be present in a SCS cloud as well as supported services, which APIs are considered by some standards and may even be tested for their integration but are optional in a sense that their omission will not violate SCS conformance.
14+
15+
## Motivation
16+
17+
There are many OpenStack APIs and their corresponding services that can be deployed on the IaaS level.
18+
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.
19+
To fulfill all SCS-provided standards only a subset of these APIs are required.
20+
Some more but not all remaining OpenStack APIs are also supported additionally by the SCS project and may be part of its reference implementation.
21+
This results in different levels of support for specific services.
22+
This document will give readers insight about how the SCS classifies the OpenStack APIs accordingly.
23+
If a cloud provides all mandatory and any number of supported OpenStack APIs, it can be tested for SCS-compliance.
24+
Any unsupported APIs will not be tested.
25+
26+
## Mandatory IaaS APIs
27+
28+
The following IaaS APIs MUST be present in SCS-compliant IaaS deployments and could be implemented with the corresponding OpenStack services.
29+
The endpoints of services MUST be findable through the `catalog list` of the identity API[^1].
30+
31+
| Mandatory API service type | corresponding OpenStack Service | description |
32+
|-----|-----|-----|
33+
| **block-storage** | Cinder | Block Storage service |
34+
| **compute** | Nova | Compute service |
35+
| **identity** | Keystone | Identity service |
36+
| **image** | Glance | Image service |
37+
| **load-balancer** | Octavia | Load-balancer service |
38+
| **network** | Neutron | Networking service |
39+
| **s3**[^2] | N/A | s3 compatible Object Storage service |
40+
41+
Aliases for these service types are only permitted where defined by the [OpenStack Service Type Authority](https://specs.openstack.org/openstack/service-types-authority/#aliases-optional).
42+
Catalog entries SHOULD use the canonical service type, not aliases.
43+
44+
## Supported IaaS APIs
45+
46+
The following IaaS APIs MAY be present in SCS-compliant IaaS deployment, e.g. implemented through the corresponding OpenStack services, and are considered in the SCS standards.
47+
48+
| Supported API service type | corresponding OpenStack Service | description |
49+
|-----|-----|-----|
50+
| **baremetal** | Ironic | Bare Metal provisioning service |
51+
| **rating** | CloudKitty | Rating/Billing service |
52+
| **dns** | Designate | DNS service |
53+
| **instance-ha** | Masakari | Instances High Availability service |
54+
| **key-manager** | Barbican | Key Manager service |
55+
| **object-store** | Swift | Object Store with different possible backends |
56+
| **orchestration** | Heat | Orchestration service |
57+
| **shared-file-system** | Manila | Shared File Systems service |
58+
| **time-series-database**[^2] | Gnocchi | Time Series Database service |
59+
60+
## Unsupported IaaS APIs
61+
62+
All other OpenStack services, whose APIs are not mentioned in the mandatory or supported lists will not be tested for their compatibility and conformance in SCS clouds by the SCS community.
63+
Those services MAY be integrated into IaaS deployments by a Cloud Service Provider on their own responsibility but 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.
64+
The SCS standard offers no guarantees for compatibility or reliability of services categorized as unsupported.
65+
66+
## Related Documents
67+
68+
[The OpenStack Services](https://www.openstack.org/software/)
69+
70+
[^1]: [Integrate into the service catalog of Keystone](https://docs.openstack.org/keystone/latest/contributor/service-catalog.html)
71+
[^2]: These service types have not been assigned by the OpenStack Service Type Authority

‎Standards/scs-0123-w1-mandatory-and-supported-IaaS-services-implementation.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ the following testcases in accordance with the standard:
1616
- `scs-0123-storage-apis` ensures that a service of one of the following types can be found: "volume", "volumev3", "block-storage"
1717

1818
### Deprecated tests
19+
1920
#### v1 only
20-
- `scs-0123-swift-s3` ensures that S3 can be used to access object storage using EC2 credentials from the identity API
2121

22+
- `scs-0123-swift-s3` ensures that S3 can be used to access object storage using EC2 credentials from the identity API

0 commit comments

Comments
 (0)