kinvolk / lokomotive

🪦 DISCONTINUED Further Lokomotive development has been discontinued. Lokomotive is a 100% open-source, easy to use and secure Kubernetes distribution from the volks at Kinvolk
https://kinvolk.io/lokomotive-kubernetes/
Apache License 2.0
321 stars 49 forks source link

docs/components: Resolve "cyclic dependency" with Rook/Ceph and Prometheus Operator #1025

Open johananl opened 4 years ago

johananl commented 4 years ago

Our monitoring howto guide specifies Rook/Ceph (or OpenEBS) as a requirement.

The Rook/Ceph howto guide specifies Prometheus operator as a requirement.

We should figure out a way to make it clear to the user which order to deploy the components in.

invidian commented 4 years ago

@johananl did you also configure prometheus-operator component?

johananl commented 4 years ago

I was following https://github.com/kinvolk/lokomotive/blob/master/docs/how-to-guides/monitoring-with-prometheus-operator.md which pointed me to https://github.com/kinvolk/lokomotive/blob/master/docs/how-to-guides/rook-ceph-storage.md which told me to do the steps described above.

I now see the following:

NOTE: Deploy the prometheus-operator component before. For more information follow this doc.

So we have a "cyclic dependency" in the docs then. I'll leave this tagged as a bug and change it to a docs-related issue.

invidian commented 4 years ago

@johananl if we fix docs, can we close this issue? We already have https://github.com/kinvolk/lokomotive/issues/750 about the dependencies.

johananl commented 4 years ago

Yes, I'm fine with either solving the technical issue or explaining the limitation (i.e. the users need some sort of a solution, even if it's manual for now).