feat(launchpad): added examples on how to use charts with helmfile #96
Conversation
docs/launchpad/quick-start.md
Outdated
| #### (optional, arbitrum-sepolia) Install Arbitrum Nitro and Proxyd for Arbitrum Sepolia | ||
|
|
||
| The following `helmfile.yaml` is an example of the full config needed to deploy Arbitrum Nitro on the Arbitrum Sepolia network: |
There was a problem hiding this comment.
Shouldn't we recommend our Launchpad NS for Arbitrum?
docs/launchpad/quick-start.md
Outdated
| ### Prerequisites | ||
|
|
||
| Ensure you have[helm](https://github.com/helm/helm) and [helmfile](https://github.com/helmfile/helmfile) installed on your local machine. This guide assumes familiarity with basic Helm and Helmfile operations. |
There was a problem hiding this comment.
Occurred to me that we already have more detailed info on the requirements on these parts elsewhere (maybe on launchpad-charts and launchpad-namespaces git repos, as well as launchpad-starter). It does not only come down to helm + helmfile.. for instance helmfile comes as a requirement to Namespaces which then would also require kustomize, and the helm-diff plaugin. Otoh I don't think it will serve us well to repeat these lists of requirements in multiple places as they are liable to change and that would make them harder to maintain and keep in sync. Maybe we should just link to the Git md's? or alternatively we copy/paste them to a Prerequisites page and then we link to it, making it so that we know it's centralized on a single place in the docs (and for the future we would look into automating keeping that in sync with the git repos).
docs/launchpad/quick-start.md
Outdated
| #### Key Consideration | ||
|
|
||
| Core Services: Ensure that core services like Prometheus, Grafana, Ingress, Secret Management and Storage are properly set up as they are crucial for monitoring and managing traffic to and from your applications. |
There was a problem hiding this comment.
On the context of using helm charts directly, this "core services" list seems quite Launchpad Namespaces inspired, while I think it should be more tailored to "what do our charts actually may have an hard requirement on?".
So I think this should be replaced by mentioning those potential or mandatory requirements and their context like:
"Some of our charts assume prometheus-operator availability so... ServiceMonitors etc will fail"
"Some of our charts assume postgres-operator availability so... Postgresql CRD will fail"
"Some of our charts leverage common kubernetes core service extensions like Ingress"
afaik we have no usage of "Secret Management" in our charts, and while we do have defaults that assume openEBS, they are overridable and specifying storageClass is kind of an expect thing to do so I wouldn't mention those.
Co-authored-by: cjorge-graphops <128147788+cjorge-graphops@users.noreply.github.com>
No description provided.