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

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

Merged
merged 1 commit into from
Mar 22, 2024

Conversation

mbuechse
Copy link
Contributor

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

@mbuechse mbuechse requested a review from markus-hentsch March 22, 2024 09:42
@markus-hentsch
Copy link
Contributor

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
Copy link
Contributor Author

mbuechse commented Mar 22, 2024

@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 #534, and deliberately so.

edit the issue is of course #534

@markus-hentsch
Copy link
Contributor

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

@mbuechse mbuechse merged commit 8b8cf75 into main Mar 22, 2024
5 of 6 checks passed
@mbuechse mbuechse deleted the issue/534 branch March 22, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants