search

dodevops / cloudcontrol

The cloud engineer's toolbox ☁️ 🧰
MIT License
17 stars 4 forks source link

feat: Added CA-Certificates #157

Closed dploeger closed 1 week ago

dploeger commented 1 month ago

This is a replacement of certificates, which is deprecated with this.

Includes a feature to set a deprecation in the docs and adds a little not to prefer the FEATURES variable over the USE_ variable.

Fixes #133

dploeger commented 1 month ago

Not a good idea to mix two things in your PR, but since you did i will refer to the second thing you changed: the USE_ not-recommendations: First it also should be hinted in the FEATURES section: https://github.com/dodevops/cloudcontrol?tab=readme-ov-file#configuring-features. Second, the <SOMETHING>_VERSION are still marked as required, but can be given in the FEATURES variable as well. Third we should describe why it is recommended to use FEATURES: Either we deprecated USE_ and remove it later, or we leave both options, but then there is no point in recommend FEATURES other than it is shorter than USE_ and we should exactly tell that then.

I would not deprecate it as the USE_ way can help with automations (like it is used in the test suite currently). Let me rephrase it.

dploeger commented 1 month ago

Where do you see that _VERSION is marked as required?

timdeluxe commented 4 weeks ago

Where do you see that _VERSION is marked as required?

Just search for the string "(required)" in the (generated) docs, you'll find plenty of them. Example:

Environment HELM_VERSION (required): Valid Helm version to install (e.g. 1.5.4)

dploeger commented 4 weeks ago

Where do you see that _VERSION is marked as required?

Just search for the string "(required)" in the (generated) docs, you'll find plenty of them. Example:

Environment HELM_VERSION (required): Valid Helm version to install (e.g. 1.5.4)

Ahhh, thaaat's what you mean. Okay. We need to make clear, that a version is required for these features. Either through FEATURES or _VERSION. I'll take care of it.

dploeger commented 3 weeks ago

I have now made the requirement for a version expressive in the feature descriptor and have adapted the documentation generator. Please take a look.

timdeluxe commented 3 weeks ago

Better but it now misses, that the versions are required. Proposal would be to make it like this:

VELERO_VERSION (required): Version to install (or use the FEATURES variable instead)

Or like this:

VELERO_VERSION: Version to install (or use the FEATURES variable instead) - required

I prefer the first one, even it is slightly confusing that the _VERSION variable is displayed as required, while it can be as well done through the FEATURES variable. However i think when someone first time uses the FEATURES variable, he/she will get the concept and can extrapolate enough...

dploeger commented 3 weeks ago

Implemented the first one.