Docs: Adding how to use plugin version, through docker env variable #19924

joachimlindborg · 2019-10-19T13:46:37Z

It was unclear if one can specify the plugin version to the environment variable when installing plugins when instatiating the docker componen. It is possible and works fine.
Added some text to the documentation

Tested towards grafana 5.3.4

This PR clarifies documentation / love your work:

*fixes documentation:

Fixes #

Special notes for your reviewer:

It was unclear if one can specify the plugin version to the environment variable. It is possible and works fine. Added it to the plugin information.

CLAassistant · 2019-10-19T13:47:34Z

All committers have signed the CLA.

docs/sources/installation/docker.md

olivierlemasle · 2019-10-22T22:00:38Z

docs/sources/installation/docker.md

@@ -87,7 +87,7 @@ docker run \

 ## Building a custom Grafana image with pre-installed plugins

-In the [grafana-docker](https://github.com/grafana/grafana/tree/master/packaging/docker)  there is a folder called `custom/` which includes a `Dockerfile` that can be used to build a custom Grafana image.  It accepts `GRAFANA_VERSION` and `GF_INSTALL_PLUGINS` as build arguments.
+In the [grafana-docker](https://github.com/grafana/grafana/tree/master/packaging/docker)  there is a folder called `custom/` which includes a `Dockerfile` that can be used to build a custom Grafana image.  It accepts `GRAFANA_VERSION` and `GF_INSTALL_PLUGINS` as build arguments. If you need to specify a specific plugin version you can add version to plugin evnironment variable `--build-arg "GF_INSTALL_PLUGINS=grafana-clock-panel 1.0.1,grafana-simple-json-datasource"`


same typo here.

hope I fixed it right now

The typo is not fixed.

Same here, I would propose to move the new sentence under the example block so the reader will have a better understanding of the whole context since first there will be the simpler example and under there will be the more specific one.

There is also a missing . at the end of the sentence.

papagian · 2019-10-30T17:44:30Z

docs/sources/installation/docker.md

@@ -74,7 +74,7 @@ For a list of available tags, check out [grafana/grafana](https://hub.docker.com

 ## Installing Plugins for Grafana

-Pass the plugins you want installed to docker with the `GF_INSTALL_PLUGINS` environment variable as a comma separated list. This will pass each plugin name to `grafana-cli plugins install ${plugin}` and install them when Grafana starts.
+Pass the plugins you want installed to docker with the `GF_INSTALL_PLUGINS` environment variable as a comma separated list. This will pass each plugin name to `grafana-cli plugins install ${plugin}` and install them when Grafana starts. If you need to specify a specific plugin version you can add optional version to plugin environment variable otherwise latest will be assumed `--build-arg "GF_INSTALL_PLUGINS=grafana-clock-panel 1.0.1,grafana-simple-json-datasource 1.3.5"`


There is a missing . at the end of the sentence.
Also, instead of --build-arg should be -e since the example below is a docker run instead of a docker build command.
Finally, I would propose to move the new sentence under the example docker run so the reader will have a better understanding of the whole context.

papagian

Thank you a lot for contributing this.
Please check my comments for some some modifications I have asked.

Moved the information to make it more readable, fixed typos and added missing punctuation.

papagian · 2019-10-31T07:44:22Z

docs/sources/installation/docker.md

@@ -85,6 +85,8 @@ docker run \
  grafana/grafana
 ```

+> If you need to specify the version of a plugin, you can add it to the command. Otherwise latest will be assumed. `-e "GF_INSTALL_PLUGINS=grafana-clock-panel 1.0.1,grafana-simple-json-datasource 1.3.5"`


Great, I liked the idea that you have used notes!
I also preferred it as it was before the last modification, so I would change it to:

If you need to specify the version of a plugin, you can add it to the GF_INSTALL_PLUGINS environment variable. Otherwise, the latest will be assumed.
For example: -e "GF_INSTALL_PLUGINS=grafana-clock-panel 1.0.1,grafana-simple-json-datasource 1.3.5"

papagian · 2019-10-31T07:45:31Z

docs/sources/installation/docker.md

@@ -103,6 +105,8 @@ docker run \
  grafana:latest-with-plugins
 ```

+> If you need to specify the version of a plugin, you can add it to the build argument. Otherwise latest will be assumed. `--build-arg "GF_INSTALL_PLUGINS=grafana-clock-panel 1.0.1,grafana-simple-json-datasource 1.3.5"`


Same here, I would change it to:

If you need to specify the version of a plugin, you can add it to the GF_INSTALL_PLUGINS build argument. Otherwise, the latest will be assumed.
For example: --build-arg "GF_INSTALL_PLUGINS=grafana-clock-panel 1.0.1,grafana-simple-json-datasource 1.3.5"

papagian

Thank you for making the requested modifications.
I would recommend some minor changes before finally merging it.

More feedback, added example text. Did not manage to get newline for the example.

docs/sources/installation/docker.md

papagian

Great, thanks!
I have asked for a minor modification before merging it.

papagian

Great, thank you for your contribution.

Adding grafan plugin version info

1c73d53

It was unclear if one can specify the plugin version to the environment variable. It is possible and works fine. Added it to the plugin information.

marefr mentioned this pull request Oct 22, 2019

Docker: Allow installing specific plugin versions #19488

Closed

olivierlemasle suggested changes Oct 22, 2019

View reviewed changes

Update typo docs/sources/installation/docker.md

f04d4d1

marefr added area/backend type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project labels Oct 30, 2019

papagian reviewed Oct 30, 2019

View reviewed changes

papagian requested changes Oct 30, 2019

View reviewed changes

Applied all comments

f0dd286

Moved the information to make it more readable, fixed typos and added missing punctuation.

papagian reviewed Oct 31, 2019

View reviewed changes

papagian self-requested a review October 31, 2019 07:45

papagian requested changes Oct 31, 2019

View reviewed changes

papagian added the pr/external This PR is from external contributor label Oct 31, 2019

Rewording and better example

9b381a8

More feedback, added example text. Did not manage to get newline for the example.

papagian reviewed Nov 4, 2019

View reviewed changes

docs/sources/installation/docker.md Show resolved Hide resolved

papagian self-requested a review November 4, 2019 07:57

papagian requested changes Nov 4, 2019

View reviewed changes

marcusolsson added the pr/changes-needed label Nov 5, 2019

joachimlindborg requested a review from papagian November 6, 2019 23:50

added the missing space

47b77ed

papagian approved these changes Nov 7, 2019

View reviewed changes

papagian changed the title ~~Adding how to use plugin version, through docker env variable~~ Docs: Adding how to use plugin version, through docker env variable Nov 7, 2019

papagian merged commit a883350 into grafana:master Nov 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Adding how to use plugin version, through docker env variable #19924

Docs: Adding how to use plugin version, through docker env variable #19924

joachimlindborg commented Oct 19, 2019

CLAassistant commented Oct 19, 2019 •

edited

Loading

olivierlemasle Oct 22, 2019

joachimlindborg Oct 24, 2019

papagian Oct 30, 2019

papagian Oct 30, 2019

papagian Oct 30, 2019

papagian Oct 30, 2019

papagian left a comment

papagian Oct 31, 2019

papagian Oct 31, 2019

papagian left a comment

papagian left a comment

papagian left a comment

Docs: Adding how to use plugin version, through docker env variable #19924

Docs: Adding how to use plugin version, through docker env variable #19924

Conversation

joachimlindborg commented Oct 19, 2019

CLAassistant commented Oct 19, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

papagian left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

papagian left a comment

Choose a reason for hiding this comment

papagian left a comment

Choose a reason for hiding this comment

papagian left a comment

Choose a reason for hiding this comment

CLAassistant commented Oct 19, 2019 •

edited

Loading