Deprecate apachepulsar/pulsar-grafana docker image (apache#13389)

* Deprecate apachepulsar/pulsar-grafana docker image * Add license to new file
rkaw92 · Dec 23, 2021 · 68cf3a9 · 68cf3a9
1 parent c9d8ecf
commit 68cf3a9
Show file tree

Hide file tree

Showing 14 changed files with 26 additions and 220 deletions.
diff --git a/docker/grafana/Dockerfile b/docker/grafana/Dockerfile
diff --git a/docker/grafana/grafana.ini b/docker/grafana/grafana.ini
diff --git a/docker/grafana/pom.xml b/docker/grafana/pom.xml
diff --git a/docker/grafana/start.sh b/docker/grafana/start.sh
diff --git a/docker/pom.xml b/docker/pom.xml
@@ -58,7 +58,6 @@
       </activation>
       <modules>
         <module>pulsar</module>
-        <module>grafana</module>
         <module>pulsar-all</module>
       </modules>
     </profile>

diff --git a/grafana/README.md b/grafana/README.md
@@ -0,0 +1,24 @@
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+
+## Grafana Dashboards
+
+In the [dashboards](./dashboards) directory, you can find sample grafana dashboards for several Pulsar components.
diff --git a/docker/grafana/dashboards/bookkeeper.json → grafana/dashboards/bookkeeper.json b/docker/grafana/dashboards/bookkeeper.json → grafana/dashboards/bookkeeper.json
diff --git a/docker/grafana/dashboards/jvm.json → grafana/dashboards/jvm.json b/docker/grafana/dashboards/jvm.json → grafana/dashboards/jvm.json
diff --git a/docker/grafana/dashboards/namespace.json → grafana/dashboards/namespace.json b/docker/grafana/dashboards/namespace.json → grafana/dashboards/namespace.json
diff --git a/docker/grafana/dashboards/prometheus.json → grafana/dashboards/prometheus.json b/docker/grafana/dashboards/prometheus.json → grafana/dashboards/prometheus.json
diff --git a/docker/grafana/dashboards/topic.json → grafana/dashboards/topic.json b/docker/grafana/dashboards/topic.json → grafana/dashboards/topic.json
diff --git a/docker/grafana/dashboards/zookeeper.json → grafana/dashboards/zookeeper.json b/docker/grafana/dashboards/zookeeper.json → grafana/dashboards/zookeeper.json
diff --git a/site2/docs/deploy-monitoring.md b/site2/docs/deploy-monitoring.md
@@ -108,15 +108,7 @@ The per-topic dashboard instructions are available at [Pulsar manager](administr
 
 You can use grafana to create dashboard driven by the data that is stored in Prometheus.
 
-When you deploy Pulsar on Kubernetes, a `pulsar-grafana` Docker image is enabled by default. You can use the docker image with the principal dashboards.
-
-Enter the command below to use the dashboard manually:
-
-```shell
-docker run -p3000:3000 \
-        -e PROMETHEUS_URL=http://$PROMETHEUS_HOST:9090/ \
-        apachepulsar/pulsar-grafana:latest
-```
+When you deploy Pulsar on Kubernetes with the Pulsar Helm Chart, a `pulsar-grafana` Docker image is enabled by default. You can use the docker image with the principal dashboards.
 
 The following are some Grafana dashboards examples:
 

diff --git a/site2/website-next/docs/deploy-monitoring.md b/site2/website-next/docs/deploy-monitoring.md
@@ -126,17 +126,7 @@ The per-topic dashboard instructions are available at [Pulsar manager](administr
 
 You can use grafana to create dashboard driven by the data that is stored in Prometheus.
 
-When you deploy Pulsar on Kubernetes, a `pulsar-grafana` Docker image is enabled by default. You can use the docker image with the principal dashboards.
-
-Enter the command below to use the dashboard manually:
-
-```shell
-
-docker run -p3000:3000 \
-        -e PROMETHEUS_URL=http://$PROMETHEUS_HOST:9090/ \
-        apachepulsar/pulsar-grafana:latest
-
-```
+When you deploy Pulsar on Kubernetes with the Pulsar Helm Chart, a `pulsar-grafana` Docker image is enabled by default. You can use the docker image with the principal dashboards.
 
 The following are some Grafana dashboards examples: