Skip to content

Commit ecb5a16

Browse files
committed
Draft clarification on mandatory service types
Fixes #1004. ToDo: Move to v2. Signed-off-by: Friedrich Zahn <friedrich.zahn@alasca.cloud>
1 parent 248acdb commit ecb5a16

2 files changed

Lines changed: 17 additions & 28 deletions

File tree

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

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -26,45 +26,37 @@ 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:
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].
3031

31-
| Mandatory API | corresponding OpenStack Service | description |
32+
| Mandatory API service type | corresponding OpenStack Service | description |
3233
|-----|-----|-----|
3334
| **block-storage** | Cinder | Block Storage service |
3435
| **compute** | Nova | Compute service |
3536
| **identity** | Keystone | Identity service |
3637
| **image** | Glance | Image service |
3738
| **load-balancer** | Octavia | Load-balancer service |
3839
| **network** | Neutron | Networking 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.
40+
| **s3**[^2] | N/A | s3 compatible Object Storage service |
4641

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)
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.
5244

5345
## Supported IaaS APIs
5446

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.
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.
5648

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

6961
## Unsupported IaaS APIs
7062

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

7769
[The OpenStack Services](https://www.openstack.org/software/)
7870

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.
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

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,5 @@ supplements:
1111
We [implemented](https://github.com/SovereignCloudStack/standards/blob/main/Tests/iaas/openstack_test.py)
1212
the following testcases in accordance with the standard:
1313

14-
- `scs-0123-service-X` (with varying `X`) ensures that a service of type X can be found in the service catalog,
15-
- `scs-0123-storage-apis` ensures that a service of one of the following types can be found: "volume", "volumev3", "block-storage",
16-
- `scs-0123-swift-s3` ensures that S3 can be used to access object storage using EC2 credentials from the identity API.
14+
- `scs-0123-service-<type>` ensures that a service with the given type can be found in the service catalog
15+
- `scs-0123-storage-apis` ensures that a service of one of the following types can be found: "volume", "volumev3", "block-storage"

0 commit comments

Comments
 (0)