From 15af65d73156f154e5b201d8f96a4486185ddc2d Mon Sep 17 00:00:00 2001 From: mborne Date: Sat, 10 Dec 2022 17:31:11 +0100 Subject: [PATCH] uniformize READMEs to 'Usage with docker' (refs #27) --- README.md | 11 +++-------- adminer/README.md | 4 ++-- argocd/README.md | 4 +++- cloudbeaver/README.md | 4 ++-- elasticsearch/README.md | 22 ++++++++++++++++++++-- elasticsearch/debug-compose.md | 20 -------------------- fluentd/README.md | 10 ++++++---- geonetwork/README.md | 4 ++-- geoserver/README.md | 8 ++++---- jenkins/README.md | 2 +- keycloak/README.md | 8 ++++---- kibana/README.md | 4 ++-- kubernetes-dashboard/README.md | 2 +- longhorn/README.md | 4 +--- mailer/README.md | 15 +++++++++++---- mailhog/README.md | 8 ++++---- minio/README.md | 2 +- netdata/README.md | 2 +- nextcloud/README.md | 4 +--- nexus/README.md | 10 +++------- openldap/README.md | 2 -- opensearch/README.md | 2 +- postgis/README.md | 4 ++-- sonarqube/README.md | 4 ++-- traefik/README.md | 4 +--- vault/README.md | 6 +++--- whoami/README.md | 5 ++--- wordpress/README.md | 4 ++-- 28 files changed, 85 insertions(+), 94 deletions(-) delete mode 100644 elasticsearch/debug-compose.md diff --git a/README.md b/README.md index 6d475bd..8acf00b 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,14 @@ See [notes about docker-compose](docs/docker-compose.md) for more details. | [traefik](traefik/README.md) | A reverse proxy/load balancer including **configuration discovery** mechanism | ☑ | ☑ | | [whoami](whoami/README.md) | An helloworld to discover [traefik](traefik/README.md) | ☑ | ☑ | -### CI/CD +### CI/CD pipeline | Name | Description | Docker | K8S | | -------------------------------- | --------------------------------------------------------------------------- | :-----: | :-----: | | [Jenkins](jenkins/README.md) | Open source automation server with hundred of plugins (ansible, jmeter,...) | ☑ | ☑ | | [ArgoCD](argocd/README.md) | GitOps **continuous delivery** tool for **Kubernetes** | NA | ☑ | | [SonarQube](sonarqube/README.md) | Centralisation of Code Quality and Code Security metrics | ☑ | ☐ | +| [Vault](vault/README.md) | Secret storage and management server with an API | ☑ | ☐ | ### Authentication @@ -36,12 +37,6 @@ See [notes about docker-compose](docs/docker-compose.md) for more details. | [Keycloak](keycloak/README.md) | Open Source Identity and Access Management providing (**OIDC, SAML**) | ☑ | ☐ | | [OpenLDAP](openldap/README.md) | Community developed **LDAP** software | ☑ | ☐ | -### Secrets - -| Name | Description | Docker | K8S | -| ------------------------ | ------------------------------------------------ | :-----: | :-----: | -| [Vault](vault/README.md) | Secret storage and management server with an API | ☑ | ☐ | - ### Storage | Name | Description | Docker | K8S | @@ -64,7 +59,7 @@ See [notes about docker-compose](docs/docker-compose.md) for more details. | Name | Description | Docker | K8S | | ---------------------------------------- | ------------------------------------------------------------------------------------- | :-----: | :-----: | | [Elasticsearch](elasticsearch/README.md) | ELK - Log storage and indexation | ☑ | ☑ | -| [Kibana](kibana/README.md) | ELK - User Interface | ☑ | ☑ | +| [Kibana](kibana/README.md) | ELK - User Interface | ☑ | ☐ | | [OpenSearch](opensearch/README.md) | Forked from [Elasticsearch](https://www.elastic.co/fr/elasticsearch/) by AWS | ☑ | ☑ | | [Netdata](netdata/README.md) | A monitoring tool with an easy setup | ☑ | ☐ | | [Fluend](fluentd/README.md) | An attempt to configure [Fluend](https://www.fluentd.org/) to collect containers logs | ☑ | ☐ | diff --git a/adminer/README.md b/adminer/README.md index 60a3aae..96ec1b1 100644 --- a/adminer/README.md +++ b/adminer/README.md @@ -1,8 +1,8 @@ # adminer -Docker container running [adminer](https://hub.docker.com/_/adminer/) +Container running [adminer](https://hub.docker.com/_/adminer/). -## Usage with docker-compose +## Usage with docker * Start adminer : `docker-compose up -d` * Open https://adminer.dev.localhost/ diff --git a/argocd/README.md b/argocd/README.md index b7e0fde..3597542 100644 --- a/argocd/README.md +++ b/argocd/README.md @@ -1,6 +1,8 @@ -# [Argo CD](https://argo-cd.readthedocs.io/en/stable/) +# Argo CD + +Container running [Argo CD](https://argo-cd.readthedocs.io/en/stable/). ## Usage with kustomize diff --git a/cloudbeaver/README.md b/cloudbeaver/README.md index c8c23fd..5181df4 100644 --- a/cloudbeaver/README.md +++ b/cloudbeaver/README.md @@ -1,8 +1,8 @@ # CloudBeaver -Container running [dbeaver/cloudbeaver](https://hub.docker.com/r/dbeaver/cloudbeaver) official image. +Container running [dbeaver/cloudbeaver](https://hub.docker.com/r/dbeaver/cloudbeaver). -## Usage with docker-compose +## Usage with docker * Start cloudbeaver : `docker-compose up -d` * Open https://cloudbeaver.dev.localhost/ diff --git a/elasticsearch/README.md b/elasticsearch/README.md index aab8921..33bf66e 100644 --- a/elasticsearch/README.md +++ b/elasticsearch/README.md @@ -6,7 +6,7 @@ Containers running [Elasticsearch](https://www.elastic.co/elasticsearch/) for ** * [max_map_count >= 262144](../docs/max_map_count.md) -## Usage with docker-compose +## Usage with docker * Start elasticsearch : `docker-compose up -d` * Open https://es.dev.localhost or https://es.dev.localhost/_cat/nodes?v&pretty @@ -30,7 +30,25 @@ kubectl apply -f https://download.elastic.co/downloads/eck/2.2.0/operator.yaml ...and usage in [geonetwork/manifest/base/elasticsearch.yaml](../geonetwork/manifest/base/elasticsearch.yaml) / [geonetwork/manifest/base/statefulset.yaml](../geonetwork/manifest/base/statefulset.yaml) -## See also + +## Troubleshooting + +### vm.max_map_count too low + +> [1]: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144] + +```bash +sudo sysctl -w vm.max_map_count=262144 +``` + +### Disable disk quota / watermark + +```bash +bash disable-quota.sh +``` + + +## Resources * [Install Elasticsearch with Docker](https://www.elastic.co/guide/en/elasticsearch/reference/7.15/docker.html#docker) * [How to disable ElasticSearch disk quota / watermark](https://techoverflow.net/2019/04/17/how-to-disable-elasticsearch-disk-quota-watermark/) : avoid read-only problems diff --git a/elasticsearch/debug-compose.md b/elasticsearch/debug-compose.md deleted file mode 100644 index 0a32ba0..0000000 --- a/elasticsearch/debug-compose.md +++ /dev/null @@ -1,20 +0,0 @@ - -# ElasticSearch - troubleshooting with docker-compose - -```bash -docker-compose logs -f -``` - -### vm.max_map_count too low - -> [1]: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144] - -```bash -sudo sysctl -w vm.max_map_count=262144 -``` - -### Disable disk quota / watermark - -```bash -bash disable-quota.sh -``` diff --git a/fluentd/README.md b/fluentd/README.md index c830d51..f42db43 100644 --- a/fluentd/README.md +++ b/fluentd/README.md @@ -1,12 +1,16 @@ # Fluentd +**WORK IN PROGRESS** + Container running [fluentd](https://www.fluentd.org/) to collect logs. ## Pre-requisite * [OpenSearch](../opensearch/README.md) ( see [fluentd/conf/fluent.conf](fluentd/conf/fluent.conf) ) -## Usage with docker-compose +## Usage with docker + +* Read [conf/fluent.conf](conf/fluent.conf) * Start containers : @@ -34,8 +38,6 @@ docker run --rm --log-driver=fluentd --log-opt tag="docker.echo.{{.ID}}" ubuntu ## Usage with helm -**WORK IN PROGRESS** - * Add repository : `helm repo add fluent https://fluent.github.io/helm-charts` * Update helm repositories : `helm repo update` * Create namespace : `kubectl create namespace fluent-system` @@ -51,7 +53,7 @@ Note : * see [fluent-bit/values.yaml](https://github.com/fluent/helm-charts/blob/main/charts/fluent-bit/values.yaml) -## Reference +## Resources * [docs.fluentd.org - container-deployment/docker-compose](https://docs.fluentd.org/container-deployment/docker-compose) * [www.fluentd.org - Docker Logging](https://www.fluentd.org/guides/recipes/docker-logging) diff --git a/geonetwork/README.md b/geonetwork/README.md index 7b6612b..a786961 100644 --- a/geonetwork/README.md +++ b/geonetwork/README.md @@ -1,8 +1,8 @@ # GeoNetwork (CSW, CSW-T) -Docker container running [GeoNetwork](https://geonetwork-opensource.org/). +Container running [GeoNetwork](https://geonetwork-opensource.org/). -## Usage with docker-compose +## Usage with docker * Start [Elasticsearch](../elasticsearch/README.md#usage-with-docker-compose) * Start geonetwork : `docker-compose up -d` diff --git a/geoserver/README.md b/geoserver/README.md index 463825b..0c621a4 100644 --- a/geoserver/README.md +++ b/geoserver/README.md @@ -1,11 +1,11 @@ -# GeoServer (WMS, WFS, WMTS) +# GeoServer -Docker container running [GeoServer](https://geoserver.org/) +Container running [GeoServer](https://geoserver.org/) to serve spatial data (WMS, WFS, WMTS). -## Usage with docker-compose +## Usage with docker -* Build GeoServer : `docker-compose build` +* Build GeoServer : `docker-compose build` (see [Dockerfile](Dockerfile)) * Start GeoServer : `docker-compose up -d` diff --git a/jenkins/README.md b/jenkins/README.md index 763e417..89142ec 100644 --- a/jenkins/README.md +++ b/jenkins/README.md @@ -2,7 +2,7 @@ Container running [Jenkins](https://www.jenkins.io/). -## Usage with docker-compose +## Usage with docker See [github.com - mborne/docker-jenkins](https://github.com/mborne/docker-jenkins#docker-jenkins) diff --git a/keycloak/README.md b/keycloak/README.md index 717fc9a..4881b0f 100644 --- a/keycloak/README.md +++ b/keycloak/README.md @@ -1,10 +1,10 @@ -# [Keycloak](https://www.keycloak.org/) +# Keycloak -## Usage +Container running [Keycloak](https://www.keycloak.org/). -* Start [postgis](../postgis/README.md) and `createdb keycloak` +## Usage -* Start keycloak : `KEYCLOAK_ADMIN_PASSWORD=ChangeIt docker compose up -d` +* Start keycloak stack : `KEYCLOAK_ADMIN_PASSWORD=ChangeIt docker compose up -d` * Open http://keycloak.dev.localhost diff --git a/kibana/README.md b/kibana/README.md index 799256f..92a1b54 100644 --- a/kibana/README.md +++ b/kibana/README.md @@ -1,8 +1,8 @@ # Kibana -Docker container running [Kibana](https://www.elastic.co/kibana/) as a single node for dev purpose. +Container running [Kibana](https://www.elastic.co/kibana/) for **DEV purpose**. -## Usage with docker-compose +## Usage with docker * Start kibana : `docker-compose up -d` * Open https://kibana.dev.localhost diff --git a/kubernetes-dashboard/README.md b/kubernetes-dashboard/README.md index 8f11bbd..c1f04ee 100644 --- a/kubernetes-dashboard/README.md +++ b/kubernetes-dashboard/README.md @@ -20,7 +20,7 @@ kubectl -n kubernetes-dashboard get secret \ * Start `kubectl proxy` * Open http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/ -## Reference +## Resources * [kubernetes.io - Tableau de bord (Dashboard)](https://kubernetes.io/fr/docs/tasks/access-application-cluster/web-ui-dashboard/) * [github.com - kubernetes/dashboard](https://github.com/kubernetes/dashboard/) diff --git a/longhorn/README.md b/longhorn/README.md index f0724a2..32295ad 100644 --- a/longhorn/README.md +++ b/longhorn/README.md @@ -1,11 +1,9 @@ # Longhorn -[Longhorn](https://longhorn.io/) is a cloud native distributed block storage for Kubernetes : - +Container runner [Longhorn](https://longhorn.io/) which is a cloud native distributed block storage for Kubernetes : ![Longhorn nodes](img/longhorn-nodes.png) - ## System requirements ```bash diff --git a/mailer/README.md b/mailer/README.md index 7823ca8..4d806a4 100644 --- a/mailer/README.md +++ b/mailer/README.md @@ -1,11 +1,18 @@ # mailer -STMP relay based on [namshi/smtp](https://hub.docker.com/r/namshi/smtp) image. +Container running [namshi/smtp](https://hub.docker.com/r/namshi/smtp) which is a STMP relay. -## Usage with docker-compose +> **Warning:** See [namshi/smtp -tags](https://hub.docker.com/r/namshi/smtp/tags) currently displaying **Last pushed 3 years ago by namshi**. -* 1) Create `config.env` file (see [config.env.dist](config.env.dist) or [namshi/smtp on dockerhub](https://hub.docker.com/r/namshi/smtp) ) -* 2) Start container : `docker-compose up -d` +## Usage with docker + +* Create `config.env` file to provide `GMAIL_USER` and `GMAIL_PASSWORD` + +> See [config.env.dist](config.env.dist) or [namshi/smtp on dockerhub](https://hub.docker.com/r/namshi/smtp) + +* Start container : `docker-compose up -d` + +* Configure other tools to use `mailer:25` to send mails. ## Testing diff --git a/mailhog/README.md b/mailhog/README.md index 7daf200..fd6080a 100644 --- a/mailhog/README.md +++ b/mailhog/README.md @@ -1,8 +1,8 @@ -# [MailHog](https://github.com/mailhog/MailHog#readme) +# MailHog -Docker container running mailhog to test email sending from application +Container running running [MailHog](https://github.com/mailhog/MailHog#readme) to test email sending from applications. -## Usage +## Usage with docker * Start postgis : `docker-compose up -d` @@ -20,6 +20,6 @@ this is a test email quit ``` -* Open http://mailhog.localhost or http://mailhog.localhost/api/v2/messages +* Open http://mailhog.dev.localhost or http://mailhog.dev.localhost/api/v2/messages ![Test email](doc/test-email.png) diff --git a/minio/README.md b/minio/README.md index 68b9166..0d62347 100644 --- a/minio/README.md +++ b/minio/README.md @@ -2,7 +2,7 @@ Container running [MinIO](https://min.io/) offering S3 compatible object storage. -## Usage with docker-compose +## Usage with docker * Start containers : `MINIO_ROOT_PASSWORD=ChangeIt docker compose up -d` * Open https://minio.dev.localhost/ diff --git a/netdata/README.md b/netdata/README.md index c0d692f..261fa5a 100644 --- a/netdata/README.md +++ b/netdata/README.md @@ -2,7 +2,7 @@ Container running [netdata/netdata](https://hub.docker.com/r/netdata/netdata) image. -## Usage with docker-compose +## Usage with docker * Start instance : `NETDATA_NAME=${HOSTNAME} docker-compose up -d` * Open https://netdata.dev.localhost or http://localhost:19999 diff --git a/nextcloud/README.md b/nextcloud/README.md index d62ac2f..1c26621 100644 --- a/nextcloud/README.md +++ b/nextcloud/README.md @@ -1,10 +1,8 @@ # Nextcloud -## Description - Container running [nextcloud](https://hub.docker.com/_/nextcloud) official image. -## Usage with docker-compose +## Usage with docker * Start nextcloud : `docker-compose up -d` diff --git a/nexus/README.md b/nexus/README.md index 61fd4f4..7c9a1d2 100644 --- a/nexus/README.md +++ b/nexus/README.md @@ -1,14 +1,12 @@ # Nexus -## Description +Containers running [sonatype/nexus3](https://hub.docker.com/r/sonatype/nexus3/). -Containers running [sonatype/nexus3](https://hub.docker.com/r/sonatype/nexus3/) - -## Usage with docker-compose +## Usage with docker * Start nexus : `docker-compose up -d` -* Retreive initial admin password : `docker exec -ti nexus cat /nexus-data/admin.password` +* Retrieve initial admin password : `docker exec -ti nexus cat /nexus-data/admin.password` * Open nexus : https://nexus.dev.localhost/ @@ -33,5 +31,3 @@ docker push registry.dev.localhost/hello-world:latest Check https://registry.dev.localhost/v2/_catalog and https://registry.dev.localhost/v2/hello-world/tags/list - - diff --git a/openldap/README.md b/openldap/README.md index e6b343f..1ee58bc 100644 --- a/openldap/README.md +++ b/openldap/README.md @@ -1,7 +1,5 @@ # [OpenLDAP](https://www.openldap.org/) -## Description - Containers running [osixia/openldap](https://github.com/osixia/docker-openldap#osixiaopenldap) and [osixia/docker-phpLDAPadmin](https://github.com/osixia/docker-phpLDAPadmin). ## Usage diff --git a/opensearch/README.md b/opensearch/README.md index 26a29d9..3ee426f 100644 --- a/opensearch/README.md +++ b/opensearch/README.md @@ -6,7 +6,7 @@ Containers running [OpenSearch](https://opensearch.org/) for **DEV purpose**. * [max_map_count >= 262144](../docs/max_map_count.md) -## Usage with docker-compose +## Usage with docker WARNING : Read [docker-compose.yml](docker-compose.yml) and note that **security is disabled**! diff --git a/postgis/README.md b/postgis/README.md index 59ce0e3..ced86eb 100644 --- a/postgis/README.md +++ b/postgis/README.md @@ -1,8 +1,8 @@ # PostGIS -Container running [postgis](https://registry.hub.docker.com/r/postgis/postgis/). +Container running [PostgreSQL with the spatial extension PostGIS](https://registry.hub.docker.com/r/postgis/postgis/). -## Usage with docker-compose +## Usage with docker * Start postgis : diff --git a/sonarqube/README.md b/sonarqube/README.md index bb4f5bb..cf9d267 100644 --- a/sonarqube/README.md +++ b/sonarqube/README.md @@ -1,8 +1,8 @@ # SonarQube -Container running [SonarQube](https://www.sonarqube.org/) official image. +Container running [SonarQube](https://www.sonarqube.org/). -## Usage with docker-compose +## Usage with docker * Start : `docker-compose up -d` * Open https://sonarqube.dev.localhost diff --git a/traefik/README.md b/traefik/README.md index 4d4bc8d..07e033b 100644 --- a/traefik/README.md +++ b/traefik/README.md @@ -2,9 +2,7 @@ Container running [traefik proxy](https://doc.traefik.io/traefik/). -## Usage with docker-compose - -### Getting started +## Usage with docker * Build [mborne/traefik-dev](img/traefik-dev/README.md) image : `docker compose build --pull` * Start traefik : `docker compose up -d` diff --git a/vault/README.md b/vault/README.md index 87d2611..9db947c 100644 --- a/vault/README.md +++ b/vault/README.md @@ -1,8 +1,8 @@ -# [Vault](https://www.vaultproject.io/) +# Vault -Docker container to test [HashiCorp vault](https://hub.docker.com/_/vault). +Container running [HashiCorp vault](https://www.vaultproject.io/) for **DEV purpose**. -## Usage with docker-compose +## Usage with docker * Start vault : `docker-compose up -d` diff --git a/whoami/README.md b/whoami/README.md index a0fdcb9..ce87c98 100644 --- a/whoami/README.md +++ b/whoami/README.md @@ -1,15 +1,14 @@ # whoami -[containous/whoami](https://hub.docker.com/r/containous/whoami/dockerfile) image that outputs information about the machine it is deployed on (its IP address, host, and so on) +Container running [containous/whoami](https://hub.docker.com/r/containous/whoami/dockerfile) to discover [traefik](../traefik/README.md). -## Usage with docker-compose +## Usage with docker * Start 2 instances : `docker-compose up -d --scale whoami=2` * Open https://whoami.dev.localhost and refresh ## Usage with Kustomize - ```bash # create namespace kubectl create namespace whoami diff --git a/wordpress/README.md b/wordpress/README.md index a16c53f..f5b0524 100644 --- a/wordpress/README.md +++ b/wordpress/README.md @@ -1,9 +1,9 @@ # [WordPress](https://wordpress.com/fr/) -Docker container running the famous [WordPress](https://wordpress.com/) CMS. +Container running the famous [WordPress](https://wordpress.com/) CMS. ## Usage -* Start wordpress : `docker-compose up -d` +* Start [WordPress](https://wordpress.com/) : `docker-compose up -d` * Open https://wordpress.dev.localhost/