Skip to content

Commit f51a46c

Browse files
authored
Merge branch 'main' into 526-refine-cve-check-in-scs-0210-v2-test-script
2 parents f1674fe + f2d6e3c commit f51a46c

33 files changed

+790
-102
lines changed

Drafts/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
# Design-Docs
1+
# Drafts Archive
22

3-
Design Documents, Architecture etc. for SCS and related technology
3+
## Deprecation Notice
44

5-
Here we collect docs that cover overarching SCS topics or topics that otherwise do not belong to an existing repository.
5+
> [!CAUTION]
6+
> Please do not create new files in this folder!
7+
8+
The contents of this folder are for archival purposes only. New drafts belong
9+
in the [`../Standards/`](https://github.com/SovereignCloudStack/standards/tree/main/Standards)
10+
folder instead and adhere to the lifecycle described in
11+
[scs-0001-v1-sovereign-cloud-standards](https://github.com/SovereignCloudStack/standards/blob/main/Standards/scs-0001-v1-sovereign-cloud-standards.md).

Standards/scs-0100-w1-flavor-naming-implementation-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "SCS Flavor Naming Standard: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Proposal
5+
status: Draft
66
supplements:
77
- scs-0100-v1-flavor-naming.md
88
- scs-0100-v2-flavor-naming.md

Standards/scs-0101-w1-entropy-implementation-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "SCS Entropy: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Proposal
5+
status: Draft
66
supplements:
77
- scs-0101-v1-entropy.md
88
---

Standards/scs-0102-w1-image-metadata-implementation-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "SCS Image Metadata: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Proposal
5+
status: Draft
66
supplements:
77
- scs-0102-v1-image-metadata.md
88
---

Standards/scs-0104-w1-standard-images-implementation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "SCS Standard Images: Implementation Notes"
33
type: Supplement
44
track: IaaS
5-
status: Proposal
5+
status: Draft
66
supplements:
77
- scs-0104-v1-standard-images.md
88
---

Standards/scs-0116-w1-key-manager-implementation-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "SCS Key Manager Standard: Implementation and Testing Notes"
33
type: Supplement
44
track: IaaS
5-
status: Proposal
5+
status: Draft
66
supplements:
77
- scs-0116-v1-key-manager-standard.md
88
---

Standards/scs-0118-w1-example-impacts-of-failure-scenarios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "SCS Taxonomy of Failsafe Levels: Examples of Failure Cases and their impact on IaaS and KaaS resources"
33
type: Supplement
44
track: IaaS
5-
status: Proposal
5+
status: Draft
66
supplements:
77
- scs-0118-v1-taxonomy-of-failsafe-levels.md
88
---

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: Mandatory and Supported IaaS Services
33
type: Standard
4-
status: Draft
4+
status: Stable
5+
stabilized_at: 2024-11-20
56
track: IaaS
67
---
78

@@ -40,7 +41,7 @@ The following IaaS APIs MUST be present in SCS-compliant IaaS deployments and co
4041
:::caution
4142

4243
S3 API implementations may differ in certain offered features.
43-
CSPs must publicly describe, which implementation they use in their deployment.
44+
CSPs must publicly describe the endpoints of their S3 solutions and which implementations they use in their deployment.
4445
Users should always research whether a needed feature is supported in the offered implementation.
4546

4647
:::
@@ -56,20 +57,19 @@ The following IaaS APIs MAY be present in SCS-compliant IaaS deployment, e.g. im
5657
| Supported API | corresponding OpenStack Service | description |
5758
|-----|-----|-----|
5859
| **bare-metal** | Ironic | Bare Metal provisioning service |
59-
| **billing** | Cloudkitty | Rating/Billing service |
60+
| **billing** | CloudKitty | Rating/Billing service |
6061
| **dns** | Designate | DNS service |
6162
| **ha** | Masakari | Instances High Availability service |
6263
| **key-manager** | Barbican | Key Manager service |
6364
| **object-store** | Swift | Object Store with different possible backends |
6465
| **orchestration** | Heat | Orchestration service |
6566
| **shared-file-systems** | Manila | Shared File Systems service |
66-
| **telemetry** | Ceilometer | Telemetry service |
67-
| **time-series-databse** | Gnocchi | Time Series Database service |
67+
| **time-series-database** | Gnocchi | Time Series Database service |
6868

6969
## Unsupported IaaS APIs
7070

7171
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.
72-
Those services MAY be integrated into IaaS deployments by a Cloud Service Provider 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.
72+
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.
7373
The SCS standard offers no guarantees for compatibility or reliability of services categorized as unsupported.
7474

7575
## Related Documents
@@ -78,5 +78,5 @@ The SCS standard offers no guarantees for compatibility or reliability of servic
7878

7979
## Conformance Tests
8080

81-
The presence of the mandatory OpenStack APIs will be tested in [this test-script](https://github.com/SovereignCloudStack/standards/blob/mandatory-and-supported-IaaS-services/Tests/iaas/mandatory-services/mandatory-iaas-services.py).
82-
The test will further check, whether the object store endpoint is compatible to s3.
81+
The presence of the mandatory OpenStack APIs will be tested in [this test-script](https://github.com/SovereignCloudStack/standards/blob/main/Tests/iaas/mandatory-services/mandatory-iaas-services.py)
82+
The test will further check whether the object-store endpoint is compatible to s3.

Standards/scs-0211-w1-kaas-default-storage-class-implementation-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "SCS KaaS default storage class: Implementation and Testing Notes"
33
type: Supplement
44
track: KaaS
5-
status: Proposal
5+
status: Draft
66
supplements:
77
- scs-0211-v1-kaas-default-storage-class.md
88
---

Standards/scs-0214-v1-k8s-node-distribution.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -80,42 +80,6 @@ If the standard is used by a provider, the following decisions are binding and v
8080
can also be scaled vertically first before scaling horizontally.
8181
- Worker node distribution MUST be indicated to the user through some kind of labeling
8282
in order to enable (anti)-affinity for workloads over "failure zones".
83-
- To provide metadata about the node distribution, which also enables testing of this standard,
84-
providers MUST label their K8s nodes with the labels listed below.
85-
- `topology.kubernetes.io/zone`
86-
87-
Corresponds with the label described in [K8s labels documentation][k8s-labels-docs].
88-
It provides a logical zone of failure on the side of the provider, e.g. a server rack
89-
in the same electrical circuit or multiple machines bound to the internet through a
90-
singular network structure. How this is defined exactly is up to the plans of the provider.
91-
The field gets autopopulated most of the time by either the kubelet or external mechanisms
92-
like the cloud controller.
93-
94-
- `topology.kubernetes.io/region`
95-
96-
Corresponds with the label described in [K8s labels documentation][k8s-labels-docs].
97-
It describes the combination of one or more failure zones into a region or domain, therefore
98-
showing a larger entity of logical failure zone. An example for this could be a building
99-
containing racks that are put into such a zone, since they're all prone to failure, if e.g.
100-
the power for the building is cut. How this is defined exactly is also up to the provider.
101-
The field gets autopopulated most of the time by either the kubelet or external mechanisms
102-
like the cloud controller.
103-
104-
- `topology.scs.community/host-id`
105-
106-
This is an SCS-specific label; it MUST contain the hostID of the physical machine running
107-
the hypervisor (NOT: the hostID of a virtual machine). Here, the hostID is an arbitrary identifier,
108-
which need not contain the actual hostname, but it should nonetheless be unique to the host.
109-
This helps identify the distribution over underlying physical machines,
110-
which would be masked if VM hostIDs were used.
111-
112-
## Conformance Tests
113-
114-
The script `k8s-node-distribution-check.py` checks the nodes available with a user-provided
115-
kubeconfig file. It then determines based on the labels `kubernetes.io/hostname`, `topology.kubernetes.io/zone`,
116-
`topology.kubernetes.io/region` and `node-role.kubernetes.io/control-plane`, if a distribution
117-
of the available nodes is present. If this isn't the case, the script produces an error.
118-
If also produces warnings and informational outputs, if e.g. labels don't seem to be set.
11983

12084
[k8s-ha]: https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/high-availability/
12185
[k8s-large-clusters]: https://kubernetes.io/docs/setup/best-practices/cluster-large/

0 commit comments

Comments
 (0)