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

"Helm configuration file" vs "Configuration file" terms #231

Open
bwestover opened this issue Oct 12, 2022 · 2 comments
Open

"Helm configuration file" vs "Configuration file" terms #231

bwestover opened this issue Oct 12, 2022 · 2 comments

Comments

@bwestover
Copy link

👋 - This might be just my confusion, but it seemed valuable to capture in case it was helpful 😊

When I am deploying Okteto, according to https://www.okteto.com/docs/self-hosted/install/deployment/ (or perhaps one of the Cloud Provider Guides) I'm seeing the term "Configuration file". In the cloud guides it might also be "Okteto GKE configuration file" or "Okteto EKS configuration file"

In the next step, I use Helm and I specify this file. It is (I believe a "Helm configuration file"), but that wasn't obvious to me at first. I thought it was a specific "okteto" file.

Where I got really confused is when I was told to "...add the following to your Helm configuration file..." (ref) I wasn't sure if my "Helm configuration file" was in fact the same file I used to install Okteto in the first place, or something else? 😅

It's also mentioned in a few other spots, sometimes referred to as "config.yaml", but I'm pretty sure it's the same thing.

Would it be possible to use a more consistent term for this file, and perhaps always link back to a single place that explains it?

@rberrelleza
Copy link
Member

This is great feedback @bwestover I agree. What do you think would be the best term to use? Do you thing referring to it as the values.yaml file would be enough?

@bwestover
Copy link
Author

What do you think would be the best term to use?

Hard to say, because a lot depends on whether someone knows Helm well enough to automatically hear values.yml and think "Helm configuration". There is also the issue of this being "the Helm configuration, for the Okteto Helm chart".

Do you thing referring to it as the values.yaml file would be enough?

Probably not, especially because it's also called "config.yml" (or config.yaml) in a few spots:
image

I think this file, which is a Helm configuration file for the Okteto Helm chart (and can be called anything you want) might deserve it's own reference page. That would give you some space to explain the relationship between Helm, Okteto and the values.yml configuration file. It would also give you something to link back to whenever you used the terms "Helm configuration file" or "Okteto configuration file" or whatever.

Hope that helps.

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

No branches or pull requests

2 participants