Skip to content
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

Feat/add certification process2 #253

Open
wants to merge 26 commits into
base: main
Choose a base branch
from

Conversation

garloff
Copy link
Member

@garloff garloff commented Sep 24, 2024

Explain SCS DigiSov and Certs. How to get into compliance.

- Explain the motivation for the SCS certification levels rooted in
  the levels of digital sovereignty.
- Give a practical example how to achieve the SCS certification by
  running the tests.
- Hints on how to get listed, why we have the HM there and how to
  react to failed runs.

- Explain the motivation for the SCS certification levels rooted in
  the levels of digital sovereignty.
- Give a practical example how to achieve the SCS certification by
  running the tests.
- Hints on how to get listed, why we have the HM there and how to
  react to failed runs.

Signed-off-by: Kurt Garloff <[email protected]>
Signed-off-by: Kurt Garloff <[email protected]>
@garloff garloff added documentation Improvements or additions to documentation standards Issues / ADR / pull requests relevant for standardization & certification labels Sep 24, 2024
@garloff garloff self-assigned this Sep 24, 2024
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Copy link
Member Author

garloff commented Sep 24, 2024

Note that I have pushed the changes to the staging branch, so we should see the results in https://docs-staging.scs.community/ in a few minutes.

@garloff
Copy link
Member Author

garloff commented Sep 25, 2024

This one supercedes PR #251.

Please review the end results, I unfortunately went through some trial and error for getting docusaurus to do what I need.

Note that the Markdownlint check fails with or without this patch. It barfs on the generated index files, not sure whether the generation process can be tweaked or whether we'd need to filter things out for that check. In any case, that's unrelated to the contribution from this PR.

Copy link
Member

@maxwolfs maxwolfs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall. Just two things:

  1. Adjust sidebar item titles

I suggest to shorten the sidebar item texts to keep them one liners for better readability such as:

  • From Getting SCS-compatible certification (for operators) to Certification Process or Getting Certified
  • From Example testing and adjustment for SCS IaaS-compatible compliance to Testing Compliance' or Compliance Testing`
  • From Compliant cloud environments overview to 'Compliant Clouds'
  1. Move "The taxonomy of digital sovereignty" from Certification Overview Page

Starting with a short introduction and the list of scs certification levels helps engage visitors, reducing the chance of overwhelming with too much text at in the beginning. Introduction sentence could be:

The SCS certification levels build upon the concept of digital sovereignty, categorizing various degrees of control and transparency for cloud services.

Comment on lines 55 to 59
Members of the OSBA can become also member of the Forum SCS-Standards for an additional membership
fee, providing the financial resources for the Forum to do its work. Membership in the OSBA is
open to any organization that supports the goals of the OSBA.
Alternatively, a certification fee can be paid without any membership; the fee corresponds to the
lower tier membership fee.
Copy link
Member

@fkr fkr Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment applies in the same way as the other: IF this is not the leading document on this matter:

Please don't place infos at arbitrary locations that might then be outdated. I think, it makes sense to point here to the forum but I would refrain from making statements regarding fees since this will lead to be errors on the long run.

Comment on lines 5 to 15
As published in [DuD](https://rdcu.be/cWdBJ) (German, English version in
[the cloud report](https://the-report.cloud/why-digital-sovereignty-is-more-than-mere-legal-compliance/))
and being summarized nicely in a [cloudahead article](https://www.cloudahead.de/der-freiheitskampf-des-sovereign-cloud-stacks),
we differentiate between several levels of digital sovereignty.
We'll skip stage 0, introduced by Gregor Schuhmacher in his description, which
specifies using a cloud at all as the pre-step to be taken. This has relevance,
as some companies continue to call solutions that are not on-demand, not
self-service API driven, not metered
(see [NIST definition of cloud](https://nvlpubs.nist.gov/nistpubs/legacy/sp/nistspecialpublication800-145.pdf))
to be (private) clouds. We talk about real clouds, where deployment of infrastructure
is API-driven, unlocking DevOps teams productivity.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest a different style here:

I think this is a very good place to define our taxonomy and reflect upon it.
I think it is also good to point to the DuD, cloudical and cloudahead articles - however I would not dive into "We'll skip stage 0, introduced by Gregor Schuhmacher in his description, which
specifies using a cloud at all as the pre-step to be taken. This has relevance," because with that you mix the styles. While we're in the process of a (more or less) formal definition, you here fall into a conversational style.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, good observation. Will fix.

to be (private) clouds. We talk about real clouds, where deployment of infrastructure
is API-driven, unlocking DevOps teams productivity.

The levels as seen by the SCS movement are:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The levels as seen by the SCS movement are:
The levels as seen by the SCS movement are:

why is the term 'SCS movement' suddendly introduced? We're not a SCS project or community anymore?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, should be SCS project (and in the future maybe Forum SCS-Standards),

Comment on lines 17 to 19
3. The operator must be a member ("shaper" or "advisor" level) of the Forum SCS-Standards in the
OSB Alliance (a non-profit) and pay the respective membership fees. Alternatively fees can
be paid without becoming a member.
Copy link
Member

@fkr fkr Sep 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like in my other comment, I would recommend to not hardcode the conditions here unless this becomes the leading document for this. IF this becomes the leading document for this, this should be the place where also the forum then needs to update stuff if things change.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, we'd have a preliminary Forum Page that we can point to already.
The other option is to sketch the forum conditions here and then remove it as soon as we have the page that we can point to.
Fortunately, the content is not controversial, as this has all been agreed up already thanks to your and Dirk's great work.

Comment on lines 84 to 86
have a health monitor running (currently still
[openstack-health-monitor](https://docs.scs.community/docs/operating-scs/guides/openstack-health-monitor/Debian12-Install)
but soon the new [health-monitor](https://scs.community/tech/2024/09/06/vp12-scs-health-monitor-tech-preview/)),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is not good practice to talk about future plans in such a document. Document the "as is" case and update if the "as is" case changes.

garloff and others added 2 commits September 30, 2024 12:00
As suggested by @fkr.

Co-authored-by: Felix Kronlage-Dammers <[email protected]>
Signed-off-by: Kurt Garloff <[email protected]>
Co-authored-by: Felix Kronlage-Dammers <[email protected]>
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Copy link
Member Author

garloff commented Sep 30, 2024

  • From Compliant cloud environments overview to 'Compliant Clouds'

This page was called overview before and the document's name is still overview (and should stay so, as it is linked to from various places). That's why I kept the word "overview" in the title. A compromise could be 'Compliant Clouds overview' to keep the relation with the link name.

@garloff
Copy link
Member Author

garloff commented Sep 30, 2024

3. Move "The taxonomy of digital sovereignty" from Certification Overview Page

Starting with a short introduction and the list of scs certification levels helps engage visitors, reducing the chance of overwhelming with too much text at in the beginning. Introduction sentence could be:

Agreed. While I think we should explain how our understanding of digital sovereignty drives the levels of SCS certification, not everyone wants to read through it, so splitting out additional background info into a separate page makes sense.

@garloff
Copy link
Member Author

garloff commented Sep 30, 2024

I suggest to shorten the sidebar item texts to keep them one liners for better readability such as:

* From `Getting SCS-compatible certification (for operators)` to `Certification Process` or `Getting Certified`

* From `Example testing and adjustment for SCS IaaS-compatible compliance` to `Testing Compliance' or `Compliance Testing`

* From `Compliant cloud environments overview` to 'Compliant Clouds'

Do I need to change the titles in the pages? Or is there a straight-forward way to do it in sidebarStandards.js?

Copy link
Contributor

@mbuechse mbuechse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I am in a position right now to really review this.

Just a few observations:

  • The "welcome page" (top-level page) regarding certification is now a big wall of text. I wouldn't bother to read all of that or try to find the things that interest me. I suggest to make the welcome page quite short and just provide a big-picture overview (2--3 paragraphs) plus a list of links to the pages about specific topics for those who are interested.
  • The "Getting certification" page repeats the (authoritative) standard scs-0004-v1. It may be warranted to translate the standard into a more accessible language, but (a) I would be prefer to have the standard accessible as-is, and (b) the redundancy is a flood-gate for divergence and contradictions. There is a reason why I merely linked to the standard.
  • The example page is great, but I would make that a blog article and then link to the blog article from the welcome page. To me, the example shows that the scripts are still too cumbersome. For instance, why do we need -V v4? Also, we could use scs-test-runner.py, whose CLI syntax is simpler, but that one immediately sends the report to the compliance monitor (because we don't want to make cherry-picking results a thing).

@garloff
Copy link
Member Author

garloff commented Oct 4, 2024

Just a few observations:

  • The "welcome page" (top-level page) regarding certification is now a big wall of text. I wouldn't bother to read all of that or try to find the things that interest me. I suggest to make the welcome page quite short and just provide a big-picture overview (2--3 paragraphs) plus a list of links to the pages about specific topics for those who are interested.

Did you have a look after e23e99c ?
I tried to address this, as Max had pointed this out as well and I agree.

@garloff
Copy link
Member Author

garloff commented Oct 4, 2024

  • The "Getting certification" page repeats the (authoritative) standard scs-0004-v1. It may be warranted to translate the standard into a more accessible language, but (a) I would be prefer to have the standard accessible as-is, and (b) the redundancy is a flood-gate for divergence and contradictions. There is a reason why I merely linked to the standard.

  • The example page is great, but I would make that a blog article and then link to the blog article from the welcome page. To me, the example shows that the scripts are still too cumbersome. For instance, why do we need -V v4? Also, we could use scs-test-runner.py, whose CLI syntax is simpler, but that one immediately sends the report to the compliance monitor (because we don't want to make cherry-picking results a thing).

Hmmm, I wanted to write a blog article first and then opted for improving the documentation.
So, maybe we do the following:

  • Keep the new intro (after e23e99c !) in the docs, hiding the wall of text (explanation of DigiSov) in a separate page.
  • We have another look at scs-0004 and check whether it can be made easier to read
  • Move the example into the blog article -- additional hints on how to get certification could probably be added there if they don't fit into scs-0004.

Thoughts?

garloff and others added 6 commits October 4, 2024 07:41
Signed-off-by: Kurt Garloff <[email protected]>
This follows the suggestions from the discussion on PR #523.
- Rather than having an independent description of what scs-0004-v1
  means in practice, let's have it as implementation notes, making
  it easier to keep things aligned.
- The example fits better into a blog format.

Signed-off-by: Kurt Garloff <[email protected]>
Copy link
Member

@maxwolfs maxwolfs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@garloff
Copy link
Member Author

garloff commented Oct 13, 2024

PR for blog article still has to be done (cloning the website repo takes ages over satellite internet).
PR for standards is in SovereignCloudStack/standards#781

@garloff
Copy link
Member Author

garloff commented Oct 14, 2024

The PRfor the blog article SovereignCloudStack/website#1029

Comment on lines +43 to +44
page. An example with technical testing and adjustments is on the
[Testing and Adjustment example](test-and-adapt-example) page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this page still a thing?

Comment on lines +93 to +94
The technical compatibility validation corresponding to the *SCS-compatible* certification does
exist since more than a year. There are certificates for two layers of the SCS architecture
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The technical compatibility validation corresponding to the *SCS-compatible* certification does
exist since more than a year. There are certificates for two layers of the SCS architecture
The technical compatibility validation corresponding to the *SCS-compatible* certification has
existed for more than a year. There are certificates for two layers of the SCS architecture

better yet (insert correct date)

Suggested change
The technical compatibility validation corresponding to the *SCS-compatible* certification does
exist since more than a year. There are certificates for two layers of the SCS architecture
The technical compatibility validation corresponding to the *SCS-compatible* certification has
existed since 2023. There are certificates for two layers of the SCS architecture

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation standards Issues / ADR / pull requests relevant for standardization & certification
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

4 participants