Deprecate Charts as they have been moved (#2720)

* Deprecate Charts as they have been moved Signed-off-by: Torsten Walter <torsten.walter@syncier.com> * update docs and links to new chart location Co-authored-by: Edward Welch <edward.welch@grafana.com>
grafana · Dec 12, 2020 · 6c8ad52 · 6c8ad52
1 parent 3f99a07
commit 6c8ad52
Show file tree

Hide file tree

Showing 15 changed files with 107 additions and 42 deletions.
diff --git a/docs/sources/clients/aws/ec2/_index.md b/docs/sources/clients/aws/ec2/_index.md
@@ -289,7 +289,7 @@ Let's head back to Grafana and verify that your Promtail logs are available in G
 [labels]: https://grafana.com/blog/2020/04/21/how-labels-in-loki-can-make-log-queries-faster-and-easier/
 [troubleshooting loki]: ../../../getting-started/troubleshooting#troubleshooting-targets
 [live tailing]: https://grafana.com/docs/grafana/latest/features/datasources/loki/#live-tailing
-[systemd]: https://github.com/grafana/loki/tree/master/production/helm/promtail#run-promtail-with-systemd-journal-support
+[systemd]: ../../../installation/helm#run-promtail-with-systemd-journal-support
 [journald]: https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html
 [final config]: https://github.com/grafana/loki/blob/master/docs/sources/clients/aws/ec2/promtail-ec2-final.yaml
 [relabeling]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
diff --git a/docs/sources/clients/aws/eks/_index.md b/docs/sources/clients/aws/eks/_index.md
@@ -75,7 +75,7 @@ loki/promtail   0.24.0          v1.6.0          Responsible for gathering logs a
 If you want to install Loki, Grafana, Prometheus and Promtail all together you can use the `loki-stack` chart, for now we'll focus on Promtail. Let's create a new helm value file, we'll fetch the [default][default value file] one and work from there:
 
 ```bash
-curl https://raw.githubusercontent.com/grafana/loki/master/production/helm/promtail/values.yaml > values.yaml
+curl https://raw.githubusercontent.com/grafana/helm-charts/main/charts/promtail/values.yaml > values.yaml
 ```
 
 First we're going to tell Promtail to send logs to our Loki instance, the example below shows how to send logs to [GrafanaCloud][GrafanaCloud], replace your credentials. The default value will send to your own Loki and Grafana instance if you're using the `loki-chart` repository.
@@ -246,11 +246,11 @@ If you want to push this further you can check out [Joe's blog post][blog annota
 [blog ship log with fargate]: https://aws.amazon.com/blogs/containers/how-to-capture-application-logs-when-using-amazon-eks-on-aws-fargate/
 [correlate]: https://grafana.com/blog/2020/03/31/how-to-successfully-correlate-metrics-logs-and-traces-in-grafana/
 [tiller install]: https://v2.helm.sh/docs/using_helm/
-[default value file]: https://github.com/grafana/loki/blob/master/production/helm/promtail/values.yaml
-[systemd]: https://github.com/grafana/loki/tree/master/production/helm/promtail#run-promtail-with-systemd-journal-support
+[default value file]: https://github.com/grafana/helm-charts/blob/main/charts/promtail/values.yaml
+[systemd]: ../../../installation/helm#run-promtail-with-systemd-journal-support
 [grafana logs namespace]: namespace-grafana.png
 [relabel_configs]:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
-[syslog]: https://github.com/grafana/loki/tree/master/production/helm/promtail#run-promtail-with-syslog-support
+[syslog]: ../../../installation/helm#run-promtail-with-syslog-support
 [Filters]: https://grafana.com/docs/loki/latest/logql/#filter-expression
 [kubelet]: https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#:~:text=The%20kubelet%20works%20in%20terms,PodSpecs%20are%20running%20and%20healthy.
 [LogQL]: https://grafana.com/docs/loki/latest/logql/

diff --git a/docs/sources/clients/fluentbit/_index.md b/docs/sources/clients/fluentbit/_index.md
@@ -21,7 +21,7 @@ docker run -v /var/log:/var/log \
 
 You can run Fluent Bit as a [Daemonset](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) to collect all your Kubernetes workload logs.
 
-To do so you can use our [Fluent Bit helm chart](https://github.com/grafana/loki/tree/master/production/helm/fluent-bit):
+To do so you can use our [Fluent Bit helm chart](https://github.com/grafana/helm-charts/tree/main/charts/fluent-bit):
 
 > Make sure [tiller](https://helm.sh/docs/install/) is installed correctly in your cluster
 

diff --git a/docs/sources/clients/logstash/_index.md b/docs/sources/clients/logstash/_index.md
@@ -42,7 +42,7 @@ helm upgrade --install loki loki/loki-stack \
 ```
 
 This will automatically scrape all pods logs in the cluster and send them to Loki with Kubernetes metadata attached as labels.
-You can use the [`values.yaml`](https://github.com/grafana/loki/blob/master/production/helm/loki-stack/values.yaml) file as a starting point for your own configuration.
+You can use the [`values.yaml`](https://github.com/grafana/helm-charts/blob/main/charts/loki-stack/values.yaml) file as a starting point for your own configuration.
 
 ## Usage and Configuration
 

diff --git a/docs/sources/clients/promtail/configuration.md b/docs/sources/clients/promtail/configuration.md
@@ -1146,7 +1146,7 @@ sync_period: "10s"
 
 It's fairly difficult to tail Docker files on a standalone machine because they are in different locations for every OS.  We recommend the [Docker logging driver](../../docker-driver/) for local Docker installs or Docker Compose.
 
-If running in a Kubernetes environment, you should look at the defined configs which are in [helm](https://github.com/grafana/loki/tree/master/production/helm/promtail/templates/configmap.yaml) and [jsonnet](https://github.com/grafana/loki/tree/master/production/ksonnet/promtail/scrape_config.libsonnet), these leverage the prometheus service discovery libraries (and give promtail it's name) for automatically finding and tailing pods.  The jsonnet config explains with comments what each section is for.
+If running in a Kubernetes environment, you should look at the defined configs which are in [helm](https://github.com/grafana/helm-charts/blob/main/charts/promtail/templates/configmap.yaml) and [jsonnet](https://github.com/grafana/loki/tree/master/production/ksonnet/promtail/scrape_config.libsonnet), these leverage the prometheus service discovery libraries (and give promtail it's name) for automatically finding and tailing pods.  The jsonnet config explains with comments what each section is for.
 
 
 ## Example Static Config

diff --git a/docs/sources/community/contributing.md b/docs/sources/community/contributing.md
@@ -60,4 +60,4 @@ $ make loki promtail logcli
 
 ## Contribute to the Helm Chart
 
-Please follow the [Helm documentation](https://github.com/grafana/loki/tree/master/production/helm/).
+The official Loki helm charts can be found in the [Grafana Helm Charts Repo](https://github.com/grafana/helm-charts).
diff --git a/docs/sources/installation/helm.md b/docs/sources/installation/helm.md
@@ -8,10 +8,13 @@ title: Helm
 Make sure you have Helm [installed](https://helm.sh/docs/using_helm/#installing-helm) and
 [deployed](https://helm.sh/docs/using_helm/#installing-tiller) to your cluster.
 
-Add [Loki's chart repository](https://github.com/grafana/loki/tree/master/production/helm/loki) to Helm:
+Add [Loki's chart repository](https://github.com/grafana/helm-charts) to Helm:
+
+> **PLEASE NOTE** On 2020/12/11 Loki's Helm charts were moved from their initial location within the
+Loki repo and hosted at https://grafana.github.io/loki/charts to their new location at https://github.com/grafana/helm-charts which are hosted at https://grafana.github.io/helm-charts
 
 ```bash
-helm repo add loki https://grafana.github.io/loki/charts
+helm repo add grafana https://grafana.github.io/helm-charts
 ```
 
 To update the chart repository, run:
@@ -25,37 +28,37 @@ helm repo update
 ### Deploy with default config
 
 ```bash
-helm upgrade --install loki loki/loki-stack
+helm upgrade --install loki grafana/loki-stack
 ```
 
 ### Deploy in a custom namespace
 
 ```bash
-helm upgrade --install loki --namespace=loki loki/loki
+helm upgrade --install loki --namespace=loki grafana/loki
 ```
 
 ### Deploy with custom config
 
 ```bash
-helm upgrade --install loki loki/loki --set "key1=val1,key2=val2,..."
+helm upgrade --install loki grafana/loki --set "key1=val1,key2=val2,..."
 ```
 
 ### Deploy Loki Stack (Loki, Promtail, Grafana, Prometheus)
 
 ```bash
-helm upgrade --install loki loki/loki-stack  --set grafana.enabled=true,prometheus.enabled=true,prometheus.alertmanager.persistentVolume.enabled=false,prometheus.server.persistentVolume.enabled=false
+helm upgrade --install loki grafana/loki-stack  --set grafana.enabled=true,prometheus.enabled=true,prometheus.alertmanager.persistentVolume.enabled=false,prometheus.server.persistentVolume.enabled=false
 ```
 
 ### Deploy Loki Stack (Loki, Promtail, Grafana, Prometheus) with persistent volume claim
 
 ```bash
-helm upgrade --install loki loki/loki-stack  --set grafana.enabled=true,prometheus.enabled=true,prometheus.alertmanager.persistentVolume.enabled=false,prometheus.server.persistentVolume.enabled=false,loki.persistence.enabled=true,loki.persistence.storageClassName=standard,loki.persistence.size=5Gi
+helm upgrade --install loki grafana/loki-stack  --set grafana.enabled=true,prometheus.enabled=true,prometheus.alertmanager.persistentVolume.enabled=false,prometheus.server.persistentVolume.enabled=false,loki.persistence.enabled=true,loki.persistence.storageClassName=standard,loki.persistence.size=5Gi
 ```
 
 ### Deploy Loki Stack (Loki, Fluent Bit, Grafana, Prometheus)
 
 ```bash
-helm upgrade --install loki loki/loki-stack \
+helm upgrade --install loki grafana/loki-stack \
   --set fluent-bit.enabled=true,promtail.enabled=false,grafana.enabled=true,prometheus.enabled=true,prometheus.alertmanager.persistentVolume.enabled=false,prometheus.server.persistentVolume.enabled=false
 ```
 
@@ -64,7 +67,7 @@ helm upgrade --install loki loki/loki-stack \
 To install Grafana on your cluster with Helm, use the following command:
 
 ```bash
-helm install stable/grafana -n loki-grafana
+helm install loki-grafana grafana/grafana
 ```
 
 To get the admin password for the Grafana pod, run the following command:
@@ -122,3 +125,61 @@ spec:
     hosts:
     - {{ .Values.ingress.host }}
 ```
+
+## Run promtail with syslog support
+
+In order to receive and process syslog message into promtail, the following changes will be necessary:
+
+* Review the [promtail syslog-receiver configuration documentation](/docs/clients/promtail/scraping.md#syslog-receiver)
+
+* Configure the promtail helm chart with the syslog configuration added to the `extraScrapeConfigs` section and associated service definition to listen for syslog messages. For example:
+
+```yaml
+extraScrapeConfigs:
+  - job_name: syslog
+    syslog:
+      listen_address: 0.0.0.0:1514
+      labels:
+        job: "syslog"
+  relabel_configs:
+    - source_labels: ['__syslog_message_hostname']
+      target_label: 'host'
+syslogService:
+  enabled: true
+  type: LoadBalancer
+  port: 1514
+```
+
+## Run promtail with systemd-journal support
+
+In order to receive and process syslog message into promtail, the following changes will be necessary:
+
+* Review the [promtail systemd-journal configuration documentation](/docs/clients/promtail/scraping.md#journal-scraping-linux-only)
+
+* Configure the promtail helm chart with the systemd-journal configuration added to the `extraScrapeConfigs` section and volume mounts for the promtail pods to access the log files. For example:
+
+```yaml
+# Add additional scrape config
+extraScrapeConfigs:
+  - job_name: journal
+    journal:
+      path: /var/log/journal
+      max_age: 12h
+      labels:
+        job: systemd-journal
+    relabel_configs:
+      - source_labels: ['__journal__systemd_unit']
+        target_label: 'unit'
+      - source_labels: ['__journal__hostname']
+        target_label: 'hostname'
+
+# Mount journal directory into promtail pods
+extraVolumes:
+  - name: journal
+    hostPath:
+      path: /var/log/journal
+
+extraVolumeMounts:
+  - name: journal
+    mountPath: /var/log/journal
+    readOnly: true
diff --git a/production/helm/fluent-bit/Chart.yaml b/production/helm/fluent-bit/Chart.yaml
@@ -1,14 +1,13 @@
 apiVersion: "v1"
+# This Chart was moved to https://github.com/grafana/helm-charts
+deprecated: true
 name: fluent-bit
-version: 2.0.1
+version: 2.0.2
 appVersion: v2.0.0
 kubeVersion: "^1.10.0-0"
-description: "Uses fluent-bit Loki go plugin for gathering logs and sending them to Loki"
+description: "DEPRECATED Uses fluent-bit Loki go plugin for gathering logs and sending them to Loki"
 home: https://grafana.com/loki
 icon: https://raw.githubusercontent.com/grafana/loki/master/docs/sources/logo.png
 sources:
 - https://github.com/grafana/loki
-maintainers:
-- name: Loki Maintainers
-  email: lokiproject@googlegroups.com
 engine: gotpl
diff --git a/production/helm/fluent-bit/README.md b/production/helm/fluent-bit/README.md
@@ -1,4 +1,6 @@
-# Fluent Bit Loki chart
+# ⚠️  DEPRECATED - Fluent Bit Loki chart
+
+This chart was moved to <https://github.com/grafana/helm-charts>.
 
 This chart install the Fluent Bit application to ship logs to Loki. It defines daemonset on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
 

diff --git a/production/helm/loki-stack/Chart.yaml b/production/helm/loki-stack/Chart.yaml
@@ -1,14 +1,13 @@
 apiVersion: "v1"
+# This Chart was moved to https://github.com/grafana/helm-charts
+deprecated: true
 name: loki-stack
-version: 2.1.1
+version: 2.1.2
 appVersion: v2.0.0
 kubeVersion: "^1.10.0-0"
-description: "Loki: like Prometheus, but for logs."
+description: "DEPRECATED Loki: like Prometheus, but for logs."
 home: https://grafana.com/loki
 icon: https://raw.githubusercontent.com/grafana/loki/master/docs/sources/logo.png
 sources:
 - https://github.com/grafana/loki
-maintainers:
-- name: Loki Maintainers
-  email: lokiproject@googlegroups.com
 engine: gotpl
diff --git a/production/helm/loki-stack/README.md b/production/helm/loki-stack/README.md
@@ -1,4 +1,6 @@
-# Loki-Stack Helm Chart
+# ⚠️  DEPRECATED - Loki-Stack Helm Chart
+
+This chart was moved to <https://github.com/grafana/helm-charts>.
 
 ## Prerequisites
 

diff --git a/production/helm/loki/Chart.yaml b/production/helm/loki/Chart.yaml
@@ -1,14 +1,13 @@
 apiVersion: "v1"
+# This Chart was moved to https://github.com/grafana/helm-charts
+deprecated: true
 name: loki
-version: 2.1.0
+version: 2.1.1
 appVersion: v2.0.0
 kubeVersion: "^1.10.0-0"
-description: "Loki: like Prometheus, but for logs."
+description: "DEPRECATED Loki: like Prometheus, but for logs."
 home: https://grafana.com/loki
 icon: https://raw.githubusercontent.com/grafana/loki/master/docs/sources/logo.png
 sources:
   - https://github.com/grafana/loki
-maintainers:
-  - name: Loki Maintainers
-    email: lokiproject@googlegroups.com
 engine: gotpl
diff --git a/production/helm/loki/README.md b/production/helm/loki/README.md
@@ -1,4 +1,6 @@
-# Loki Helm Chart
+# ⚠️  DEPRECATED - Loki Helm Chart
+
+This chart was moved to <https://github.com/grafana/helm-charts>.
 
 ## Prerequisites
 

diff --git a/production/helm/promtail/Chart.yaml b/production/helm/promtail/Chart.yaml
@@ -1,14 +1,13 @@
 apiVersion: "v1"
+# This Chart was moved to https://github.com/grafana/helm-charts
+deprecated: true
 name: promtail
-version: 2.0.1
+version: 2.0.2
 appVersion: v2.0.0
 kubeVersion: "^1.10.0-0"
-description: "Responsible for gathering logs and sending them to Loki"
+description: "DEPRECATED Responsible for gathering logs and sending them to Loki"
 home: https://grafana.com/loki
 icon: https://raw.githubusercontent.com/grafana/loki/master/docs/sources/logo.png
 sources:
 - https://github.com/grafana/loki
-maintainers:
-- name: Loki Maintainers
-  email: lokiproject@googlegroups.com
 engine: gotpl
diff --git a/production/helm/promtail/README.md b/production/helm/promtail/README.md
@@ -1,4 +1,6 @@
-# Promtail Helm Chart
+# ⚠️  DEPRECATED - Promtail Helm Chart
+
+This chart was moved to <https://github.com/grafana/helm-charts>.
 
 ## Deploy Promtail only
Original file line number	Diff line number	Diff line change
Expand Up		@@ -60,4 +60,4 @@ $ make loki promtail logcli

		## Contribute to the Helm Chart

		Please follow the [Helm documentation](https://github.com/grafana/loki/tree/master/production/helm/).
		The official Loki helm charts can be found in the [Grafana Helm Charts Repo](https://github.com/grafana/helm-charts).