Bitnami/containers
2
0
Fork 0
mirror of https://github.com/bitnami/containers.git synced 2026-04-04 16:27:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

[bitnami/several] Fix README linter issues (#27472)

Browse Source 
Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>
This commit is contained in:
Carlos Rodríguez Hernández
2023-03-15 12:42:41 +01:00
committed by GitHub
parent 6622a1561d
commit d23b4bfdc4
22 changed files with 31 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
bitnami/concourse/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Concourse](https://concourse-ci.org/)
## TL;DR
```console

2
bitnami/harbor-core/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Harbor Core](https://goharbor.io/)
## TL;DR
```console

2
bitnami/harbor-exporter/README.md
View File

@@ -6,8 +6,6 @@
[Overview of harbor-exporter](https://github.com/goharbor/harbor)
## TL;DR
This container is part of the [Harbor solution](https://github.com/bitnami/charts/tree/main/bitnami/harbor) that is primarily intended to be deployed in Kubernetes. You can deploy Harbor solution and then enable this specific container with the command below:

2
bitnami/harbor-jobservice/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Harbor Job Service](https://github.com/goharbor/harbor)
## TL;DR
```console

2
bitnami/harbor-registry/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Harbor Registry](https://github.com/goharbor/harbor)
## TL;DR
```console

2
bitnami/harbor-registryctl/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Harbor Registryctl](https://github.com/goharbor/harbor)
## TL;DR
```console

2
bitnami/jaeger/README.md
View File

@@ -6,8 +6,6 @@
[Overview of jaeger](https://www.jaegertracing.io/)
## TL;DR
```console

48
bitnami/jenkins-agent/README.md
View File

@@ -11,7 +11,7 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
$ docker run --name jenkins-agent --env JENKINS_URL=http://jenkins:port bitnami/jenkins-agent:latest <agent-secret> <agent-name>
docker run --name jenkins-agent --env JENKINS_URL=http://jenkins:port bitnami/jenkins-agent:latest <agent-secret> <agent-name>
```
You can find all the available configuration options in the [Environment Variables](#environment-variables) section.
@@ -42,21 +42,21 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht
The recommended way to get the Bitnami Jenkins Agent Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jenkins).
```console
$ docker pull bitnami/jenkins-agent:latest
docker pull bitnami/jenkins-agent: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/jenkins/tags/) in the Docker Hub Registry.
```console
$ docker pull bitnami/jenkins-agent:[TAG]
docker pull bitnami/jenkins-agent:[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 .
```
## Configuration
@@ -65,7 +65,7 @@ $ docker build -t bitnami/APP:latest .
When you start the Jenkins Agent image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
- For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jenkins/docker-compose.yml) file present in this repository:
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jenkins/docker-compose.yml) file present in this repository:
```yaml
jenkins-agent:
@@ -75,7 +75,7 @@ When you start the Jenkins Agent image, you can adjust the configuration of the
...
```
- For manual execution add a `--env` option with each variable and value:
* For manual execution add a `--env` option with each variable and value:
```console
$ docker run -d --name jenkins-agent \
@@ -85,35 +85,35 @@ When you start the Jenkins Agent image, you can adjust the configuration of the
Available environment variables:
##### User and Site configuration
#### User and Site configuration
- `JENKINS_AGENT_WORKDIR`: The working directory of the remoting instance (stores cache and logs by default). Default: **/bitnami/jenkins/home**
- `JENKINS_URL`: Specify the Jenkins root URLs to connect to.
- `JENKINS_AGENT_TUNNEL`: Connect to the specified host and port, instead of connecting directly to Jenkins. Useful when connection to Jenkins needs to be tunneled.
- `JENKINS_AGENT_PROTOCOLS`: Specify the remoting protocols to attempt when instanceIdentity is provided.
- `JENKINS_AGENT_DIRECT_CONNECTION`: Connect directly to this TCP agent port, skipping the HTTP(S) connection.
- `JENKINS_AGENT_INSTANCE_IDENTITY`: The base64 encoded InstanceIdentity byte array of the Jenkins controller.
- `JENKINS_AGENT_WEB_SOCKET`: Make a WebSocket connection to Jenkins rather than using the TCP port. Default: **false**
- `JENKINS_AGENT_SECRET`: Jenkins Agent name.
- `JENKINS_AGENT_NAME`: Jenkins Agent secret.
* `JENKINS_AGENT_WORKDIR`: The working directory of the remoting instance (stores cache and logs by default). Default: **/bitnami/jenkins/home**
* `JENKINS_URL`: Specify the Jenkins root URLs to connect to.
* `JENKINS_AGENT_TUNNEL`: Connect to the specified host and port, instead of connecting directly to Jenkins. Useful when connection to Jenkins needs to be tunneled.
* `JENKINS_AGENT_PROTOCOLS`: Specify the remoting protocols to attempt when instanceIdentity is provided.
* `JENKINS_AGENT_DIRECT_CONNECTION`: Connect directly to this TCP agent port, skipping the HTTP(S) connection.
* `JENKINS_AGENT_INSTANCE_IDENTITY`: The base64 encoded InstanceIdentity byte array of the Jenkins controller.
* `JENKINS_AGENT_WEB_SOCKET`: Make a WebSocket connection to Jenkins rather than using the TCP port. Default: **false**
* `JENKINS_AGENT_SECRET`: Jenkins Agent name.
* `JENKINS_AGENT_NAME`: Jenkins Agent secret.
##### JAVA configuration
#### JAVA configuration
- `JAVA_OPTS`: Customize JVM parameters. No defaults.
- `JAVA_HOME`: Java Home directory. Default: **/opt/bitnami/java**
* `JAVA_OPTS`: Customize JVM parameters. No defaults.
* `JAVA_HOME`: Java Home directory. Default: **/opt/bitnami/java**
## Logging
The Bitnami Jenkins Agent Docker image sends the container logs to `stdout`. To view the logs:
```console
$ docker logs jenkins
docker logs jenkins
```
Or using Docker Compose:
```console
$ docker-compose logs jenkins
docker-compose logs jenkins
```
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.
@@ -150,7 +150,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,

2
bitnami/keycloak/README.md
View File

@@ -86,7 +86,7 @@ The Bitnami Keycloak container can create a default admin user by setting the fo
The Bitnami Keycloak container can connect to a database by setting the following environment variables:
- `KEYCLOAK_DATABASE_VENDOR`: Database vendor. Default: **postgres**. Use **dev-mem** or **dev-file** to use an in-memory or file-based database for development purposes.
* `KEYCLOAK_DATABASE_VENDOR`: Database vendor. Default: **postgres**. Use **dev-mem** or **dev-file** to use an in-memory or file-based database for development purposes.
### PostgreSQL database connection configuration

2
bitnami/kubeapps-apprepository-controller/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Kubeapps AppRepository Controller](https://github.com/vmware-tanzu/kubeapps)
## TL;DR
```console

2
bitnami/kubeapps-asset-syncer/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Kubeapps Asset Syncer](https://github.com/vmware-tanzu/kubeapps)
## TL;DR
```console

2
bitnami/mariadb-galera/README.md
View File

@@ -679,7 +679,7 @@ docker-compose up mariadb
## Notable Changes
### 10.2.41-debian-10-r11, 10.3.32-debian-10-r11, 10.4.22-debian-10-r11, 10.5.13-debian-10-r10, 10.6.5-debian-10-r10, 10.3.38-r6-debian-11, 10.4.28-r6-debian-11, 10.5.19-r5-debian-11, 10.6.12-r5-debian-11, 10.7.8-r5-debian-11, 10.8.7-r5-debian-11, 10.9.5-r5-debian-11 and 10.10.3-r5-debian-11
### 10.2.41-debian-10-r11, 10.3.32-debian-10-r11, 10.4.22-debian-10-r11, 10.5.13-debian-10-r10, 10.6.5-debian-10-r10, 10.3.38-r6-debian-11, 10.4.28-r6-debian-11, 10.5.19-r5-debian-11, 10.6.12-r5-debian-11, 10.7.8-r5-debian-11, 10.8.7-r5-debian-11, 10.9.5-r5-debian-11 and 10.10.3-r5-debian-11
* The command `mysql_upgrade` no longer includes the flag `--force`. Nonetheless, it can be enabled by using the [mysql_upgrade] option group in the MariaDB configuration.

2
bitnami/mariadb/README.md
View File

@@ -651,7 +651,7 @@ docker-compose up mariadb
## Notable Changes
### 10.2.41-debian-10-r12, 10.3.32-debian-10-r13, 10.4.22-debian-10-r13, 10.5.13-debian-10-r14, 10.6.5-debian-10-r13, 10.3.38-r5-debian-11, 10.4.28-r5-debian-11, 10.5.19-r5-debian-11, 10.6.12-r5-debian-11, 10.7.8-r5-debian-11, 10.8.7-r5-debian-11, 10.9.5-r5-debian-11 and 10.10.3-r6-debian-11
### 10.2.41-debian-10-r12, 10.3.32-debian-10-r13, 10.4.22-debian-10-r13, 10.5.13-debian-10-r14, 10.6.5-debian-10-r13, 10.3.38-r5-debian-11, 10.4.28-r5-debian-11, 10.5.19-r5-debian-11, 10.6.12-r5-debian-11, 10.7.8-r5-debian-11, 10.8.7-r5-debian-11, 10.9.5-r5-debian-11 and 10.10.3-r6-debian-11
* The command `mysql_upgrade` no longer includes the flag `--force`. Nonetheless, it can be enabled by using the [mysql_upgrade] option group in the MariaDB configuration.

2
bitnami/multus-cni/README.md
View File

@@ -2,7 +2,7 @@
## What is Multus CNI?
> Multus is a CNI plugin for Kubernetes clusters. Written in Go, features adding multiple network interfaces to pods.
> Multus is a CNI plugin for Kubernetes clusters. Written in Go, features adding multiple network interfaces to pods.
[Overview of Multus CNI](https://github.com/k8snetworkplumbingwg/multus-cni)

2
bitnami/pgbouncer/README.md
View File

@@ -127,7 +127,7 @@ To expose the same database name as the backend, set `PGBOUNCER_DATABASE="$POSTG
* `PGBOUNCER_DEFAULT_POOL_SIZE` : PgBouncer maximum server connections to allow per user/database pair. Default: **20**.
* `PGBOUNCER_MIN_POOL_SIZE` : PgBouncer has at least this amount of open connections. Default: **0 (disabled)**.
* `PGBOUNCER_RESERVE_POOL_SIZE` : PgBouncer allows this amount of additional connections. Default: **0 (disabled)**.
* `PGBOUNCER_IGNORE_STARTUP_PARAMETERS`: you can use this to set `ignore_startup_parameters` in the auto-generated `pgbouncer.ini`. This can be useful for solving certain connection issues. See https://www.pgbouncer.org/config.html for more details.
* `PGBOUNCER_IGNORE_STARTUP_PARAMETERS`: you can use this to set `ignore_startup_parameters` in the auto-generated `pgbouncer.ini`. This can be useful for solving certain connection issues. See <https://www.pgbouncer.org/config.html> for more details.
* `PGBOUNCER_SERVER_IDLE_TIMEOUT`: PgBouncer maximum time in seconds a server connection can be idle. If 0 then the timeout is disabled. Default: **600**
* `PGBOUNCER_SERVER_RESET_QUERY`: PgBouncer query sent to server on connection release before making it available to other clients. Default: **DISCARD ALL**
* `PGBOUNCER_STATS_USERS`: PgBouncer comma-separated list of database users that are allowed to connect and run read-only queries. No defaults.

2
bitnami/sealed-secrets/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets)
## TL;DR
```console

2
bitnami/spark/README.md
View File

@@ -195,7 +195,7 @@ RUN curl https://repo1.maven.org/maven2/com/amazonaws/aws-java-sdk-bundle/1.11.7
In a similar way that in the previous section, you may want to use a different version of Hadoop jars.
Go to https://spark.apache.org/downloads.html and copy the download url bundling the Hadoop version you want and matching the Apache Spark version of the container. Extend the Bitnami container image as below:
Go to <https://spark.apache.org/downloads.html> and copy the download url bundling the Hadoop version you want and matching the Apache Spark version of the container. Extend the Bitnami container image as below:
```Dockerfile
FROM bitnami/spark:3.0.0

2
bitnami/wavefront-hpa-adapter/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Wavefront HPA Adapter for Kubernetes](https://github.com/wavefrontHQ/wavefront-kubernetes-adapter)
## TL;DR
```console

2
bitnami/wavefront-kubernetes-collector/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Wavefront](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes)
## TL;DR
```console

2
bitnami/wavefront-prometheus-storage-adapter/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Wavefront Prometheus Adapter](https://github.com/wavefrontHQ/prometheus-storage-adapter)
## TL;DR
```console

2
bitnami/wavefront-proxy/README.md
View File

@@ -6,8 +6,6 @@
[Overview of Wavefront Proxy](https://github.com/wavefrontHQ/wavefront-proxy)
## TL;DR
```console

2
bitnami/zookeeper/README.md
View File

@@ -325,7 +325,7 @@ services:
### Setting up an Apache ZooKeeper ensemble
A Apache ZooKeeper (https://zookeeper.apache.org/doc/r3.1.2/zookeeperAdmin.html) cluster can easily be setup with the Bitnami Apache ZooKeeper Docker image using the following environment variables:
An Apache ZooKeeper (<https://zookeeper.apache.org/doc/r3.1.2/zookeeperAdmin.html>) cluster can easily be setup with the Bitnami Apache ZooKeeper Docker image using the following environment variables:
* `ZOO_SERVERS`: Comma, space or semi-colon separated list of servers. This can be done with or without specifying the ID of the server in the ensemble. No defaults. Examples:
* without Server ID - zoo1:2888:3888,zoo2:2888:3888