Add text discussing the approach to flavors. #121
Merged
Conversation
This file contains 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
In short, the naming proposal serves two purposes. (1) Provide transparency on features/details/capabilities (2) Allow users to chose the right features There is not really good alternative for (2) to create names. We have chosen a systematic approach to it, which allows to generate/parse this programmatically (and manually if you are familiar with the spec), but which can lead to rather complex names in extreme cases. To only achieve (1), better ways exist by using metadata (extra_specs). So smaller providers that don't need users to chose between so many flavors don't need to encode all the details in the name, but could use short names (which is allowed by the spec) and make details discoverable via a to-be-written metadata spec. This is the suggested approach going forward. Signed-off-by: Kurt Garloff <kurt@garloff.de>
garloff
requested review from
osfrickler,
frosty-geek,
fkr,
jnull and
matfechner
|
Rendered text can be reviewed here: https://github.com/SovereignCloudStack/Docs/blob/feat/flavor-naming-strategy/Design-Docs/flavor-naming-strategy.md |
fkr
reviewed
Sep 16, 2022
|
|
||
| You can also use the interactive mode `-i` to construct flavor names. | ||
|
|
||
| If you dislike the hazzle of parsing the names, you may want to consider them |
fkr
approved these changes
Sep 16, 2022
|
Further note: Thanks @garloff for writing this up! 🚀 |
Signed-off-by: Kurt Garloff <kurt@garloff.de>
... and add pointer to gx-self-description-generator. Signed-off-by: Kurt Garloff <kurt@garloff.de>
frosty-geek
pushed a commit
to frosty-geek/SCS-Docs
that referenced
this pull request
Sep 26, 2022
* Create status page comparison.md Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> * (see SovereignCloudStack#121) - move "status page comparison" to new folder Decisions - update file name to a name without whitespaces Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> Co-authored-by: Benjamin Zapiec <zcbn9343@largo.intranet.gonicus.de>
frosty-geek
pushed a commit
to frosty-geek/SCS-Docs
that referenced
this pull request
Sep 26, 2022
* Create status page comparison.md Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> * (see SovereignCloudStack#121) - move "status page comparison" to new folder Decisions - update file name to a name without whitespaces Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> * (see SovereignCloudStack#121) add statusfy to the matrix Signed-off-by: Benjamin Zapiec <zcbn9343@largo.intranet.gonicus.de> Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> Signed-off-by: Benjamin Zapiec <zcbn9343@largo.intranet.gonicus.de> Signed-off-by: Felix Kronlage-Dammers <fkr@hazardous.org> Co-authored-by: Benjamin Zapiec <zcbn9343@largo.intranet.gonicus.de> Co-authored-by: Felix Kronlage-Dammers <fkr@hazardous.org>
frosty-geek
pushed a commit
to frosty-geek/SCS-Docs
that referenced
this pull request
Sep 26, 2022
* Create status page comparison.md Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> * (see SovereignCloudStack#121) - move "status page comparison" to new folder Decisions - update file name to a name without whitespaces Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> * (see SovereignCloudStack#121) add statusfy to the matrix Signed-off-by: Benjamin Zapiec <zcbn9343@largo.intranet.gonicus.de> Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> * Add project URL or github link Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> Signed-off-by: Benjamin <2255421+master-caster@users.noreply.github.com> Signed-off-by: Benjamin Zapiec <zcbn9343@largo.intranet.gonicus.de> Signed-off-by: Felix Kronlage-Dammers <fkr@hazardous.org> Co-authored-by: Benjamin Zapiec <zcbn9343@largo.intranet.gonicus.de> Co-authored-by: Felix Kronlage-Dammers <fkr@hazardous.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In short, the naming proposal serves two purposes. (1) Provide transparency on features/details/capabilities (2) Allow users to chose the right features
There is not really good alternative for (2) to create names. We have chosen a systematic approach to it, which allows to generate/parse this programmatically (and manually if you are familiar with the spec), but which can lead to rather complex names in extreme cases.
To only achieve (1), better ways exist by using metadata (extra_specs). So smaller providers that don't need users to chose between so many flavors don't need to encode all the details in the name, but could use short names (which is allowed by the spec) and make details discoverable via a to-be-written metadata spec. This is the suggested approach going forward.
This is an attempt to address #73.
Signed-off-by: Kurt Garloff kurt@garloff.de