-
Notifications
You must be signed in to change notification settings - Fork 37
Replace yaml scopes by regular standards #1199
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
8e0ebd2
Fix chk_adrs.py: Stable need not precede Deprecated
mbuechse 119b264
Replace yaml scopes by regular standards
mbuechse 128d530
Add scs-0003-v2
mbuechse f705d58
Fix missing replaces field
mbuechse 97a423b
Fix missing intro
mbuechse 0cd46ca
Drop test suite for the time being
mbuechse 359343d
Update concept of score card
mbuechse 61365ed
Fix extraneous version history in v1
mbuechse fe93f75
Make scope versions more transparent using changelog
mbuechse 9ca87ac
Insert real link instead of placeholder comment
mbuechse File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
Standards/scs-0003-v2-sovereign-cloud-standards-testing.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| title: Sovereign Cloud Standards Testing | ||
| type: Procedural | ||
| status: Draft | ||
| track: Global | ||
| replaces: | ||
| - scs-0003-v1-sovereign-cloud-standards-yaml.md | ||
| description: | | ||
| SCS-0003 defines concepts central to testing SCS standards and regulates how results may | ||
| be obtained and aggregated. | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This standard defines concepts central to testing SCS standards and regulates how results may | ||
| be obtained and aggregated. | ||
|
|
||
| ## Concept definitions | ||
|
|
||
| A standard can be viewed as a collection of propositions that "must" (or "should") be satisfied | ||
| by a test subject (cloud or cluster). The standard is satisfied if all "must" propositions are | ||
| satisfied. | ||
|
|
||
| A _testcase_ is a collection of propositions that coincide with respect to the following properties: | ||
|
|
||
| - whether they can be tested automatically with normal user permissions; | ||
| - how often they need to be tested (daily, weekly, monthly, annually); | ||
| - whether they are required ("must"). | ||
|
|
||
| We unambiguously refer to a testcase using a composite identifier consisting of two parts: | ||
|
|
||
| - the _scope_: in the context of this standard, just an identifier of a namespace; | ||
| for example: `scs-compatible-iaas` (or a UUID) | ||
| - the _testcase id_, for example `scs-0100-syntax-check` or `scs-0101-fips-test`. | ||
|
|
||
| The scope part is usually clear from the context and therefore omitted. | ||
|
|
||
| A _test_ is a testcase or a collection of tests. We refer to a test using the same kind of | ||
| composite identifier as for a testcase. | ||
|
|
||
| For instance, if we have testcases `scs-0100-syntax-check` and `scs-0100-semantics-check`, | ||
| we could define the test `scs-0100-v3` as the collection consisting of these two testcases. | ||
| Given further tests `scs-0101-v1`, `scs-0102-v1` etc., we could define the test `scs-0501-v4` | ||
| as the collection consisting of `scs-0100-v3`, `scs-0101-v1`, `scs-0102-v1` etc. | ||
|
|
||
| A test can be viewed as a collection of propositions; namely, all propositions of all testcases | ||
| that are part of the test. | ||
|
|
||
| The _result_ of a test is one of the following values: | ||
|
|
||
| - `FAIL`: it could be verified that at least one of its propositions is not satisfied; | ||
| - `MISS` (missing): for at least one of its propositions, it was not (recently) attempted to verify it; | ||
| - `DNF` (did not finish): for at least one of its propositions, it could not be verified whether it is satisfied; | ||
| - `PASS`: it could be verified that all its propositions are satisfied. | ||
|
|
||
| If multiple items apply, we always opt for the topmost one. | ||
|
|
||
| A _test report_ is a data structure that contains the following information: | ||
|
|
||
| - UUID, | ||
| - Subject: the name of the test subject, | ||
| - Scope: the scope of all the testcases referred to in this score card, | ||
| - Creator: who created the report (name of person or version of the software), | ||
| - Check date: when the test was performed, | ||
| - Test results: a mapping that maps testcase ids to results. | ||
| - Log: free-form text that details the test run. | ||
|
|
||
| A _check script_ is a computer program that tests one or more testcases and produces a test report. | ||
|
|
||
| A _score card_ is a data structure that contains the following information: | ||
|
|
||
| - Subject: the name of the test subject, | ||
| - Scope: the scope of all the testcases referred to in this score card, | ||
| - Results: a mapping that maps testcase ids to results, where each result is additionally | ||
| equipped with validity timespan (beginning at the time of the check and expiring according to | ||
| the lifetime of the result). | ||
|
|
||
| ## Regulation | ||
|
|
||
| Each standard must be decomposed into testcases. Each testcase should be "atomic" in the following two senses: | ||
|
|
||
| - it's clear what specific part of the standard is satisfied or not satisfied; | ||
| - the testcase can be reused for multiple versions of the standards. | ||
|
|
||
| The latter criterion is a matter of engineering judgment, because it cannot be known in advance how a standard might evolve. | ||
|
|
||
| Each testcase id must be prefixed by `scs-XXXX-` where `XXXX` is the document id of the standard; an exception is possible in the rare case when a testcase applies to multiple standards. | ||
|
|
||
| A check script that can test multiple testcases should provide the option to select which testcases to run. | ||
|
|
||
| A list of reports from a certain time frame can be merged into an aggregate score card, provided that the following conditions are satisfied: | ||
|
|
||
| - for each testcase, the result must be taken from the most recent report containing that testcase, | ||
| - if an additional report from the same time frame is known to exist, all its testcases must be contained in more recent reports from the list. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| title: SCS Certificate Scopes | ||
| type: Standard | ||
| track: Scopes | ||
| status: Draft | ||
| description: | | ||
| Basic definitions and regulations regarding SCS certificate scopes. | ||
| --- | ||
|
|
||
| ## Definition | ||
|
|
||
| In essence, a certificate scope is a standard that has to be fulfilled in order for a certificate to be awarded. | ||
| It usually refers to other standards in regards to actual subject matter — what properties the subject | ||
| has to satisfy —, and it contains regulations regarding the testing regime. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: SCS-compatible IaaS | ||
| type: Standard | ||
| track: Scopes | ||
| status: Deprecated | ||
| stabilized_at: 2021-01-01 | ||
| deprecated_at: 2023-10-31 | ||
| description: | | ||
| The certificate scope for level SCS-compatible and layer IaaS. | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This is v1 of the certificate scope _SCS-compatible IaaS_. | ||
|
|
||
| ## Subject Matter | ||
|
|
||
| The following standards are included: | ||
|
|
||
| - OpenStack-powered Compute v2020.11 | ||
| - [scs-0100-v1: Flavor naming](https://docs.scs.community/standards/scs-0100-v1-flavor-naming) | ||
| - [scs-0102-v1: Image metadata](https://docs.scs.community/standards/scs-0102-v1-image-metadata) | ||
|
|
||
| ## Testing Regime | ||
|
|
||
| The following regulations apply for those certifications where regular testing is required. | ||
|
|
||
| In general, automated tests (where applicable) shall be performed at least weekly. | ||
|
|
||
| - Tests for OpenStack-powered Compute may be performed less frequently, but no fewer than once a year. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| title: SCS-compatible IaaS | ||
| type: Standard | ||
| track: Scopes | ||
| status: Deprecated | ||
| stabilized_at: 2023-03-23 | ||
| deprecated_at: 2023-11-30 | ||
| replaces: | ||
| - scs-0501-v2-scs-compatible-iaas.md | ||
| description: | | ||
| The certificate scope for level SCS-compatible and layer IaaS. | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This is v2 of the certificate scope _SCS-compatible IaaS_. | ||
|
|
||
| ## Subject Matter | ||
|
|
||
| The following standards are included: | ||
|
|
||
| - OpenStack-powered Compute v2022.11 | ||
| - [scs-0100-v2: Flavor naming](https://docs.scs.community/standards/scs-0100-v2-flavor-naming) | ||
| - [scs-0102-v1: Image metadata](https://docs.scs.community/standards/scs-0102-v1-image-metadata) | ||
|
|
||
| ## Testing Regime | ||
|
|
||
| The following regulations apply for those certifications where regular testing is required. | ||
|
|
||
| In general, automated tests (where applicable) shall be performed at least weekly. | ||
|
|
||
| - Tests for OpenStack-powered Compute may be performed less frequently, but no fewer than once a year. | ||
|
|
||
| ## Version history | ||
|
|
||
| - v2 amends v1 by bumping the versions of OpenStack-powered Compute and of scs-0100. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| title: SCS-compatible IaaS | ||
| type: Standard | ||
| track: Scopes | ||
| status: Deprecated | ||
| stabilized_at: 2023-06-15 | ||
| deprecated_at: 2024-07-31 | ||
| replaces: | ||
| - scs-0501-v2-scs-compatible-iaas.md | ||
| description: | | ||
| The certificate scope for level SCS-compatible and layer IaaS. | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This is v3.1 of the certificate scope _SCS-compatible IaaS_. | ||
|
|
||
| Change log: | ||
|
|
||
| - v3.1 bumps [scs-0100-v3](https://docs.scs.community/standards/scs-0100-v3-flavor-naming) from v3.0 to v3.1 | ||
|
|
||
| ## Subject Matter | ||
|
|
||
| The following standards are included: | ||
|
|
||
| - OpenStack-powered Compute v2022.11 | ||
| - [scs-0102-v1: Image metadata](https://docs.scs.community/standards/scs-0102-v1-image-metadata) | ||
| - [scs-0100-v3: Flavor naming (v3.1)](https://docs.scs.community/standards/scs-0100-v3-flavor-naming) | ||
|
|
||
| ## Testing Regime | ||
|
|
||
| The following regulations apply for those certifications where regular testing is required. | ||
|
|
||
| In general, automated tests (where applicable) shall be performed at least weekly. | ||
|
|
||
| - Tests for OpenStack-powered Compute may be performed less frequently, but no fewer than once a year. | ||
|
|
||
| ## Previous Versions | ||
|
|
||
| - v3 amends v2 by bumping the version of scs-0100. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| title: SCS-compatible IaaS | ||
| type: Standard | ||
| track: Scopes | ||
| status: Deprecated | ||
| stabilized_at: 2024-02-28 | ||
| deprecated_at: 2025-07-01 | ||
| replaces: | ||
| - scs-0501-v3-scs-compatible-iaas.md | ||
| description: | | ||
| The certificate scope for level SCS-compatible and layer IaaS. | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This is v4 of the certificate scope _SCS-compatible IaaS_. | ||
|
|
||
| ## Subject Matter | ||
|
|
||
| Standards that were already included in v3.1: | ||
|
|
||
| - OpenStack-powered Compute v2022.11 | ||
| - [scs-0100-v3: Flavor naming (v3.1)](https://docs.scs.community/standards/scs-0100-v3-flavor-naming) | ||
| - [scs-0102-v1: Image metadata](https://docs.scs.community/standards/scs-0102-v1-image-metadata) | ||
|
|
||
| Standards new with v4: | ||
|
|
||
| - [scs-0101-v1: Entropy](https://docs.scs.community/standards/scs-0102-v1-image-metadata) | ||
| - [scs-0103-v1: Standard flavors](https://docs.scs.community/standards/scs-0103-v1-standard-flavors) | ||
| - [scs-0104-v1: Standard images](https://docs.scs.community/standards/scs-0104-v1-standard-images) with [spec file](https://raw.githubusercontent.com/SovereignCloudStack/standards/main/Tests/iaas/scs-0104-v1-images.yaml) | ||
|
|
||
| ## Testing Regime | ||
|
|
||
| The following regulations apply for those certifications where regular testing is required. | ||
|
|
||
| In general, automated tests (where applicable) shall be performed at least weekly. | ||
|
|
||
| - Tests for OpenStack-powered Compute may be performed less frequently, but no fewer than once a year. | ||
|
|
||
| ## Previous Versions | ||
|
|
||
| - v4 extends v3 by including new standards as listed above. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| title: SCS-compatible IaaS | ||
| type: Standard | ||
| track: Scopes | ||
| status: Stable | ||
| stabilized_at: 2024-12-19 | ||
| replaces: | ||
| - scs-0501-v4-scs-compatible-iaas.md | ||
| description: | | ||
| The certificate scope for level SCS-compatible and layer IaaS. | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This is v5.1 of the certificate scope _SCS-compatible IaaS_. | ||
|
jklare marked this conversation as resolved.
|
||
|
|
||
| Change log: | ||
|
|
||
| - v5.1 adds [scs-0123-v1: Mandatory and Supported IaaS Services](https://docs.scs.community/standards/scs-0123-v1-mandatory-and-supported-IaaS-services), which was intended to be included (as witnessed by the meeting minutes), but was inadvertently omitted. | ||
|
|
||
| ## Subject Matter | ||
|
|
||
| Standards that were already included in v4: | ||
|
|
||
| - [scs-0128-v1: SCS end-to-end testing (formerly OpenStack-powered Compute)](https://docs.scs.community/standards/scs-0128-v1-e2e-testing) | ||
| - [scs-0100-v3: Flavor naming (v3.1)](https://docs.scs.community/standards/scs-0100-v3-flavor-naming) | ||
| - [scs-0101-v1: Entropy](https://docs.scs.community/standards/scs-0102-v1-image-metadata) | ||
| - [scs-0102-v1: Image metadata](https://docs.scs.community/standards/scs-0102-v1-image-metadata) | ||
| - [scs-0103-v1: Standard flavors](https://docs.scs.community/standards/scs-0103-v1-standard-flavors) | ||
|
|
||
| Standards changed with v5: | ||
|
|
||
| - [scs-0104-v1: Standard images](https://docs.scs.community/standards/scs-0104-v1-standard-images) with [new spec file](https://raw.githubusercontent.com/SovereignCloudStack/standards/main/Tests/iaas/scs-0104-v1-images-v5.yaml) instead of [former spec file](https://raw.githubusercontent.com/SovereignCloudStack/standards/main/Tests/iaas/scs-0104-v1-images.yaml) | ||
|
|
||
| Standards new with v5: | ||
|
|
||
| - [scs-0114-v1: Volume Types](https://docs.scs.community/standards/scs-0114-v1-volume-type-standard) | ||
| - [scs-0115-v1: Default rules for security groups](https://docs.scs.community/standards/scs-0115-v1-default-rules-for-security-groups) | ||
| - [scs-0116-v1: Key manager](https://docs.scs.community/standards/scs-0116-v1-key-manager-standard) | ||
| - [scs-0117-v1: Volume backup](https://docs.scs.community/standards/scs-0117-v1-volume-backup-service) | ||
| - [scs-0121-v1: Availability Zones](https://docs.scs.community/standards/scs-0121-v1-Availability-Zones-Standard) | ||
| - [scs-0123-v1: Mandatory and Supported IaaS Services](https://docs.scs.community/standards/scs-0123-v1-mandatory-and-supported-IaaS-services) | ||
| - [scs-0302-v1: Domain Manager Role](https://docs.scs.community/standards/scs-0302-v1-domain-manager-role) | ||
|
|
||
| ## Testing Regime | ||
|
|
||
| The following regulations apply for those certifications where regular testing is required. | ||
|
|
||
| In general, automated tests (where applicable) shall be performed at least weekly. | ||
|
|
||
| - Tests for scs-0128-v1 may be performed less frequently, but no fewer than once a year. | ||
|
|
||
| ## Previous Versions | ||
|
|
||
| - v5 extends v4 by including new standards as listed above, | ||
| and it changes the spec for scs-0104-v1, updating standard images. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: "SCS-compatible IaaS: Testing Notes" | ||
| type: Supplement | ||
| track: Scopes | ||
| supplements: | ||
| - scs-0501-v5-scs-compatible-iaas.md | ||
| --- | ||
|
|
||
| ## Testing notes | ||
|
|
||
| See [documentation of official test suite](https://github.com/SovereignCloudStack/standards/blob/main/Tests/README.md). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: SCS-compatible KaaS | ||
| type: Standard | ||
| track: Scopes | ||
| status: Stable | ||
| stabilized_at: 2024-11-26 | ||
| description: | | ||
| The certificate scope for level SCS-compatible and layer KaaS. | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| This is v1 of the certificate scope _SCS-compatible KaaS_. | ||
|
|
||
| ## Subject Matter | ||
|
|
||
| - [scs-0201-v1: CNCF Kubernetes conformance](https://docs.scs.community/standards/scs-0201-v1-cncf-conformance) | ||
| - [scs-0210-v2: Kubernetes version policy](https://docs.scs.community/standards/scs-0210-v2-k8s-version-policy) | ||
| - [scs-0214-v2: Kubernetes node distribution and availability](https://docs.scs.community/standards/scs-0214-v2-k8s-node-distribution) | ||
| - [scs-0219-v1: KaaS networking](https://docs.scs.community/standards/scs-0219-v1-kaas-networking) | ||
|
|
||
| ## Testing Regime | ||
|
|
||
| The following regulations apply for those certifications where regular testing is required. | ||
|
|
||
| In general, automated tests (where applicable) shall be performed at least weekly. | ||
|
|
||
| - Tests for scs-0210-v2 shall be performed daily. | ||
| - Tests for scs-0201-v1 and scs-0219-v1 may be performed less frequently, but no fewer than once a year. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: "SCS-compatible KaaS: Testing Notes" | ||
| type: Supplement | ||
| track: Scopes | ||
| supplements: | ||
| - scs-0502-v1-scs-compatible-kaas.md | ||
| --- | ||
|
|
||
| ## Testing notes | ||
|
|
||
| See [documentation of official test suite](https://github.com/SovereignCloudStack/standards/blob/main/Tests/README.md). |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.