Pre-install hook for helm #176
Conversation
maimaisie
requested review from
frankreno,
rvmiller89,
samjsong and
lei-sumo
| ## Setup | ||
|
|
||
| # If enabled, a pre-install hook will create Collector and Sources in Sumo Logic | ||
| setupEnabled: true |
There was a problem hiding this comment.
should we make the default false since we comment out the values below?
There was a problem hiding this comment.
We are commenting out access id, key and endpoint because they are required values with no defaults. When we reference them here , we use the required function so that if user does not override this value on helm install it will error out. For example:
$ helm install maisie-charts/sumologic --name collection --namespace sumologic --no-crd-hook
Error: render error in "sumologic/templates/setup-job.yaml": template: sumologic/templates/setup-job.yaml:28:14: executing "sumologic/templates/setup-job.yaml" at <required "A valid .Values.sumologic.endpoint entry required!" .Values.sumologic.endpoint>: error calling required: A valid .Values.sumologic.endpoint entry required!
The collector name is commented out because the script has the default value, so we don't need to specify it again here
deploy/helm/sumologic/values.yaml
Outdated
| @@ -253,7 +273,7 @@ prometheus-operator: | |||
| prometheusSpec: | |||
| externalLabels: | |||
| # Set this to a value to distinguish between different k8s clusters | |||
| cluster: kubernetes | |||
| cluster: *cluster_name | |||
There was a problem hiding this comment.
this is called an anchor used to reference a value in YAMLs. so *cluster_name will look for &cluster_name and take whatever value &cluster_name has
There was a problem hiding this comment.
found out this won't work if it's overriden in helm install, it still gets the default value kubernetes instead of the user-supplied value... I have remove the anchor from values.yaml. If user needs to use a different cluster name, they need to set two things
--set sumologic.clusterName="test-cluster"
--set prometheus-operator.prometheus.prometheusSpec.externalLabels.cluster="test-cluster"
this is not ideal, but @frankreno do you think it's acceptable for GA?
|
I think the CI has a bug, it's thinking I have manual changes in some generated files |
| {{- end }} | ||
| "-d", "false", | ||
| "-y", "false", | ||
| '{{ required "A valid .Values.sumologic.endpoint entry required!" .Values.sumologic.endpoint }}', |
There was a problem hiding this comment.
What are your thoughts on instead of using the full URL, we let the customer specify the deployment name (e.g. US2)? We then do a conditional block rendering the right URL based on what they selected and can fail if they make an invalid choice. This makes it easier for people, other various open-source Sumo projects work with this way. We have to occasionally update that as we add new deployments, but that seems minor.
There was a problem hiding this comment.
It will be more maintenance work and I think we generally try to avoid it because it's easily forgotten. What are your thoughts on this @lei-sumo @samjsong @rvmiller89 ?
There was a problem hiding this comment.
I'm fine with documenting it in our steps for now.
deploy/docker/Dockerfile
Outdated
| && apt-get install -y wget | ||
|
|
||
| # Install kubectl | ||
| ADD https://storage.googleapis.com/kubernetes-release/release/v1.6.12/bin/linux/amd64/kubectl /usr/local/bin/kubectl |
There was a problem hiding this comment.
updated to 1.15.0 according to their doc page
Description
Adds a helm pre-install hook that runs the setup script as a job. Currently the container is built from a separate image than our fluentd one. I will look into ways to use the same
Testing performed