From e47b07ed194326bff028bd2422a2a6e03d272539 Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Wed, 20 Oct 2021 14:37:49 +0100 Subject: [PATCH] Docs: Updated docker image names for consistency (#40426) (#40655) * Updated the docker image names and added a note * Updated the example version to current (cherry picked from commit 38709df33b6c6b3929ec829efa8dca21b2ea4e17) Co-authored-by: Petros Kolyvas --- docs/sources/administration/configure-docker.md | 10 ++++++---- docs/sources/installation/docker.md | 4 ++-- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/sources/administration/configure-docker.md b/docs/sources/administration/configure-docker.md index b9af57db34b..777453c0c85 100644 --- a/docs/sources/administration/configure-docker.md +++ b/docs/sources/administration/configure-docker.md @@ -10,6 +10,8 @@ weight = 200 If you are running Grafana in a Docker image, then you configure Grafana using [environment variables]({{< relref "../administration/configuration.md#configure-with-environment-variables" >}}) rather than directly editing the configuration file. If you want to save your data, then you also need to designate persistent storage or bind mounts for the Grafana container. +> **Note:** These examples use the Grafana Enterprise docker image. You can use the Grafana Open Source edition by changing the docker image to `grafana/grafana-oss`. + ## Save your Grafana data If you do not designate a location for information storage, then all your Grafana data disappears as soon as you stop your container. To save your data, you need to set up persistent storage or bind mounts for your container. @@ -21,7 +23,7 @@ If you do not designate a location for information storage, then all your Grafan docker volume create grafana-storage # start grafana -docker run -d -p 3000:3000 --name=grafana -v grafana-storage:/var/lib/grafana grafana/grafana +docker run -d -p 3000:3000 --name=grafana -v grafana-storage:/var/lib/grafana grafana/grafana-enterprise ``` ### Run Grafana container using bind mounts @@ -33,7 +35,7 @@ mkdir data # creates a folder for your data ID=$(id -u) # saves your user id in the ID variable # starts grafana with your user id and using the data folder -docker run -d --user $ID --volume "$PWD/data:/var/lib/grafana" -p 3000:3000 grafana/grafana:7.2.1 +docker run -d --user $ID --volume "$PWD/data:/var/lib/grafana" -p 3000:3000 grafana/grafana-enterprise:8.2.1 ``` ## Default paths @@ -57,7 +59,7 @@ Example: ```bash # Run Grafana while logging to both standard out and /var/log/grafana/grafana.log -docker run -p 3000:3000 -e "GF_LOG_MODE=console file" grafana/grafana +docker run -p 3000:3000 -e "GF_LOG_MODE=console file" grafana/grafana-enterprise ``` ## Configure Grafana with Docker Secrets @@ -83,7 +85,7 @@ docker run -d \ -e "GF_AWS_default_ACCESS_KEY_ID=YOUR_ACCESS_KEY" \ -e "GF_AWS_default_SECRET_ACCESS_KEY=YOUR_SECRET_KEY" \ -e "GF_AWS_default_REGION=us-east-1" \ -grafana/grafana +grafana/grafana-enterprise ``` You may also specify multiple profiles to `GF_AWS_PROFILES` (e.g. diff --git a/docs/sources/installation/docker.md b/docs/sources/installation/docker.md index 4032619d037..4233f7652a6 100755 --- a/docs/sources/installation/docker.md +++ b/docs/sources/installation/docker.md @@ -39,7 +39,7 @@ You can run the latest Grafana version, run a specific version, or run an unstab ### Run the latest stable version of Grafana -> **Note:** If you are on a Linux system, you might need to add `sudo` before the command. +> **Note:** If you are on a Linux system, you might need to add `sudo` before the command or add your user to the `docker` group. ```bash docker run -d -p 3000:3000 grafana/grafana @@ -47,7 +47,7 @@ docker run -d -p 3000:3000 grafana/grafana ### Run a specific version of Grafana -> **Note:** If you are on a Linux system, you might need to add `sudo` before the command. +> **Note:** If you are on a Linux system, you might need to add `sudo` before the command add your user to the `docker` group. ```bash docker run -d -p 3000:3000 --name grafana grafana/grafana: