Merge pull request #3 from scalyr/more_changes

README and other changes
scalyr · Nov 1, 2021 · 248f65e · 248f65e
2 parents 4eac607 + 3045b81
commit 248f65e
Show file tree

Hide file tree

Showing 11 changed files with 66 additions and 52 deletions.
diff --git a/.github/workflows/end_to_end_tests.yaml b/.github/workflows/end_to_end_tests.yaml
@@ -8,11 +8,9 @@ on:
   push:
     branches:
       - main
-      - end_to_end_tests
   pull_request:
     branches:
       - main
-      - end_to_end_tests
   schedule:
     - cron: '0 4 * * *'
 

diff --git a/.github/workflows/lint_tests.yml b/.github/workflows/lint_tests.yml
@@ -6,11 +6,9 @@ on:
   push:
     branches:
       - main
-      - end_to_end_tests
   pull_request:
     branches:
       - main
-      - end_to_end_tests
   schedule:
     - cron: '0 4 * * *'
 

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -33,8 +33,6 @@ jobs:
           CR_TOKEN: "${{ github.token }}"
         with:
           charts_dir: charts
-          # TODO: This can be removed once it's moved to Scalyr org
-          charts_repo_url: http://www.tomaz.me/helm-scalyr/
 
       - 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

diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 venv/
 ci/test-values.yaml
 charts/*/ci/*-values.yaml
+charts/scalyr-agent/README.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,13 @@
+## Scalyr Agent 2 Helm Chart Changes by Release
+
+For actual scalyr agent changelog, please see https://github.com/scalyr/scalyr-agent-2/blob/master/CHANGELOG.md.
+
+## 0.2.4
+
+- Scalyr agent has been updated to v2.1.24.
+- Removed unnecessary ports resource definition from the deployment and daemonset template.
+- Allow user to define arbitrary agent pod labels using ``podLabels`` config option.
+
+## 0.2.3
+
+- Fix permission mask for the ``kubernetes.json`` file which is written as part of the ConfigMap.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # scalyr-agent Helm Chart
 
-[![Lint and Tests](https://github.com/scalyr/helm-scalyr/actions/workflows/lint_tests.yml/badge.svg)](https://github.com/scalyr/helm-scalyr/actions/workflows/lint_tests.yml) [![End to End Tests](https://github.com/scalyr/helm-scalyr/actions/workflows/end_to_end_tests.yaml/badge.svg)](https://github.com/scalyr/helm-scalyr/actions/workflows/end_to_end_tests.yaml)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Lint and Tests](https://github.com/scalyr/helm-scalyr/actions/workflows/lint_tests.yml/badge.svg)](https://github.com/scalyr/helm-scalyr/actions/workflows/lint_tests.yml) [![End to End Tests](https://github.com/scalyr/helm-scalyr/actions/workflows/end_to_end_tests.yaml/badge.svg)](https://github.com/scalyr/helm-scalyr/actions/workflows/end_to_end_tests.yaml)
 
 ## Introduction
 
@@ -13,17 +13,17 @@ database service etc.).
 
 Use
 
-    helm install <name of release> scalyr-agent --repo https://dodevops.io/helm-scalyr
+    helm install <name of release> scalyr-agent --repo https://scalyr.github.io/helm-scalyr/
 
 to install this chart.
 
 ## Configuration
 
 Two basic configuration keys have to be set up to allow logging to Scalyr cloud:
 
-* scalyr.server: The name of the Scalyr api server (defaults to scalyr.com. use ``eu.scalyr.com`` for EU.)
-* scalyr.apiKey: The api key used to authenticate to the Scalyr api server
-* scalyr.config: The Scalyr configuration
+* ``scalyr.server``: The name of the Scalyr api server (defaults to ``agent.scalyr.com``. use ``eu.scalyr.com`` for EU.)
+* ``scalyr.apiKey``: The api key used to authenticate to the Scalyr api server
+* ``scalyr.config``: The Scalyr configuration
 
 The scalyr configuration is done using the
 [configuration map approach](https://app.scalyr.com/help/scalyr-agent-k8s#modify-config). This is basically a key/value
@@ -33,12 +33,12 @@ for each monitor.
 This chart's default values are set to support the monitoring of a Kubernetes cluster. The only value you have
 to set manually is:
 
-* config.k8s.clusterName: name of the Kubernetes cluster to monitor (will be visible in the Scalyr UI)
+* ``config.k8s.clusterName``: name of the Kubernetes cluster to monitor (will be visible in the Scalyr UI)
 
 If you want to monitor additional things outside of Kubernetes (e.g. Databases), you can set the following values:
 
-* controllerType: For other monitors, it is usually best to set this to "deployment" instead of "daemonset"
-* scalyr.k8s.enableLogs and scalyr.k8s.enableEvents: Set this to false to remove the serviceaccount, clusterroles and
+* ``controllerType``: For other monitors, it is usually best to set this to "deployment" instead of "daemonset"
+* ``scalyr.k8s.enableLogs`` and ``scalyr.k8s.enableEvents``: Set this to false to remove the serviceaccount, clusterroles and
   additional mounts to the Scalyr agent pods
 
 ## Controller type
@@ -157,15 +157,23 @@ Keep in mind that it may take a while since it needs to pull down a large Docker
 first run. This tool also may not work correctly on some operating systems since it relies on
 Docker inside Docker functionality for creating kind Kubernetes cluster.
 
-## Thank You
+## Publishing new version
+
+New version of the chart is automatically released by the [Release](https://github.com/scalyr/helm-scalyr/actions/workflows/release.yml)
+Github Actions workflow on push to main branch when changes are detected in the chart (e.g. chart
+content or metadata has been updated).
 
-The chart has been originally developed by [Dennis Ploeger](https://github.com/dploeger). They
-have agreed to transfer the ownership to Scalyr so we can continue improving, supporting and
-maintaining the chart.
+Helm Chart repository is available at https://scalyr.github.io/helm-scalyr/.
 
 ## License
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except
 in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
 
 http://www.apache.org/licenses/LICENSE-2.0
+
+## Thank You
+
+The chart has been originally developed by [Dennis Ploeger](https://github.com/dploeger) from
+[dodevops](https://github.com/dodevops). They have agreed to transfer the ownership to Scalyr so we
+can continue developing, improving and maintaining the chart.
diff --git a/README.md.gotmpl b/README.md.gotmpl
@@ -1,7 +1,7 @@
 {{ template "chart.header" . }}
 {{ template "chart.deprecationWarning" . }}
 
-[![Lint and Tests](https://github.com/scalyr/helm-scalyr/actions/workflows/lint_tests.yml/badge.svg)](https://github.com/scalyr/helm-scalyr/actions/workflows/lint_tests.yml) [![End to End Tests](https://github.com/scalyr/helm-scalyr/actions/workflows/end_to_end_tests.yaml/badge.svg)](https://github.com/scalyr/helm-scalyr/actions/workflows/end_to_end_tests.yaml) {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Lint and Tests](https://github.com/scalyr/helm-scalyr/actions/workflows/lint_tests.yml/badge.svg)](https://github.com/scalyr/helm-scalyr/actions/workflows/lint_tests.yml) [![End to End Tests](https://github.com/scalyr/helm-scalyr/actions/workflows/end_to_end_tests.yaml/badge.svg)](https://github.com/scalyr/helm-scalyr/actions/workflows/end_to_end_tests.yaml) {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
 
 ## Introduction
 
@@ -10,14 +10,11 @@ cluster. It supports installing the agent with all features required to support
 Additionally, it can deploy Scalyr agents which monitor other parts of the infrastructure (for example a hosted
 database service etc.).
 
-This chart is not affiliated with Scalyr, Inc. in any way. For support, please open an issue in this
-project's [issue tracker](https://github.com/dodevops/helm-scalyr/issues).
-
 ## Installation
 
 Use
 
-    helm install <name of release> scalyr-agent --repo https://dodevops.io/helm-scalyr
+    helm install <name of release> scalyr-agent --repo https://scalyr.github.io/helm-scalyr/
 
 to install this chart.
 
@@ -100,15 +97,17 @@ pip install yamale yamllint
 minikube start
 
 # 6. Run actual lint and install task
-ct lint --debug --charts . --chart-dirs "$(pwd)"
+ct lint --debug --config ci/ct.yaml
 
 # To use valid API key
-mkdir -p ci/
-echo -e 'scalyr:\n  apiKey: "SCALYR_TEST_WRITE_API_KEY"' > ci/test-values.yaml
+echo -e 'scalyr:\n  apiKey: "SCALYR_TEST_WRITE_API_KEY"' > charts/scalyr-agent/ci//test-values.yaml
 
-ct install --debug --charts . --chart-dirs "$(pwd)"
+ct install --debug
 ```
 
+You can find more example configs which are used by integration and end to
+end tests in ``ci/`` directory.
+
 As an alternative to manually installing those tools and setting up the environment, you can also
 use [act](https://github.com/nektos/act) tool which allows you to run GHA workflow locally inside
 Docker containers as shown below.
@@ -121,3 +120,25 @@ act
 Keep in mind that it may take a while since it needs to pull down a large Docker image during the
 first run. This tool also may not work correctly on some operating systems since it relies on
 Docker inside Docker functionality for creating kind Kubernetes cluster.
+
+## Publishing new version
+
+New version of the chart is automatically released by the [Release](https://github.com/scalyr/helm-scalyr/actions/workflows/release.yml)
+Github Actions workflow on push to main branch when changes are detected in the chart (e.g. chart
+content or metadata has been updated).
+
+Helm Chart repository is available at https://scalyr.github.io/helm-scalyr/.
+
+## License
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except
+in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+## Thank You
+
+
+The chart has been originally developed by [Dennis Ploeger](https://github.com/dploeger) from
+[dodevops](https://github.com/dodevops). They have agreed to transfer the ownership to Scalyr so we
+can continue developing, improving and maintaining the chart.
diff --git a/charts/scalyr-agent/Chart.yaml b/charts/scalyr-agent/Chart.yaml
@@ -2,8 +2,8 @@ apiVersion: v2
 name: scalyr-agent
 description: A Helm chart for deploying the Scalyr agent
 type: application
-version: 0.2.3
-appVersion: 2.1.20
+version: 0.2.4
+appVersion: 2.1.24
 keywords:
   - scalyr
   - logging

diff --git a/charts/scalyr-agent/templates/daemonset.yaml b/charts/scalyr-agent/templates/daemonset.yaml
@@ -57,10 +57,6 @@ spec:
             {{- toYaml .Values.securityContext | nindent 12 }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
-          ports:
-            - name: http
-              containerPort: 80
-              protocol: TCP
           env:
             - name: "SCALYR_SERVER"
               value: {{ .Values.scalyr.server }}

diff --git a/charts/scalyr-agent/templates/deployment.yaml b/charts/scalyr-agent/templates/deployment.yaml
@@ -58,10 +58,6 @@ spec:
             {{- toYaml .Values.securityContext | nindent 12 }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
-          ports:
-            - name: http
-              containerPort: 80
-              protocol: TCP
           env:
             - name: "SCALYR_SERVER"
               value: {{ .Values.scalyr.server }}

diff --git a/releaseChart.sh b/releaseChart.sh