uniformize READMEs to 'Usage with Kustomize' (refs #27)

mborne · Dec 10, 2022 · e0eb6a7 · e0eb6a7
1 parent 2fa599d
commit e0eb6a7
Show file tree

Hide file tree

Showing 15 changed files with 20 additions and 62 deletions.
diff --git a/adminer/README.md b/adminer/README.md
@@ -7,7 +7,7 @@ Container running [adminer](https://hub.docker.com/_/adminer/).
 * Start adminer : `docker-compose up -d`
 * Open https://adminer.dev.localhost/
 
-## Usage with Kustomize
+## Usage with Kubernetes
 
 * Create namespace : `kubectl create namespace adminer`
 * Deploy adminer : `kubectl -n adminer apply -k adminer/manifest/base`

diff --git a/argocd/README.md b/argocd/README.md
@@ -4,7 +4,7 @@
 
 Container running [Argo CD](https://argo-cd.readthedocs.io/en/stable/).
 
-## Usage with kustomize
+## Usage with Kubernetes
 
 * Create namespace : `kubectl create namespace argocd`
 * Deploy [Argo CD](https://argo-cd.readthedocs.io/en/stable/) : `kubectl -n argocd apply -k argocd/manifest/base`

diff --git a/fluentd/README.md b/fluentd/README.md
@@ -36,7 +36,7 @@ docker run --rm --log-driver=fluentd --log-opt tag="docker.echo.{{.ID}}" ubuntu
 }
 ```
 
-## Usage with helm
+## Usage with Kubernetes
 
 * Add repository : `helm repo add fluent https://fluent.github.io/helm-charts`
 * Update helm repositories : `helm repo update`

diff --git a/geonetwork/README.md b/geonetwork/README.md
@@ -9,9 +9,9 @@ Container running [GeoNetwork](https://geonetwork-opensource.org/).
 * Open https://geonetwork.dev.localhost/geonetwork/
 * Login with admin/admin
 
-## Usage with Kustomize
+## Usage with Kubernetes
 
-* Install [CRD and Operator for Elasticsearch](../elasticsearch/README.md#usage-with-kubernetes)
+* Install [CRD and Operator for Elasticsearch](../elasticsearch/README.md#usage-with-kubernetes).
 * Create namespace : `kubectl create namespace geonetwork`
 * Deploy geonetwork : `kubectl -n geonetwork apply -k https://github.com/mborne/docker-devbox/geonetwork/manifest/base`
 * Open https://geonetwork.dev.localhost/geonetwork/
diff --git a/jenkins/README.md b/jenkins/README.md
@@ -6,25 +6,7 @@ Container running [Jenkins](https://www.jenkins.io/).
 
 See [github.com - mborne/docker-jenkins](https://github.com/mborne/docker-jenkins#docker-jenkins)
 
-## Usage with kubernetes
-
-* 1) Start jenkins
-
-```bash
-kubectl apply -k https://github.com/mborne/docker-devbox/jenkins/manifest/local-storage
-```
-
-* 2) Wait until jenkins is running : `kubectl -n jenkins get pods -w`
-
-* 3) Get initial admin password :
-
-```bash
-kubectl -n jenkins exec -ti pod/jenkins-0 -- /bin/cat /var/jenkins_home/secrets/initialAdminPassword
-```
-
-* 4) Open http://jenkins.dev.localhost
-
-## Usage with helm
+## Usage with Kubernetes
 
 * 1) Add helm repo : `helm repo add jenkins https://charts.jenkins.io`
 * 2) Update helm repos : `helm repo update`
@@ -48,6 +30,7 @@ Notes :
 
 ## See also
 
+* [Jenkins deployment with Kustomize](kustomize.md)
 * [www.jenkins.io - Installing / Kubernetes](https://www.jenkins.io/doc/book/installing/kubernetes/) for helm instructions
 * [devopscube.com - How to Setup Jenkins Build Agents on Kubernetes Pods](https://devopscube.com/jenkins-build-agents-kubernetes/)
 * [jpetazzo.github.io - Using Docker-in-Docker for your CI or testing environment? Think twice.](https://jpetazzo.github.io/2015/09/03/do-not-use-docker-in-docker-for-ci/)

diff --git a/keycloak/README.md b/keycloak/README.md
@@ -2,7 +2,7 @@
 
 Container running [Keycloak](https://www.keycloak.org/).
 
-## Usage
+## Usage with docker
 
 * Start keycloak stack : `KEYCLOAK_ADMIN_PASSWORD=ChangeIt docker compose up -d`
 

diff --git a/kubernetes-dashboard/README.md b/kubernetes-dashboard/README.md
@@ -1,6 +1,6 @@
 # kubernetes-dashboard
 
-## Usage with kustomize
+## Usage with Kubernetes
 
 * Deploy [kubernetes-dashboard](https://github.com/kubernetes/dashboard/) with an [admin-user](manifest/admin-user.yaml):
 

diff --git a/longhorn/README.md b/longhorn/README.md
@@ -12,7 +12,7 @@ sudo systemctl start iscsid && sudo systemctl enable iscsid
 sudo systemctl status iscsid
 ```
 
-## Usage with kustomize
+## Usage with Kubernetes
 
 * Deploy to k8s
 

diff --git a/matomo/README.md b/matomo/README.md
@@ -2,7 +2,7 @@
 
 Container running [matomo](https://hub.docker.com/_/matomo)'s official image with MySQL database.
 
-## Usage
+## Usage with docker
 
 * Start : `docker-compose up -d`
 * Open https://matomo.dev.localhost and follow instructions

diff --git a/openldap/README.md b/openldap/README.md
@@ -2,7 +2,7 @@
 
 Containers running [osixia/openldap](https://github.com/osixia/docker-openldap#osixiaopenldap) and [osixia/docker-phpLDAPadmin](https://github.com/osixia/docker-phpLDAPadmin).
 
-## Usage
+## Usage with docker
 
 * Start openldap
 

diff --git a/opensearch/README.md b/opensearch/README.md
@@ -13,7 +13,7 @@ WARNING : Read [docker-compose.yml](docker-compose.yml) and note that **security
 * Start containers : `docker compose up -d`
 * Open https://os-dashboard.dev.localhost/
 
-## Usage with helm
+## Usage with Kubernetes
 
 * Add helm chart : `helm repo add opensearch https://opensearch-project.github.io/helm-charts/`
 * Update helm repositories : `helm repo update`

diff --git a/postgis/README.md b/postgis/README.md
@@ -27,7 +27,9 @@ createdb gis
 psql -d gis -c "CREATE EXTENSION postgis"
 ```
 
-## Usage with Kustomize
+## Usage with Kubernetes
+
+> **Warning:** This is an experiment with Kustomize where local storage is used by default and adapted to a **single cluster node**. `/var/devbox/postgis-13` is created on a random node (see `kubectl -n postgis get pods -o wide`).
 
 * Start postgis :
 
@@ -51,10 +53,6 @@ psql -h localhost -U postgis -l
 
 Note : Internal hostname is `postgis.postgis.svc.cluster.local`.
 
-## Warning with kustomize
-
-This is an experiment where local storage is used by default and adapted to a **single cluster node**. `/var/devbox/postgis-13` is created on a random node (see `kubectl -n postgis get pods -o wide`).
-
 ## See also
 
 PostgreSQL operators like :

diff --git a/sonarqube/README.md b/sonarqube/README.md
@@ -8,31 +8,8 @@ Container running [SonarQube](https://www.sonarqube.org/).
 * Open https://sonarqube.dev.localhost
 * Login with default admin/admin account
 
-## Notes about sonarqube
+## Resources
 
-### Java
-
-```bash
-git clone https://github.com/IGNF/validator
-cd validator
-mvn clean package
-mvn sonar:sonar -Dsonar.java.binaries=$PWD/**/target/classes \
-    -Dsonar.host.url=http://localhost:9000 -Dsonar.login=$SONAR_TOKEN
-```
-
-## sonar-scanner under docker
-
-```bash
-git clone https://github.com/mborne/remote-git
-# send to sonarqube
-docker run --rm \
-    -v $PWD/remote-git:/project \
-    -w=/project --network=devbox \
-    nikhuber/sonar-scanner:latest sonar-scanner \
-    -Dsonar.projectKey=remote-git \
-    -Dsonar.language=php \
-    -Dsonar.sources=/project/src \
-    -Dsonar.host.url=http://sonarqube:9000   -Dsonar.login=$SONAR_TOKEN
-```
+* [Notes about SonarQube](usage.md)
 
 
diff --git a/traefik/README.md b/traefik/README.md
@@ -14,7 +14,7 @@ See also :
 * [Using mkcert to generate traefik certificates](mkcert.md)
 * [mborne/traefik-dev](img/traefik-dev/README.md) to customize traefik config using `docker compose exec traefik /bin/sh` and [vi](https://ryanstutorials.net/linuxtutorial/cheatsheetvi.php) editor.
 
-## Usage with helm
+## Usage with Kubernetes
 
 See [traefik/traefik-helm-chart](https://github.com/traefik/traefik-helm-chart#traefik) :
 

diff --git a/whoami/README.md b/whoami/README.md
@@ -7,7 +7,7 @@ Container running [containous/whoami](https://hub.docker.com/r/containous/whoami
 * Start 2 instances : `docker-compose up -d --scale whoami=2`
 * Open https://whoami.dev.localhost and refresh
 
-## Usage with Kustomize
+## Usage with Kubernetes
 
 ```bash
 # create namespace