Merge pull request #4 from scalyr/cherrypick_changes

Cherry pick missing changes

Author: Kami

.github/workflows/release.yml

@@ -46,6 +46,15 @@ jobs:
         with:
           charts_dir: charts
 
+      - name: Write latest stable version to info.json file
+        run: |
+          # We write latest stable version info to JSON file which we can query for displaying
+          # badge in the readme
+          CHART_VERSION=$(cat charts/scalyr-agent/Chart.yaml | grep "version: " | sed "s/version: //g" | tr -d "\n")
+          echo '{"scalyrAgent": "v'${CHART_VERSION}'"}' > info.json
+          git add info.json
+          git push origin gh-pages
+
       - name: Notify Slack on Failure
         # NOTE: github.ref is set to pr ref (and not branch name, e.g. refs/pull/28/merge) for pull
         # requests and that's why we need this special conditional and check for github.head_ref in

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 For actual scalyr agent changelog, please see https://github.com/scalyr/scalyr-agent-2/blob/master/CHANGELOG.md.
 
+## 0.2.5
+
+- Update NOTES file to print information on how to retrieve agent pod logs after helm chart
+  installation.
+- Add agent liveness probe which utilizes ``scalyr-agent status -H`` command.
+- Kubelet CA verification has been enabled by default. If you want to disable it, you can set
+  ``k8s.verifyKubeletQueries`` config option to ``false``.
+- Chart installation will now fail early if ``scalyr.config`` entry value contains a string value
+  which is not correctly base64 encoded.
+
 ## 0.2.4
 
 - Scalyr agent has been updated to v2.1.24.

README.md

@@ -95,6 +95,38 @@ If you'd like to create a different Scalyr agent, you can set `controllerType` t
 | volumeMounts | object | `{}` | Additional volume mounts to set up |
 | volumes | object | `{}` | Additional volumes to mount |
 
+## Setting Custom Scalyr Agent Config Options
+
+If you want to configure additional Scalyr Agent configuration options which are not exposed
+directly via dedicated values file options, you can utilize ``scalyr.config`` values file option.
+
+This config option allows you to define additional scalyr agent JSON config file fragments which
+are read and parsed by the agent.
+
+Since Helm is not able to correctly pass JSON strings as YAML key values, you should base64 JSON
+config fragment value as shown below.
+
+For example, let's say your custom config fragment lives in ``ci/examples/agent.d/my-config.json``.
+
+1. Obtain base64 encoded version of the JSON file content
+
+```bash
+cat ci/examples/agent.d/my-config.json| sed -e 's/^ *//' | tr -d '\n' | base64
+```
+
+To avoid any YAML formatting issues, we also utilize ``sed`` and ``tr`` command to fold multi line
+JSON into a single line
+
+2. After you updated the base64 encoded value, update your values file
+
+```yaml
+scalyr:
+  apiKey: "REPLACE_ME"
+  base64Config: true
+  config:
+    my-config.json: eyJtYXhfbG9nX29mZnNldF9zaXplIjogNTI0Mjg4MCwiZGVidWdfbGV2ZWwiOiA1fQ==
+```
+
 ## Development, CI/CD
 
 On each push to master and other branches Github Actions workflow runs which performs basic helm

charts/scalyr-agent/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: scalyr-agent
 description: A Helm chart for deploying the Scalyr agent
 type: application
-version: 0.2.4
+version: 0.2.5
 appVersion: 2.1.24
 keywords:
   - scalyr

charts/scalyr-agent/templates/NOTES.txt

@@ -1,5 +1,20 @@
 Thank you for installing {{ .Chart.Name }}.
 
-The Scalyr {{ .Values.controllerType }} was deployed successfully and is up and running. Given the specified
-Scalyr server and api key values were correct, head over to your Scalyr dashboard to see the first incoming
-log data.
+The Scalyr Agent {{ .Values.controllerType }} was deployed successfully and is up and running.
+
+Given the specified Scalyr server and api key values were correct, head over to your Scalyr dashboard
+({{- if contains "eu." $.Values.scalyr.server }}https://app.eu.scalyr.com{{ else }}https://app.scalyr.com{{- end }}) to see the first incoming log data.
+
+You can retrieve information about the agent pod(s) by running the following command:
+
+  kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "scalyr-helm.name" . }}" -l "app.kubernetes.io/instance={{ .Release.Name }}"
+
+To view pod info and logs and verify that the pod has started without any errors, you can use the
+following commands:
+
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "scalyr-helm.name" . }}" -l "app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  kubectl describe pod "${POD_NAME}"
+  kubectl logs -f "${POD_NAME}"
+
+If you have any questions or need additional assistance, feel free to reach out to Scalyr Support
+(https://www.scalyr.com/support) which is happy to assist you.

charts/scalyr-agent/templates/configmap.yaml

@@ -26,5 +26,11 @@ data:
   {{- end }}
   {{- range $key, $value := .Values.scalyr.config }}
   "{{ $key }}": |
+    {{- if $.Values.scalyr.base64Config }}
+    {{- $b64decValue := $value | b64dec }}
+    {{- if contains "illegal base64 data" $b64decValue }}
+    {{- fail ".Values.scalyr.config entry doesn't contain a valid base64 encoded value" }}
+    {{- end }}
+    {{- end }}
     {{ if $.Values.scalyr.base64Config }}{{ $value | b64dec }}{{ else }}{{ $value }}{{ end }}
   {{- end }}

charts/scalyr-agent/templates/daemonset.yaml

@@ -57,6 +57,16 @@ spec:
             {{- toYaml .Values.securityContext | nindent 12 }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
+          {{- if .Values.livenessProbe }}
+          livenessProbe:
+            exec:
+              command:
+              - scalyr-agent-2
+              - status
+              - -H
+            initialDelaySeconds: 60
+            periodSeconds: 60
+          {{- end }}
           env:
             - name: "SCALYR_SERVER"
               value: {{ .Values.scalyr.server }}
@@ -69,9 +79,11 @@ spec:
             - name: "SCALYR_K8S_CLUSTER_NAME"
               value: "{{ .Values.scalyr.k8s.clusterName }}"
             - name: "SCALYR_K8S_VERIFY_KUBELET_QUERIES"
-              value: "{{ .Values.scalyr.k8s.verifyKubeletQueries }}"
+              value: "{{- if .Values.scalyr.k8s.verifyKubeletQueries }}true{{ else }}false{{- end }}"
+            {{- if (.Values.scalyr.k8s.caCert) }}
             - name: "SCALYR_K8S_KUBELET_CA_CERT"
               value: "{{ .Values.scalyr.k8s.caCert }}"
+            {{- end }}
             - name: "SCALYR_K8S_NODE_NAME"
               valueFrom:
                 fieldRef:

charts/scalyr-agent/templates/deployment.yaml

@@ -58,6 +58,16 @@ spec:
             {{- toYaml .Values.securityContext | nindent 12 }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
+          {{- if .Values.livenessProbe }}
+          livenessProbe:
+            exec:
+              command:
+              - scalyr-agent-2
+              - status
+              - -H
+            initialDelaySeconds: 60
+            periodSeconds: 60
+          {{- end }}
           env:
             - name: "SCALYR_SERVER"
               value: {{ .Values.scalyr.server }}
@@ -71,8 +81,10 @@ spec:
               value: "{{ .Values.scalyr.k8s.clusterName }}"
             - name: "SCALYR_K8S_VERIFY_KUBELET_QUERIES"
               value: "{{ .Values.scalyr.k8s.verifyKubeletQueries }}"
+            {{- if (.Values.scalyr.k8s.caCert) }}
             - name: "SCALYR_K8S_KUBELET_CA_CERT"
               value: "{{ .Values.scalyr.k8s.caCert }}"
+            {{- end }}
             - name: "SCALYR_K8S_NODE_NAME"
               valueFrom:
                 fieldRef:

charts/scalyr-agent/values.yaml

@@ -22,9 +22,13 @@ scalyr:
   k8s:
     # scalyr.k8s.clusterName -- The kubernetes cluster name (when using the kubernetes monitoring)
     clusterName: ""
-    # scalyr.k8s.verifyKubeletQueries -- Set this to true and set up scalyr.k8s.caCert to activate TLS validation
-    # of queries to the k8s kubelet
-    verifyKubeletQueries: "false"
+    # scalyr.k8s.verifyKubeletQueries -- Set this to false to disable TLS cert validation of queries to k8s kubelet.
+    # By default cert validation is enabled and connection is verified using the CA configured via the service
+    # account certificate (/run/secrets/kubernetes.io/serviceaccount/ca.crt file). If you want to use a custom CA
+    # bundle, you can do that by setting scalyr.k8s.caCert config option to point to this file (this file needs to
+    # be available inside the agent container). In some test environments such as minikube where self signed certs
+    # are used you may want to set this to false.
+    verifyKubeletQueries: true
     # scalyr.k8s.caCert -- The path to the CA certificate to use to verify TLS-connection to the kubelet
     caCert: ""
     # scalyr.k8s.enableLogs -- Enable fetching Pod/Container logs from Kubernetes
@@ -64,6 +68,9 @@ podSecurityContext: {}
 # securityContext -- optional security context entries
 securityContext: {}
 
+# livenessProbe -- set to false to disable default liveness probe which utilizes scalyr-agent-2 status -H command
+livenessProbe: true
+
 # resources -- Pod resources. Defaults to the values documented in the official
 # [Installation guide](https://app.scalyr.com/help/install-agent-kubernetes)
 resources:

ci/daemonset-agent-values.yaml

@@ -4,3 +4,5 @@ podLabels:
   test: "true"
 scalyr:
   apiKey: "REPLACE_ME"
+  k8s:
+    verifyKubeletQueries: false