apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Docs: Update docker image names for oss-specific Grafana image and channel (#39443)

Browse Source 
* Initial draft

* Added the what's new in 8.2 link to the what's new parent page

* Docker image namespace change for grafana-oss

* Additional changes and inclusion of Enterprise Docker image namespace and examples

* Fixed language related to Ubuntu-specific images, fixed some markdown and updated some version references

* Fixed enterprise image name because apparently I don't read too well
pull/39750/head
Petros Kolyvas 4 years ago committed by GitHub
parent 06592410b2
commit c4adf5be8e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 19 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 48
      docs/sources/installation/docker.md

48
docs/sources/installation/docker.md
Unescape View File

@ -3,11 +3,18 @@ title = "Run Grafana Docker image"
description = "Guide for running Grafana using Docker"
keywords = ["grafana", "configuration", "documentation", "docker"]
weight = 600
+++
# Run Grafana Docker image
You can install and run Grafana using the official Docker image. It comes in two variants: Alpine and Ubuntu.
You can install and run Grafana using the official Docker images. Our docker images come in two editions:
**Grafana Enterprise**: `grafana/grafana-enterprise`
**Grafana Open Source**: `grafana/grafana-oss`
Each edition is available in two variants: Alpine and Ubuntu. See below.
This page also contains important information about [migrating from earlier Docker image versions](#migrate-from-previous-docker-containers-versions).
@ -17,21 +24,23 @@ You can run Grafana on your own hardware or use [Grafana Cloud](https://grafana.
## Alpine image (recommended)
`grafana/grafana:<version>`
**Grafana Enterprise edition**: `grafana/grafana-enterprise:<version>`
**Grafana Open Source edition**: `grafana/grafana-oss:<version>`
This is the default image. It's based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the Alpine official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images, and thus leads to slimmer and more secure images.
The default images are based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the Alpine official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images, and thus leads to slimmer and more secure images.
This variant is highly recommended when security and final image size being as small as possible is desired. The main caveat to note is that it uses [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software don't have an issue with this, so this variant is usually a very safe choice.
The Alpine variant is highly recommended when security and final image size being as small as possible is desired. The main caveat to note is that it uses [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software don't have an issue with this, so this variant is usually a very safe choice.
> **Note:** The `grafana/grafana:<version>` image was based on [Ubuntu](https://ubuntu.com/) before version 6.4.0.
> **Note:** Grafana docker images were based on [Ubuntu](https://ubuntu.com/) prior to version 6.4.0.
## Ubuntu image
`grafana/grafana:<version>-ubuntu`
**Grafana Enterprise edition**: `grafana/grafana-enterprise:<version>-ubuntu`
This image is based on [Ubuntu](https://ubuntu.com/), available in [the Ubuntu official image](https://hub.docker.com/_/ubuntu). It is an alternative image for those who prefer an [Ubuntu](https://ubuntu.com/) based image and/or are dependent on certain tooling not available for Alpine.
**Grafana Open Source edition**: `grafana/grafana-oss:<version>-ubuntu`
> **Note:** The `grafana/grafana:<version>-ubuntu` image is available for Grafana version 6.5.0 and later.
These images are based on [Ubuntu](https://ubuntu.com/), available in [the Ubuntu official image](https://hub.docker.com/_/ubuntu). It is an alternative image for those who prefer an [Ubuntu](https://ubuntu.com/) based image and/or are dependent on certain tooling not available for Alpine.
## Run Grafana
@ -42,7 +51,7 @@ You can run the latest Grafana version, run a specific version, or run an unstab
> **Note:** If you are on a Linux system, you might need to add `sudo` before the command.
```bash
docker run -d -p 3000:3000 grafana/grafana
docker run -d -p 3000:3000 grafana/grafana-enterprise
```
### Run a specific version of Grafana
@ -50,22 +59,22 @@ docker run -d -p 3000:3000 grafana/grafana
> **Note:** If you are on a Linux system, you might need to add `sudo` before the command.
```bash
docker run -d -p 3000:3000 --name grafana grafana/grafana:<version number>
docker run -d -p 3000:3000 --name grafana grafana/grafana-enterprise:<version number>
```
**Example:**
```bash
docker run -d -p 3000:3000 --name grafana grafana/grafana:6.5.0
docker run -d -p 3000:3000 --name grafana grafana/grafana-enterprise:8.2.0
```
### Run the Grafana main branch
For every successful build of the main branch, we update the `grafana/grafana:main` and `grafana/grafana:main-ubuntu` tags. Additionally, two new tags are created, `grafana/grafana-dev:<version>-<build ID>pre` and `grafana/grafana-dev:<version>-<build ID>pre-ubuntu`, where _version_ is the next version of Grafana and _build ID_ is the ID of the corresponding CI build. Use these to get access to the latest main builds of Grafana.
For every successful build of the main branch, we update the `grafana/grafana-oss:main` and `grafana/grafana-oss:main-ubuntu` tags. Additionally, two new tags are created, `grafana/grafana-oss-dev:<version>-<build ID>pre` and `grafana/grafana-oss-dev:<version>-<build ID>pre-ubuntu`, where _version_ is the next version of Grafana and _build ID_ is the ID of the corresponding CI build. Use these to get access to the latest main builds of Grafana.
When running Grafana main in production, we _strongly_ recommend that you use the `grafana/grafana-dev:<version>-<build ID>pre` tag. This tag guarantees that you use a specific version of Grafana instead of whatever was the most recent commit at the time.
When running Grafana main in production, we _strongly_ recommend that you use the `grafana/grafana-oss-dev:<version>-<build ID>pre` tag. This tag guarantees that you use a specific version of Grafana instead of whatever was the most recent commit at the time.
For a list of available tags, check out [grafana/grafana](https://hub.docker.com/r/grafana/grafana/tags/) and [grafana/grafana-dev](https://hub.docker.com/r/grafana/grafana-dev/tags/).
For a list of available tags, check out [grafana/grafana-oss](https://hub.docker.com/r/grafana/grafana-oss/tags/) and [grafana/grafana-oss-dev](https://hub.docker.com/r/grafana/grafana-oss-dev/tags/).
## Install plugins in the Docker container
@ -80,7 +89,7 @@ docker run -d \
-p 3000:3000 \
--name=grafana \
-e "GF_INSTALL_PLUGINS=grafana-clock-panel,grafana-simple-json-datasource" \
grafana/grafana
grafana/grafana-enterprise
```
> **Note:** If you need to specify the version of a plugin, then you can add it to the `GF_INSTALL_PLUGINS` environment variable. Otherwise, the latest is used. For example: `-e "GF_INSTALL_PLUGINS=grafana-clock-panel 1.0.1,grafana-simple-json-datasource 1.3.5"`.
@ -96,7 +105,7 @@ docker run -d \
-p 3000:3000 \
--name=grafana \
-e "GF_INSTALL_PLUGINS=http://plugin-domain.com/my-custom-plugin.zip;custom-plugin,grafana-clock-panel" \
grafana/grafana
grafana/grafana-enterprise
```
## Build and run a Docker image with pre-installed plugins
@ -209,7 +218,7 @@ There are two possible solutions to this problem. Either you start the new conta
##### Run Docker as a different user
```bash
docker run --user 104 --volume "<your volume mapping here>" grafana/grafana:5.1.0
docker run --user 104 --volume "<your volume mapping here>" grafana/grafana-enterprise:8.2.0
```
##### Specify a user in docker-compose.yml
@ -219,7 +228,7 @@ version: '2'
services:
grafana:
image: grafana/grafana:5.1.0
image: grafana/grafana-enterprise:8.2.0
ports:
- 3000:3000
user: '104'
@ -230,7 +239,7 @@ services:
The commands below run bash inside the Grafana container with your volume mapped in. This makes it possible to modify the file ownership to match the new container. Always be careful when modifying permissions.
```bash
$ docker run -ti --user root --volume "<your volume mapping here>" --entrypoint bash grafana/grafana:5.1.0
$ docker run -ti --user root --volume "<your volume mapping here>" --entrypoint bash grafana/grafana-enterprise:8.2.0
# in the container you just started:
chown -R root:root /etc/grafana && \
@ -250,3 +259,4 @@ Refer to [Configure a Grafana Docker image]({{< relref "../administration/config
## Configure Grafana
Refer to the [Configuration]({{< relref "../administration/configuration.md" >}}) page for details on options for customizing your environment, logging, database, and so on.

Write Preview
Loading…
Cancel
Save