mirror of
https://github.com/bitnami/containers.git
synced 2026-03-23 14:57:41 +08:00
[bitnami/*] Fix markdown linter issues (#23945)
* [bitnami/*] Fix markdown linter issues Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Add leftovers Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Update CODE_OF_CONDUCT.md Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com> Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com> * Update CONTRIBUTING.md Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Update bitnami/zookeeper/README.md Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com> Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com> * Linter fix Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Order lists Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Fix markdown Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Order lists Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> --------- Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> Signed-off-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com> Co-authored-by: Andrés Bono <andresbonojimenez@gmail.com>
This commit is contained in:
Carlos Rodríguez Hernández
committed by
GitHub
GitHub
parent
9d243a6d23
commit
d7bd442eba
@@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
$ docker run --name grafana-image-renderer bitnami/grafana-image-renderer:latest
|
||||
docker run --name grafana-image-renderer bitnami/grafana-image-renderer:latest
|
||||
```
|
||||
|
||||
## Why use Bitnami Images?
|
||||
@@ -46,21 +46,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
|
||||
The recommended way to get the Bitnami Grafana Image Renderer Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/grafana-image-renderer).
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/grafana-image-renderer:latest
|
||||
docker pull bitnami/grafana-image-renderer:latest
|
||||
```
|
||||
|
||||
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/grafana-image-renderer/tags/) in the Docker Hub Registry.
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/grafana-image-renderer:[TAG]
|
||||
docker pull bitnami/grafana-image-renderer:[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.
|
||||
|
||||
```console
|
||||
$ git clone https://github.com/bitnami/containers.git
|
||||
$ cd bitnami/APP/VERSION/OPERATING-SYSTEM
|
||||
$ docker build -t bitnami/APP:latest .
|
||||
git clone https://github.com/bitnami/containers.git
|
||||
cd bitnami/APP/VERSION/OPERATING-SYSTEM
|
||||
docker build -t bitnami/APP:latest .
|
||||
```
|
||||
|
||||
## Connecting to other containers
|
||||
@@ -74,7 +74,7 @@ Containers attached to the same network can communicate with each other using th
|
||||
#### Step 1: Create a network
|
||||
|
||||
```console
|
||||
$ docker network create my-network --driver bridge
|
||||
docker network create my-network --driver bridge
|
||||
```
|
||||
|
||||
#### Step 2: Launch the grafana-image-renderer container within your network
|
||||
@@ -82,7 +82,7 @@ $ docker network create my-network --driver bridge
|
||||
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `my-network` network.
|
||||
|
||||
```console
|
||||
$ docker run -d --name grafana-image-renderer \
|
||||
docker run -d --name grafana-image-renderer \
|
||||
--env HTTP_PORT="8080" \
|
||||
--env HTTP_HOST="0.0.0.0" \
|
||||
--network my-network \
|
||||
@@ -94,7 +94,7 @@ $ docker run -d --name grafana-image-renderer \
|
||||
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `my-network` network.
|
||||
|
||||
```console
|
||||
$ docker run -d --name grafana \
|
||||
docker run -d --name grafana \
|
||||
--network my-network \
|
||||
--publish 3000:3000 \
|
||||
--env GF_RENDERING_SERVER_URL="http://grafana-image-renderer:8080/render" \
|
||||
@@ -146,7 +146,7 @@ vi /path/to/grafana-image-renderer-conf/config.json
|
||||
After changing the configuration, restart your Grafana Image Renderer container for changes to take effect. Using Docker Compose:
|
||||
|
||||
```console
|
||||
$ docker-compose restart grafana-image-renderer
|
||||
docker-compose restart grafana-image-renderer
|
||||
```
|
||||
|
||||
After that, your configuration will be taken into account in the server's behaviour.
|
||||
@@ -156,7 +156,7 @@ After that, your configuration will be taken into account in the server's behavi
|
||||
The Bitnami Grafana Image Renderer Docker image sends the container logs to the `stdout`. To view the logs:
|
||||
|
||||
```console
|
||||
$ docker logs grafana-image-renderer
|
||||
docker logs grafana-image-renderer
|
||||
```
|
||||
|
||||
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
|
||||
@@ -170,7 +170,7 @@ Bitnami provides up-to-date versions of Grafana Image Renderer, including securi
|
||||
#### Step 1: Get the updated image
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/grafana-image-renderer:latest
|
||||
docker pull bitnami/grafana-image-renderer:latest
|
||||
```
|
||||
|
||||
#### Step 2: Stop the currently running container
|
||||
@@ -178,13 +178,13 @@ $ docker pull bitnami/grafana-image-renderer:latest
|
||||
Stop the currently running container using the command
|
||||
|
||||
```console
|
||||
$ docker stop grafana-image-renderer
|
||||
docker stop grafana-image-renderer
|
||||
```
|
||||
|
||||
#### Step 3: Remove the currently running container
|
||||
|
||||
```console
|
||||
$ docker rm -v grafana-image-renderer
|
||||
docker rm -v grafana-image-renderer
|
||||
```
|
||||
|
||||
#### Step 4: Run the new image
|
||||
@@ -192,7 +192,7 @@ $ docker rm -v grafana-image-renderer
|
||||
Re-create your container from the new image:
|
||||
|
||||
```console
|
||||
$ docker run --name grafana-image-renderer bitnami/grafana-image-renderer:latest
|
||||
docker run --name grafana-image-renderer bitnami/grafana-image-renderer:latest
|
||||
```
|
||||
|
||||
## Contributing
|
||||
@@ -211,7 +211,7 @@ 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
|
||||
<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,
|
||||
|
||||
Reference in New Issue
Block a user