bitnami/grafana
Bitnami container image for Grafana
50M+
Grafana is an open source metric analytics and visualization suite for visualizing time series data that supports various types of data sources.
Overview of Grafana Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
docker run --name grafana bitnami/grafana:latest
Looking to use Grafana in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami Grafana Chart GitHub repository.
Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.
Dockerfile
linksLearn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
You can see the equivalence between the different tags by taking a look at the tags-info.yaml
file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml
.
Subscribe to project updates by watching the bitnami/containers GitHub repo.
The recommended way to get the Bitnami Grafana Docker Image is to pull the prebuilt image from the Docker Hub Registry.
docker pull bitnami/grafana:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
docker pull bitnami/grafana:[TAG]
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build
command. Remember to replace the APP
, VERSION
and OPERATING-SYSTEM
path placeholders in the example command below with the correct values.
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
Using Docker container networking, a different server running inside a container can easily be accessed by your application containers and vice-versa.
Containers attached to the same network can communicate with each other using the container name as the hostname.
Step 1: Create a network
docker network create grafana-network --driver bridge
Step 2: Launch the grafana container within your network
Use the --network <NETWORK>
argument to the docker run
command to attach the container to the grafana-network
network.
docker run --name grafana-node1 --network grafana-network bitnami/grafana:latest
Step 3: Run another containers
We can launch another containers using the same flag (--network NETWORK
) in the docker run
command. If you also set a name to your container, you will be able to use it as hostname in your network.
Customizable environment variables
Name | Description | Default Value |
---|---|---|
GRAFANA_TMP_DIR | Grafana directory for temporary runtime files. | ${GRAFANA_BASE_DIR}/tmp |
GRAFANA_PID_FILE | Grafana PID file. | ${GRAFANA_TMP_DIR}/grafana.pid |
GRAFANA_DEFAULT_CONF_DIR | Grafana directory for default plugins. | ${GRAFANA_BASE_DIR}/conf.default |
GRAFANA_DEFAULT_PLUGINS_DIR | Grafana directory for default configuration files. | ${GRAFANA_BASE_DIR}/default-plugins |
GF_PATHS_HOME | Grafana home directory. | $GRAFANA_BASE_DIR |
GF_PATHS_CONFIG | Grafana configuration file. | ${GRAFANA_BASE_DIR}/conf/grafana.ini |
GF_PATHS_DATA | Grafana directory for data files. | ${GRAFANA_BASE_DIR}/data |
GF_PATHS_LOGS | Grafana directory for log files. | ${GRAFANA_BASE_DIR}/logs |
GF_PATHS_PLUGINS | Grafana directory for plugins. | ${GF_PATHS_DATA}/plugins |
GF_PATHS_PROVISIONING | Grafana directory for provisioning configurations. | ${GRAFANA_BASE_DIR}/conf/provisioning |
GF_INSTALL_PLUGINS | Grafana plugins to install | nil |
GF_INSTALL_PLUGINS_SKIP_TLS | Whether to skip TLS certificate verification when installing plugins | yes |
GF_FEATURE_TOGGLES | Comma-separated list of Grafana feature toggles. | nil |
GRAFANA_MIGRATION_LOCK | Enable the migration lock mechanism to avoid issues caused by concurrent migrations. | false |
GRAFANA_SLEEP_TIME | Sleep time between migration status check attempts. | 10 |
GRAFANA_RETRY_ATTEMPTS | Number of retries to check migration status. | 12 |
Read-only environment variables
Name | Description | Value |
---|---|---|
GRAFANA_BASE_DIR | Grafana installation directory. | ${BITNAMI_ROOT_DIR}/grafana |
GRAFANA_BIN_DIR | Grafana directory for binary executables. | ${GRAFANA_BASE_DIR}/bin |
GRAFANA_CONF_DIR | Grafana directory for configuration. | ${GRAFANA_BASE_DIR}/conf |
GRAFANA_DAEMON_USER | Grafana system user. | grafana |
GRAFANA_DAEMON_GROUP | Grafana system group. | grafana |
GF_VOLUME_DIR | Grafana volume directory. | ${BITNAMI_VOLUME_DIR}/grafana |
GF_OP_PATHS_CONFIG | Grafana Operator configuration directory. | /etc/grafana/grafana.ini |
GF_OP_PATHS_DATA | Grafana Operator directory for data files. | /var/lib/grafana |
GF_OP_PATHS_LOGS | Grafana Operator directory for log files. | /var/log/grafana |
GF_OP_PATHS_PROVISIONING | Grafana Operator directory for provisioning configurations. | /etc/grafana/provisioning |
GF_OP_PLUGINS_INIT_DIR | Grafana Operator directory for plugins. | /opt/plugins |
Update the grafana.ini
configuration file in the /opt/bitnami/grafana/conf
directory to override default configuration options. You only need to add the options you want to override. Config files are applied in the order of:
grafana.ini
default.ini
To enable development mode, edit the grafana.ini
file and set app_mode = development
.
Override the /opt/bitnami/grafana/conf/grafana.ini
file mounting a volume.
docker run --name grafana-node -v /path/to/grafana.ini:/opt/bitnami/grafana/conf/grafana.ini bitnami/grafana:latest
After that, your configuration will be taken into account in the server's behaviour.
You can also do this by changing the docker-compose.yml
file present in this repository:
grafana:
...
volumes:
- /path/to/grafana.ini:/opt/bitnami/grafana/conf/grafana.ini
...
You can customize this image and include the plugins you desire editing the list of plugins avilable in the script (see the variable "grafana_plugin_list") and build your own image as shown below:
cd 10/debian-12
docker build -t your-custom-grafana .
Install plugins at initialization
When you start the Grafana image, you can specify a comma, semi-colon or space separated list of plugins to install by setting the env. variable GF_INSTALL_PLUGINS
. The entries in GF_INSTALL_PLUGINS
have three different formats:
plugin_id
: This will download the latest plugin version with name plugin_id
from the official Grafana plugins page.plugin_id:plugin_version
: This will download the plugin with name plugin_id
and version plugin_version
from the official Grafana plugins page.plugin_id=url
: This will download the plugin with name plugin_id
using the zip file specified in url
. In case you want to skip TLS verification, set the variable GF_INSTALL_PLUGINS_SKIP_TLS
to yes
.For Docker Compose, add the variable name and value under the application section:
grafana:
...
environment:
- GF_INSTALL_PLUGINS=grafana-clock-panel:1.1.0,grafana-kubernetes-app,worldpring=https://github.com/raintank/worldping-app/releases/download/v1.2.6/worldping-app-release-1.2.6.zip
...
For manual execution add a -e
option with each variable and value:
docker run -d --name grafana -p 3000:3000 \
-e GF_INSTALL_PLUGINS="grafana-clock-panel:1.1.0,grafana-kubernetes-app,worldpring=https://github.com/raintank/worldping-app/releases/download/v1.2.6/worldping-app-release-1.2.6.zip" \
bitnami/grafana:latest
Grafana Image Renderer plugin
You can install the Grafana Image Renderer plugin to handle rendering panels and dashboards as PNG images. To install the plugin, follow the instructions described in the previous section.
As an alternative to install this plugin, you can use the Grafana Image Renderer container to set another Docker container for rendering and using remote rendering. We highly recommend to use this option. In the Docker Compose below you can see an example to use this container:
version: '2'
services:
grafana:
image: bitnami/grafana:6
ports:
- '3000:3000'
environment:
GF_SECURITY_ADMIN_PASSWORD: "bitnami"
GF_RENDERING_SERVER_URL: "http://grafana-image-renderer:8080/render"
GF_RENDERING_CALLBACK_URL: "http://grafana:3000/"
grafana-image-renderer:
image: bitnami/grafana-image-renderer:1
ports:
- '8080:8080'
environment:
HTTP_HOST: "0.0.0.0"
HTTP_PORT: "8080"
ENABLE_METRICS: 'true'
The Bitnami Grafana Docker image sends the container logs to the stdout
. To view the logs:
docker logs grafana
You can configure the containers logging driver using the --log-driver
option if you wish to consume the container logs differently. In the default configuration docker uses the json-file
driver.
Bitnami provides up-to-date versions of grafana, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
Step 1: Get the updated image
docker pull bitnami/grafana:latest
Step 2: Stop and backup the currently running container
Stop the currently running container using the command
docker stop grafana
Next, take a snapshot of the persistent volume /path/to/grafana-persistence
using:
rsync -a /path/to/grafana-persistence /path/to/grafana-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
You can use this snapshot to restore the database state should the upgrade fail.
Step 3: Remove the currently running container
docker rm -v grafana
Step 4: Run the new image
Re-create your container from the new image, restoring your backup if necessary.
docker run --name grafana bitnami/grafana:latest
The number of plugins included in the image by default has been decreased. This decision is supported by the following reasons:
You can still build your custom image adding your custom plugins or install them during the installization as explained in the Grafana Plugins section.
GF_INSTALL_PLUGINS
environment variable is not set by default anymore. This means it doesn't try to install the grafana-image-renderer
plugin anymore unless you specify it. As an alternative to install this plugin, you can use the Grafana Image Renderer container.grafana-image-renderer
plugin by default anymore since it's not compatible with K8s distros with IPv6 disable. Instead, the GF_INSTALL_PLUGINS
environment variable is set by default including this plugin so it's installed during the container's initialization, users can easily avoid it by overwriting the environment variable.docker-compose.yaml
Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart.
If you detect any issue in the docker-compose.yaml
file, feel free to report it or contribute with a fix by following our Contributing Guidelines.
We'd love for you to contribute to this container. You can request new features by creating an issue or submitting a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to fill the issue template.
Copyright © 2024 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
Licensed 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.