From 83ffac270cd5f27453a5da55064d8e8262825911 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 10:51:21 +0100 Subject: [PATCH 01/15] Update readme. --- charts/scalyr-agent/README.md | 54 +++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 charts/scalyr-agent/README.md diff --git a/charts/scalyr-agent/README.md b/charts/scalyr-agent/README.md new file mode 100644 index 0000000..475e409 --- /dev/null +++ b/charts/scalyr-agent/README.md @@ -0,0 +1,54 @@ +# scalyr-agent + +![Version: 0.2.3](https://img.shields.io/badge/Version-0.2.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.1.20](https://img.shields.io/badge/AppVersion-2.1.20-informational?style=flat-square) + +A Helm chart for deploying the Scalyr agent + +**Homepage:** + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| scalyr | support@scalyr.com | https://github.com/scalyr | +| dploeger | develop@dieploegers.de | https://github.com/dploeger | + +## Source Code + +* + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | optional affinity rules | +| controllerType | string | `"daemonset"` | Wether to setup a daemonset or a deployment for the Scalyr agent A daemonset should be used for Kubernetes monitoring while a deployment should be used for single resource monitorings (e.g. hosted databases, etc.) Valid values: "daemonset" or "deployment" | +| deployment.replicaCount | int | `1` | The count of replicas to use when using the deployment controller setup | +| fullnameOverride | string | `""` | Override the default full name that helm calculates | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"scalyr/scalyr-k8s-agent"` | Image to use. Defaults to the official scalyr agent image | +| image.tag | string | `""` | Tag to use. Defaults to appVersion from the chart metadata | +| imagePullSecrets | list | `[]` | Image pull secrets to use if the image is in a private repository | +| nameOverride | string | `""` | Override the default name that helm calculates | +| nodeSelector | object | `{}` | optional node selectors | +| podAnnotations | object | `{}` | optional pod annotations | +| podLabels | object | `{}` | optional arbitrary pod metadata labels | +| podSecurityContext | object | `{}` | | +| resources | object | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"500m","memory":"500Mi"}}` | Pod resources. Defaults to the values documented in the official [Installation guide](https://app.scalyr.com/help/install-agent-kubernetes) | +| scalyr.apiKey | string | `""` | The Scalyr API key to use | +| scalyr.base64Config | bool | `true` | As Helm is currently [unable to correctly pass JSON strings](https://github.com/helm/helm/issues/5618), this can be set to true so all values of scalyr.config are expected to be base64 encoded and will be decoded in the chart | +| scalyr.config | object | `{}` | A hash of configuration files and their content as documented in the [Scalyr agent configmap configuration documentation](https://app.scalyr.com/help/scalyr-agent-k8s#modify-config) | +| scalyr.k8s.caCert | string | `""` | The path to the CA certificate to use to verify TLS-connection to the kubelet | +| scalyr.k8s.clusterName | string | `""` | The kubernetes cluster name (when using the kubernetes monitoring) | +| scalyr.k8s.enableEvents | bool | `true` | Enable fetching Kubernetes events | +| scalyr.k8s.enableLogs | bool | `true` | Enable fetching Pod/Container logs from Kubernetes | +| scalyr.k8s.enableMetrics | bool | `true` | Enable fetching Kubernetes metrics. This requires scalyr.k8s.enableLogs to be true | +| scalyr.k8s.verifyKubeletQueries | string | `"false"` | Set this to true and set up scalyr.k8s.caCert to activate TLS validation of queries to the k8s kubelet | +| scalyr.server | string | `"agent.scalyr.com"` | The Scalyr server to send logs to. Use eu.scalyr.com for EU | +| securityContext | object | `{}` | optional security context entries | +| tolerations | list | `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Exists"}]` | Pod tolerations. Defaults to the values documented in the official [Installation guide](https://app.scalyr.com/help/install-agent-kubernetes) | +| volumeMounts | object | `{}` | Additional volume mounts to set up | +| volumes | object | `{}` | Additional volumes to mount | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) From 9eabe66fe72887e15d24f7e760f6230f03d93256 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 10:51:45 +0100 Subject: [PATCH 02/15] Update readme, remove testing code. --- .github/workflows/end_to_end_tests.yaml | 2 -- .github/workflows/lint_tests.yml | 2 -- README.md | 12 ++++++------ 3 files changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/workflows/end_to_end_tests.yaml b/.github/workflows/end_to_end_tests.yaml index 0f70171..6ba9902 100644 --- 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 index 2ab3546..ffc14f8 100644 --- 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/README.md b/README.md index 9093c0f..fa63da5 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ to install this chart. 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 From 946408141a4c34b8875417ee8eb5904979a9a871 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 10:55:36 +0100 Subject: [PATCH 03/15] Update .gitignore. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 05cf7b6..e66a889 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ venv/ ci/test-values.yaml charts/*/ci/*-values.yaml +charts/scalyr-agent/README.md From de6558344c001200a3be4542ff3b4648d1edd0b6 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 10:59:03 +0100 Subject: [PATCH 04/15] Remove unncessary ports definition. --- charts/scalyr-agent/templates/daemonset.yaml | 4 ---- charts/scalyr-agent/templates/deployment.yaml | 4 ---- 2 files changed, 8 deletions(-) diff --git a/charts/scalyr-agent/templates/daemonset.yaml b/charts/scalyr-agent/templates/daemonset.yaml index e784969..1018637 100644 --- 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 index 3aaa147..5467432 100644 --- 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 }} From 6c19bea8cc5b4b4792ca2e5fa87bd7a98e79baa0 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:02:32 +0100 Subject: [PATCH 05/15] Add changelog file. --- CHANGELOG.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..54e8866 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +## Scalyr Agent 2 Helm Chart Changes by Release + +## 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. From 3486b7451960d1046d031fb21fbe18286d4c9d2a Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:04:18 +0100 Subject: [PATCH 06/15] Update release workflow, readme. --- .github/workflows/release.yml | 2 -- README.md | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1b77a6d..3b9f376 100644 --- 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/README.md b/README.md index fa63da5..08affde 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ database service etc.). Use - helm install scalyr-agent --repo https://dodevops.io/helm-scalyr + helm install scalyr-agent --repo https://scalyr.github.io/helm-scalyr/ to install this chart. From a4c3b68cc13ac1e1b695fa24258f141248a36a85 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:07:28 +0100 Subject: [PATCH 07/15] Update readme. --- README.md | 18 +++++++++++++----- README.md.gotmpl | 2 +- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 08affde..32c8597 100644 --- 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 @@ -157,11 +157,13 @@ 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 -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. +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 @@ -169,3 +171,9 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use 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). They +have agreed to transfer the ownership to Scalyr so we can continue improving, supporting and +maintaining the chart. diff --git a/README.md.gotmpl b/README.md.gotmpl index 5f4dc58..2f1a6ef 100644 --- 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 From b0e79212d1ef6277c7a774cf92dbac2c82300635 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:11:03 +0100 Subject: [PATCH 08/15] Update changelog file. --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 54e8866..8b7bf17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,7 @@ ## 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. From 7a57fe5aaa5575c069c1abaed305eb3317f0751d Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:12:11 +0100 Subject: [PATCH 09/15] Remove file which should not be there. --- charts/scalyr-agent/README.md | 54 ----------------------------------- 1 file changed, 54 deletions(-) delete mode 100644 charts/scalyr-agent/README.md diff --git a/charts/scalyr-agent/README.md b/charts/scalyr-agent/README.md deleted file mode 100644 index 475e409..0000000 --- a/charts/scalyr-agent/README.md +++ /dev/null @@ -1,54 +0,0 @@ -# scalyr-agent - -![Version: 0.2.3](https://img.shields.io/badge/Version-0.2.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.1.20](https://img.shields.io/badge/AppVersion-2.1.20-informational?style=flat-square) - -A Helm chart for deploying the Scalyr agent - -**Homepage:** - -## Maintainers - -| Name | Email | Url | -| ---- | ------ | --- | -| scalyr | support@scalyr.com | https://github.com/scalyr | -| dploeger | develop@dieploegers.de | https://github.com/dploeger | - -## Source Code - -* - -## Values - -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| affinity | object | `{}` | optional affinity rules | -| controllerType | string | `"daemonset"` | Wether to setup a daemonset or a deployment for the Scalyr agent A daemonset should be used for Kubernetes monitoring while a deployment should be used for single resource monitorings (e.g. hosted databases, etc.) Valid values: "daemonset" or "deployment" | -| deployment.replicaCount | int | `1` | The count of replicas to use when using the deployment controller setup | -| fullnameOverride | string | `""` | Override the default full name that helm calculates | -| image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"scalyr/scalyr-k8s-agent"` | Image to use. Defaults to the official scalyr agent image | -| image.tag | string | `""` | Tag to use. Defaults to appVersion from the chart metadata | -| imagePullSecrets | list | `[]` | Image pull secrets to use if the image is in a private repository | -| nameOverride | string | `""` | Override the default name that helm calculates | -| nodeSelector | object | `{}` | optional node selectors | -| podAnnotations | object | `{}` | optional pod annotations | -| podLabels | object | `{}` | optional arbitrary pod metadata labels | -| podSecurityContext | object | `{}` | | -| resources | object | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"500m","memory":"500Mi"}}` | Pod resources. Defaults to the values documented in the official [Installation guide](https://app.scalyr.com/help/install-agent-kubernetes) | -| scalyr.apiKey | string | `""` | The Scalyr API key to use | -| scalyr.base64Config | bool | `true` | As Helm is currently [unable to correctly pass JSON strings](https://github.com/helm/helm/issues/5618), this can be set to true so all values of scalyr.config are expected to be base64 encoded and will be decoded in the chart | -| scalyr.config | object | `{}` | A hash of configuration files and their content as documented in the [Scalyr agent configmap configuration documentation](https://app.scalyr.com/help/scalyr-agent-k8s#modify-config) | -| scalyr.k8s.caCert | string | `""` | The path to the CA certificate to use to verify TLS-connection to the kubelet | -| scalyr.k8s.clusterName | string | `""` | The kubernetes cluster name (when using the kubernetes monitoring) | -| scalyr.k8s.enableEvents | bool | `true` | Enable fetching Kubernetes events | -| scalyr.k8s.enableLogs | bool | `true` | Enable fetching Pod/Container logs from Kubernetes | -| scalyr.k8s.enableMetrics | bool | `true` | Enable fetching Kubernetes metrics. This requires scalyr.k8s.enableLogs to be true | -| scalyr.k8s.verifyKubeletQueries | string | `"false"` | Set this to true and set up scalyr.k8s.caCert to activate TLS validation of queries to the k8s kubelet | -| scalyr.server | string | `"agent.scalyr.com"` | The Scalyr server to send logs to. Use eu.scalyr.com for EU | -| securityContext | object | `{}` | optional security context entries | -| tolerations | list | `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Exists"}]` | Pod tolerations. Defaults to the values documented in the official [Installation guide](https://app.scalyr.com/help/install-agent-kubernetes) | -| volumeMounts | object | `{}` | Additional volume mounts to set up | -| volumes | object | `{}` | Additional volumes to mount | - ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) From 1c68c1a5e292f9b47bdc7116880b4ba40f0258f8 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:14:28 +0100 Subject: [PATCH 10/15] Test build failure slack notification. --- .github/workflows/lint_tests.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/lint_tests.yml b/.github/workflows/lint_tests.yml index ffc14f8..2f56982 100644 --- a/.github/workflows/lint_tests.yml +++ b/.github/workflows/lint_tests.yml @@ -114,6 +114,7 @@ jobs: # Write test values to a file which is used by ct install mkdir -p charts/scalyr-agent/ci/ echo -e 'controllerType: "deployment"\nscalyr:\n apiKey: "${API_KEY}"' > charts/scalyr-agent/ci/test-values.yaml + exit 1 ct install --debug --config ci/ct.yaml @@ -121,7 +122,8 @@ jobs: # 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 # case of PRs - if: ${{ failure() && (github.ref == 'refs/heads/main' || github.head_ref == 'main') }} + if: ${{ failure() }} + #if: ${{ failure() && (github.ref == 'refs/heads/main' || github.head_ref == 'main') }} uses: act10ns/slack@e4e71685b9b239384b0f676a63c32367f59c2522 # v1.2.2 env: SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} From f8a2a74c1a8a6cae26a9f560b969339c294fb5a3 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:32:58 +0100 Subject: [PATCH 11/15] Bump agent version to v2.1.24, bump chart version to v.0.2.4. --- charts/scalyr-agent/Chart.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/charts/scalyr-agent/Chart.yaml b/charts/scalyr-agent/Chart.yaml index c4563e1..e7d4474 100644 --- 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 From decfb4bb0037e0122d905b549c3c09a19556e31e Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:33:29 +0100 Subject: [PATCH 12/15] Remove testing change. --- .github/workflows/lint_tests.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/lint_tests.yml b/.github/workflows/lint_tests.yml index 2f56982..ffc14f8 100644 --- a/.github/workflows/lint_tests.yml +++ b/.github/workflows/lint_tests.yml @@ -114,7 +114,6 @@ jobs: # Write test values to a file which is used by ct install mkdir -p charts/scalyr-agent/ci/ echo -e 'controllerType: "deployment"\nscalyr:\n apiKey: "${API_KEY}"' > charts/scalyr-agent/ci/test-values.yaml - exit 1 ct install --debug --config ci/ct.yaml @@ -122,8 +121,7 @@ jobs: # 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 # case of PRs - if: ${{ failure() }} - #if: ${{ failure() && (github.ref == 'refs/heads/main' || github.head_ref == 'main') }} + if: ${{ failure() && (github.ref == 'refs/heads/main' || github.head_ref == 'main') }} uses: act10ns/slack@e4e71685b9b239384b0f676a63c32367f59c2522 # v1.2.2 env: SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} From dc67bde10a9f2cc91528b373e6c0db41c8ff9b24 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:34:47 +0100 Subject: [PATCH 13/15] Sync readme.md.gotmpl with readme. --- README.md.gotmpl | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/README.md.gotmpl b/README.md.gotmpl index 2f1a6ef..5887164 100644 --- a/README.md.gotmpl +++ b/README.md.gotmpl @@ -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 scalyr-agent --repo https://dodevops.io/helm-scalyr + helm install 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,24 @@ 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). They +have agreed to transfer the ownership to Scalyr so we can continue improving, supporting and +maintaining the chart. From 7b67e69bb62c4d2a014b3ebe98ba3061c27e56d1 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 11:35:03 +0100 Subject: [PATCH 14/15] Remove file which is not needed anymore. --- releaseChart.sh | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 releaseChart.sh diff --git a/releaseChart.sh b/releaseChart.sh deleted file mode 100644 index 8977090..0000000 --- a/releaseChart.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env bash - -if [ "$(git branch --show-current)" != "gh-pages" ] -then - echo "Merge to gh-pages first!" - exit 1 -fi - -helm lint . - -helm package . - -helm repo index --url https://dodevops.github.io/helm-scalyr . - - From 3045b81d8cec658becf17a46ebc22d3c78f6b525 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Mon, 1 Nov 2021 12:06:41 +0100 Subject: [PATCH 15/15] Update readme. --- README.md | 6 +++--- README.md.gotmpl | 7 ++++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 32c8597..8b01399 100644 --- a/README.md +++ b/README.md @@ -174,6 +174,6 @@ http://www.apache.org/licenses/LICENSE-2.0 ## Thank You -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. +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 index 5887164..f4f3425 100644 --- a/README.md.gotmpl +++ b/README.md.gotmpl @@ -138,6 +138,7 @@ http://www.apache.org/licenses/LICENSE-2.0 ## Thank You -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. + +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.