microsoft / bedrock

Automation for Production Kubernetes Clusters with a GitOps Workflow
MIT License
129 stars 12 forks source link

Create fab definition for dashboard #1172

Open samiyaakhtar opened 4 years ago

samiyaakhtar commented 4 years ago

As a: developer

I want: dashboard helm chart to be included in the default HLD created by spk

So that: the dashboard is already present on the cluster

Describe the solution you'd like: Post completion of https://github.com/microsoft/bedrock/issues/967, it would be ideal for users of bedrock to not have to manually setup the dashboard in their cluster. However, some thinking is needed around how env vars would be passed in to the helm install command (for the vars needed by dashboard) during manifest generation or fab generate, since these env vars have secrets that are not written in the chart's values.yaml.

Acceptance Criteria: Dashboard is easy to setup on the cluster

Describe alternatives you've considered: Manually install via helm chart

Additional context:

Does this require updates to documentation?: Yes

andrebriggs commented 4 years ago

@samiyaakhtar I think there should be an option to enable/disable this. Maybe by default it is not included but if a user adds the flag --dashboard to the spk hld init command then this feature will be enabled.

  1. So spk hld init --dashboard will add a reference to Spektate when the user sets up the HLD.
  2. This method is idempotent so if the Spektate dashboard exists in the HLD no change will happen.

Thoughts? cc @mtarng