-
Notifications
You must be signed in to change notification settings - Fork 106
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
update documentation to include installation with in-cluster prometheus in openshift #1144
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this!
install-and-configure/install/provider-installations/openshift-kubecost-install.md
Outdated
Show resolved
Hide resolved
c6f74a6
to
a51bff8
Compare
Are all comments resolved? If so, please resolve. |
install-and-configure/install/provider-installations/openshift-kubecost-install.md
Outdated
Show resolved
Hide resolved
@@ -42,7 +42,7 @@ Install Kubecost using OpenShift specific values. Note that the below command fe | |||
|
|||
```sh | |||
helm upgrade --install kubecost kubecost/cost-analyzer -n kubecost --create-namespace \ | |||
-f https://raw.githubusercontent.com/kubecost/cost-analyzer-helm-chart/develop/cost-analyzer/values-openshift.yaml | |||
-f https://raw.githubusercontent.com/kubecost/cost-analyzer-helm-chart/<$VERSION>/cost-analyzer/values-openshift.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The drawback to doing this is that now this link will no longer be checked by the CI's link-checker. What happens if we someday decide to rename or delete values-openshift.yaml
?
Although referencing develop
branch comes with drawbacks, I still think it's more valuable than putting <$VERSION>
here. @mittal-ishaan @chipzoller thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can use develop. But we can also start with having versions. like v2.5
and then update docs when every new minor or major version gets released.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thomasvn, the problem here with listing files from the develop
branch is we put users in a precarious and potentially unsupported position when they install a versioned release but use a values file which doesn't correspond to that release. We really need to get away from that practice entirely when we're talking about our official docs. Rather than putting in a placeholder like <$VERSION>
we should make this the same as the version referenced by the docs. For example, if users are reading version 2.5 of our docs then any files that are associated with that release should be pointed to the v2.5
branch. This obviously means that any new files that get referenced are "released" in that branch.
install-and-configure/install/provider-installations/openshift-kubecost-install.md
Show resolved
Hide resolved
Co-authored-by: Thomas Nguyen <thomasn@kubecost.com>
Related Issue
Proposed Changes
This PR adds the documentation for installing kubecost in openshift clusters without having the bundled prometheus but using the in-cluster prometheus.
Depends upon:
opencost/opencost#2944
kubecost/cost-analyzer-helm-chart#3700