Bitnami/containers
2
0
Fork 0
mirror of https://github.com/bitnami/containers.git synced 2026-03-21 07:18:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

[bitnami/*] Fix markdown linter issues (#23945)

Browse Source 
* [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
2023-02-16 11:38:13 +01:00
committed by GitHub
parent 9d243a6d23
commit d7bd442eba
218 changed files with 6677 additions and 6711 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
bitnami/sonarqube/README.md
View File

@@ -11,8 +11,8 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/sonarqube/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/sonarqube/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
@@ -43,21 +43,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami SonarQube&trade; Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/sonarqube).
```console
$ docker pull bitnami/sonarqube:latest
docker pull bitnami/sonarqube: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/sonarqube/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/sonarqube:[TAG]
docker pull bitnami/sonarqube:[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 .
```
## How to use this image
@@ -69,8 +69,8 @@ SonarQube&trade; requires access to a PostgreSQL database to store information.
The main folder of this repository contains a functional [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/sonarqube/docker-compose.yml) file. Run the application using it as shown below:
```console
$ curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/sonarqube/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/sonarqube/docker-compose.yml > docker-compose.yml
docker-compose up -d
```
### Using the Docker Command Line
@@ -80,14 +80,14 @@ If you want to run the application manually instead of using `docker-compose`, t
#### Step 1: Create a network
```console
$ docker network create sonarqube-network
docker network create sonarqube-network
```
#### Step 2: Create a volume for PostgreSQL persistence and create a PostgreSQL container
```console
$ docker volume create --name postgresql_data
$ docker run -d --name postgresql \
docker volume create --name postgresql_data
docker run -d --name postgresql \
--env ALLOW_EMPTY_PASSWORD=yes \
--env POSTGRESQL_USERNAME=bn_sonarqube \
--env POSTGRESQL_PASSWORD=bitnami \
@@ -100,8 +100,8 @@ $ docker run -d --name postgresql \
#### Step 3: Create volumes for SonarQube&trade; persistence and launch the container
```console
$ docker volume create --name sonarqube_data
$ docker run -d --name sonarqube \
docker volume create --name sonarqube_data
docker run -d --name sonarqube \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env SONARQUBE_DATABASE_USER=bn_sonarqube \
@@ -155,13 +155,13 @@ This requires a minor change to the [`docker-compose.yml`](https://github.com/bi
#### Step 1: Create a network (if it does not exist)
```console
$ docker network create sonarqube-network
docker network create sonarqube-network
```
#### Step 2. Create a PostgreSQL container with host volume
```console
$ docker run -d --name postgresql \
docker run -d --name postgresql \
--env ALLOW_EMPTY_PASSWORD=yes \
--env POSTGRESQL_USERNAME=bn_sonarqube \
--env POSTGRESQL_PASSWORD=bitnami \
@@ -174,7 +174,7 @@ $ docker run -d --name postgresql \
#### Step 3. Create the SonarQube&trade; container with host volumes
```console
$ docker run -d --name sonarqube \
docker run -d --name sonarqube \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--env SONARQUBE_DATABASE_USER=bn_sonarqube \
@@ -204,7 +204,7 @@ When you start the SonarQube&trade; image, you can adjust the configuration of t
- For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name sonarqube -p 80:8080 -p 443:8443 \
docker run -d --name sonarqube -p 80:8080 -p 443:8443 \
--env SONARQUBE_PASSWORD=my_password \
--network sonarqube-tier \
--volume /path/to/sonarqube-persistence:/bitnami \
@@ -213,7 +213,7 @@ When you start the SonarQube&trade; image, you can adjust the configuration of t
Available environment variables:
##### User and Site configuration
#### User and Site configuration
- `SONARQUBE_USERNAME`: SonarQube&trade; application username. Default: **admin**
- `SONARQUBE_PASSWORD`: SonarQube&trade; application password. Default: **bitnami**
@@ -230,7 +230,7 @@ Available environment variables:
- `SONARQUBE_EXTRA_PROPERTIES`: Comma separated list of properties to be set in the sonar.properties file, e.g. `my.sonar.property1=property_value,my.sonar.property2=property_value`. No defaults.
- `SONARQUBE_START_TIMEOUT`: Timeout for the application to start in seconds. Default: **300**.
##### Database connection configuration
#### Database connection configuration
- `SONARQUBE_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
- `SONARQUBE_DATABASE_PORT_NUMBER`: Port used by the PostgreSQL server. Default: **5432**
@@ -239,7 +239,7 @@ Available environment variables:
- `SONARQUBE_DATABASE_PASSWORD`: Database password that SonarQube&trade; will use to connect with the database. No default.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### Create a database for SonarQube&trade; using postgresql-client
#### Create a database for SonarQube&trade; using postgresql-client
- `POSTGRESQL_CLIENT_DATABASE_HOST`: Hostname for the PostgreSQL server. Default: **postgresql**
- `POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by the PostgreSQL server. Default: **5432**
@@ -252,7 +252,7 @@ Available environment variables:
- `POSTGRESQL_CLIENT_EXECUTE_SQL`: SQL code to execute in the PostgreSQL server. No defaults.
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
##### SMTP Configuration
#### SMTP Configuration
To configure SonarQube&trade; to send email using SMTP you can set the following environment variables:
@@ -287,7 +287,7 @@ This would be an example of SMTP configuration using a Gmail account:
- For manual execution:
```console
$ docker run -d --name sonarqube -p 80:8080 -p 443:8443 \
docker run -d --name sonarqube -p 80:8080 -p 443:8443 \
--env SONARQUBE_DATABASE_USER=bn_sonarqube \
--env SONARQUBE_DATABASE_NAME=bitnami_sonarqube \
--env SONARQUBE_SMTP_HOST=smtp.gmail.com \
@@ -322,7 +322,7 @@ The Bitnami SonarQube&trade; container supports connecting the SonarQube&trade;
- For manual execution:
```console
$ docker run -d --name sonarqube\
docker run -d --name sonarqube\
-p 8080:8080 -p 8443:8443 \
--network sonarqube-network \
--env SONARQUBE_DATABASE_HOST=mariadb_host \
@@ -341,13 +341,13 @@ In case the database already contains data from a previous SonarQube&trade; inst
The Bitnami SonarQube&trade; Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs sonarqube
docker logs sonarqube
```
Or using Docker Compose:
```console
$ docker-compose logs sonarqube
docker-compose logs sonarqube
```
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.
@@ -361,13 +361,13 @@ To backup your data, configuration and logs, follow these simple steps:
#### Step 1: Stop the currently running container
```console
$ docker stop sonarqube
docker stop sonarqube
```
Or using Docker Compose:
```console
$ docker-compose stop sonarqube
docker-compose stop sonarqube
```
#### Step 2: Run the backup command
@@ -375,7 +375,7 @@ $ docker-compose stop sonarqube
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
```console
$ docker run --rm -v /path/to/sonarqube-backups:/backups --volumes-from sonarqube busybox \
docker run --rm -v /path/to/sonarqube-backups:/backups --volumes-from sonarqube busybox \
cp -a /bitnami/sonarqube /backups/latest
```
@@ -386,7 +386,7 @@ Restoring a backup is as simple as mounting the backup as volumes in the contain
For the PostgreSQL database container:
```diff
$ docker run -d --name postgresql \
docker run -d --name postgresql \
...
- --volume /path/to/postgresql-persistence:/bitnami/postgresql \
+ --volume /path/to/postgresql-backups/latest:/bitnami/postgresql \
@@ -396,7 +396,7 @@ For the PostgreSQL database container:
For the SonarQube&trade; container:
```diff
$ docker run -d --name sonarqube \
docker run -d --name sonarqube \
...
- --volume /path/to/sonarqube-persistence:/bitnami/sonarqube \
+ --volume /path/to/sonarqube-backups/latest:/bitnami/sonarqube \
@@ -405,14 +405,14 @@ For the SonarQube&trade; container:
### Upgrade this image
Bitnami provides up-to-date versions of PostgreSQL and SonarQube&trade;, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the SonarQube&trade; container. For the PostgreSQL upgrade see: https://github.com/bitnami/containers/tree/main/bitnami/postgresql/blob/master/README.md#upgrade-this-image
Bitnami provides up-to-date versions of PostgreSQL and SonarQube&trade;, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the SonarQube&trade; container. For the PostgreSQL upgrade see: <https://github.com/bitnami/containers/tree/main/bitnami/postgresql/blob/master/README.md#upgrade-this-image>
The `bitnami/sonarqube:latest` tag always points to the most recent release. To get the most recent release you can simple repull the `latest` tag from the Docker Hub with `docker pull bitnami/sonarqube:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/sonarqube/tags/).
#### Step 1: Get the updated image
```console
$ docker pull bitnami/sonarqube:latest
docker pull bitnami/sonarqube:latest
```
#### Step 2: Stop the running container
@@ -420,7 +420,7 @@ $ docker pull bitnami/sonarqube:latest
Stop the currently running container using the command
```console
$ docker-compose stop sonarqube
docker-compose stop sonarqube
```
#### Step 3: Take a snapshot of the application state
@@ -440,10 +440,10 @@ docker-compose rm -v sonarqube
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
```console
$ docker-compose up -d
docker-compose up -d
```
# Notable Changes
## Notable Changes
### 9.0.0-debian-10-r0
@@ -468,7 +468,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,