SovereignCloudStack / standards

SCS standards in a machine readable format
https://scs.community/
Creative Commons Attribution Share Alike 4.0 International
30 stars 21 forks source link

Make yaml file location more explicit and more user friendly #536

Closed mbuechse closed 3 months ago

mbuechse commented 3 months ago

This is related to #534 -- not yet a solution, but a significant improvement from my point of view.

markus-hentsch commented 3 months ago

Thanks for getting this started!

I'm currently pondering how we could communicate the scope of the standard and implications for CSPs more clearly. I'm currently thinking of something along the lines of:

Note that this standard primarily defines the standardization process for images resulting in the YAML descriptions. To achieve conformance with the standard, a CSP has to provision images as per the currently valid YAML resulting from this standard provided by SCS at a particular time. Due to the more short-lived nature of image releases, the actual YAML that specifies the images is regularly updated and therefore not a direct part of this standard document.

A CSP may retrieve the currently valid YAML at any time from https://github.com/SovereignCloudStack/standards/blob/main/Tests/iaas/

... and putting this section somewhere where it makes sense and is easily discoverable by a reader who is interested in how to apply the standard.

mbuechse commented 3 months ago

@markus-hentsch I agree with the general direction, yet I'm puzzled as to where to put such a paragraph, and we can also debate about the correctness of it:

To achieve conformance with the standard, a CSP has to provision images as per the currently valid YAML

I'm not sure that this is true. I think this is a real "hole" in the standard. The standard makes assertions such as the following (and I quote):

If the status is mandatory, then the image MUST be present.

The following premise is NOT stated:

And, worse, what is not stated either: that of course we assume that this premise is true.

And without all that, your suggestion doesn't work. I will think of something, but in the meantime, it would be good to get this tiny improvement into main. Note that this PR will NOT close the issue #534, and deliberately so.

edit the issue is of course #534

markus-hentsch commented 3 months ago

@markus-hentsch I agree with the general direction, yet I'm puzzled as to where to put such a paragraph, and we can also debate about the correctness of it:

To achieve conformance with the standard, a CSP has to provision images as per the currently valid YAML

I'm not sure that this is true. I think this is a real "hole" in the standard. The standard makes assertions such as the following (and I quote):

If the status is mandatory, then the image MUST be present.

The following premise is NOT stated:

* a YAML file is given

* a cloud environment is given

* we interpret this YAML file with respect to this cloud environment.

And, worse, what is not stated either: that of course we assume that this premise is true.

And without all that, your suggestion doesn't work. I will think of something, but in the meantime, it would be good to get this tiny improvement into main. Note that this PR will NOT close the issue #536, and deliberately so.

Interesting perspective. I will need to think about this for a bit. I was not involved in the creation of the standard so I approached it from a totally different angle. But I agree, let's take this back into the issue and focus on fixing the existing reference here.