fix(docs): autogenerate docs (#8891)

* docs: auto-generated property docs * docs: auto-generated Swagger SPEC docs
JanssenProject · Jul 8, 2024 · 56a0dd0 · 56a0dd0
1 parent 86e9c31
commit 56a0dd0
Show file tree

Hide file tree

Showing 21 changed files with 128 additions and 70 deletions.
diff --git a/charts/janssen-all-in-one/README.md b/charts/janssen-all-in-one/README.md
@@ -362,4 +362,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/README.md b/charts/janssen/README.md
@@ -633,4 +633,4 @@ Kubernetes: `>=v1.22.0-0`
 | scim.volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/auth-server-key-rotation/README.md b/charts/janssen/charts/auth-server-key-rotation/README.md
@@ -49,4 +49,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/auth-server/README.md b/charts/janssen/charts/auth-server/README.md
@@ -58,4 +58,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/casa/README.md b/charts/janssen/charts/casa/README.md
@@ -63,4 +63,4 @@ Kubernetes: `>=v1.21.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/cn-istio-ingress/README.md b/charts/janssen/charts/cn-istio-ingress/README.md
@@ -22,4 +22,4 @@ Istio Gateway
 Kubernetes: `>=v1.21.0-0`
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/config-api/README.md b/charts/janssen/charts/config-api/README.md
@@ -62,4 +62,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/config/README.md b/charts/janssen/charts/config/README.md
@@ -128,4 +128,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/fido2/README.md b/charts/janssen/charts/fido2/README.md
@@ -59,4 +59,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/kc-scheduler/README.md b/charts/janssen/charts/kc-scheduler/README.md
@@ -47,4 +47,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/link/README.md b/charts/janssen/charts/link/README.md
@@ -62,4 +62,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/nginx-ingress/README.md b/charts/janssen/charts/nginx-ingress/README.md
@@ -64,4 +64,4 @@ Kubernetes: `>=v1.22.0-0`
 | nameOverride | string | `""` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/opendj/README.md b/charts/janssen/charts/opendj/README.md
@@ -71,4 +71,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/persistence/README.md b/charts/janssen/charts/persistence/README.md
@@ -49,4 +49,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/saml/README.md b/charts/janssen/charts/saml/README.md
@@ -61,4 +61,4 @@ Kubernetes: `>=v1.21.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/janssen/charts/scim/README.md b/charts/janssen/charts/scim/README.md
@@ -58,4 +58,4 @@ Kubernetes: `>=v1.22.0-0`
 | volumes | list | `[]` | Configure any additional volumes that need to be attached to the pod |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
+Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/docs/admin/install/docker-install/compose.md b/docs/admin/install/docker-install/compose.md
@@ -58,10 +58,20 @@ Download the compose file
 wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml 
 ```
 
+Download the the script files 
+
+```bash
+
+wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/up.sh
+wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/down.sh
+wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/clean.sh
+```
+
 This docker compose file runs two containers, the janssen monolith container and mysql container.
+To start the containers.
 
 ```bash
-docker compose -f jans-mysql-compose.yml up -d
+./up.sh
 ```
 
 To view the containers running
@@ -71,6 +81,12 @@ To view the containers running
 docker compose -f jans-mysql-compose.yml ps
 ```
 
+To stop the containers.
+
+```bash
+./down.sh
+```
+
 ## Configure Janssen Server
 
 ```bash
@@ -97,6 +113,6 @@ After adding the record you can hit endpoints such as https://demoexample.jans.i
 
 Remove setup and volumes
 
-```
-docker compose -f jans-mysql-compose.yml down
+```bash
+./clean.sh
 ```
diff --git a/docs/admin/reference/kubernetes/docker-jans-configurator.md b/docs/admin/reference/kubernetes/docker-jans-configurator.md
@@ -61,6 +61,7 @@ The following environment variables are supported by the container:
 - `AWS_SHARED_CREDENTIALS_FILE`: The location of the shared credentials file used by the client (see https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
 - `AWS_CONFIG_FILE`: The location of the config file used by the client (see https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
 - `AWS_PROFILE`: The default profile to use, if any.
+- `CN_SSL_CERT_FROM_DOMAIN`: Validate certificate is downloaded from given domain. If set to `true` (default to `false`), raise an error if cert is not downloaded. Note that the flag is ignored if mounted SSL cert and key files exist.
 
 ## Commands
 

diff --git a/docs/admin/reference/kubernetes/docker-jans-monolith.md b/docs/admin/reference/kubernetes/docker-jans-monolith.md
@@ -58,10 +58,20 @@ Download the compose file
 wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml 
 ```
 
+Download the the script files 
+
+```bash
+
+wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/up.sh
+wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/down.sh
+wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/clean.sh
+```
+
 This docker compose file runs two containers, the janssen monolith container and mysql container.
+To start the containers.
 
 ```bash
-docker compose -f jans-mysql-compose.yml up -d
+./up.sh
 ```
 
 To view the containers running
@@ -71,6 +81,12 @@ To view the containers running
 docker compose -f jans-mysql-compose.yml ps
 ```
 
+To stop the containers.
+
+```bash
+./down.sh
+```
+
 ## Configure Janssen Server
 
 ```bash
@@ -97,6 +113,6 @@ After adding the record you can hit endpoints such as https://demoexample.jans.i
 
 Remove setup and volumes
 
-```
-docker compose -f jans-mysql-compose.yml down
+```bash
+./clean.sh
 ```