From 2aec72a8627a01ca61fbed3a8f12a211558d2b0a Mon Sep 17 00:00:00 2001 From: Shubham Kumar <87755583+Shubham9t9@users.noreply.github.com> Date: Mon, 24 Jan 2022 14:07:20 +0530 Subject: [PATCH 1/7] updates in documentation --- docs/setup/install/install-devtron-helm-2.md | 5 +++++ docs/setup/install/install-devtron-helm-3.md | 5 +++++ .../install/install-devtron-using-kubectl.md | 4 ++++ .../deployment-template/rollout-deployment.md | 15 ++++++++++++++- 4 files changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/setup/install/install-devtron-helm-2.md b/docs/setup/install/install-devtron-helm-2.md index fd0c62f418..5be5afa00d 100644 --- a/docs/setup/install/install-devtron-helm-2.md +++ b/docs/setup/install/install-devtron-helm-2.md @@ -70,6 +70,11 @@ kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync ``` The install commands initiates Devtron-operator which spins up all the Devtron micro-services one by one in about 20 mins. You can use the above command to check the status of the installation if the installation is still in progress, it will print `Downloaded`. When the installation is complete, it prints `Applied`. +During devtron installation process, you can check logs of installer. To check logs of installer, run the following command : + +```bash +kubectl logs -f -l app=inception -n devtroncd +``` ## Access Devtron dashboard diff --git a/docs/setup/install/install-devtron-helm-3.md b/docs/setup/install/install-devtron-helm-3.md index ada205fbbf..1231cf3e45 100644 --- a/docs/setup/install/install-devtron-helm-3.md +++ b/docs/setup/install/install-devtron-helm-3.md @@ -63,6 +63,11 @@ kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync ``` The install commands initiates Devtron-operator which spins up all the Devtron micro-services one by one in about 20 mins. You can use the above command to check the status of the installation if the installation is still in progress, it will print `Downloaded`. When the installation is complete, it prints `Applied`. +During devtron installation process, you can check logs of installer. To check logs of installer, run the following command : + +```bash +kubectl logs -f -l app=inception -n devtroncd +``` ## Access Devtron dashboard diff --git a/docs/setup/install/install-devtron-using-kubectl.md b/docs/setup/install/install-devtron-using-kubectl.md index c0302563ed..9cad365dee 100644 --- a/docs/setup/install/install-devtron-using-kubectl.md +++ b/docs/setup/install/install-devtron-using-kubectl.md @@ -35,7 +35,11 @@ kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync ``` The install commands initiates Devtron-operator which spins up all the Devtron micro-services one by one in about 20 mins. You can use the above command to check the status of the installation if the installation is still in progress, it will print `Downloaded`. When the installation is complete, it prints `Applied`. +During devtron installation process, you can check logs of installer. To check logs of installer, run the following command : +```bash +kubectl logs -f -l app=inception -n devtroncd +``` ## Access Devtron dashboard If you did not provide a **BASE\_URL** during install or have used the default installation, Devtron creates a loadbalancer for you on its own. Use the following command to get the dashboard url. diff --git a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md index bb5a25bb2d..a29272d4d2 100644 --- a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md +++ b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md @@ -71,6 +71,9 @@ LivenessProbe: successThreshold: 1 timeoutSeconds: 5 failureThreshold: 3 + command: + - cat + - /example/healthy httpHeaders: - name: Custom-Header value: abc @@ -86,6 +89,7 @@ LivenessProbe: | `successThreshold` | It defines the number of successes required before a given container is said to fulfil the liveness probe. | | `timeoutSeconds` | It defines the time for checking timeout. | | `failureThreshold` | It defines the maximum number of failures that are acceptable before a given container is not considered as live. | +| `command` | The mentioned command is executed to perform the livenessProbe. | | `httpHeaders` | Custom headers to set in the request. HTTP allows repeated headers,You can override the default headers by defining .httpHeaders for the probe. | | `scheme` | Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP. | `tcp` | The kubelet will attempt to open a socket to your container on the specified port. If it can establish a connection, the container is considered healthy. | @@ -126,6 +130,9 @@ ReadinessProbe: successThreshold: 1 timeoutSeconds: 5 failureThreshold: 3 + command: + - cat + - /example/healthy httpHeaders: - name: Custom-Header value: abc @@ -141,6 +148,7 @@ ReadinessProbe: | `successThreshold` | It defines the number of successes required before a given container is said to fulfill the readiness probe. | | `timeoutSeconds` | It defines the time for checking timeout. | | `failureThreshold` | It defines the maximum number of failures that are acceptable before a given container is not considered as ready. | +| `command` | The mentioned command is executed to perform the livenessProbe. | | `httpHeaders` | Custom headers to set in the request. HTTP allows repeated headers,You can override the default headers by defining .httpHeaders for the probe. | | `scheme` | Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP. | `tcp` | The kubelet will attempt to open a socket to your container on the specified port. If it can establish a connection, the container is considered healthy. | @@ -208,10 +216,12 @@ ingress: - host: example1.com paths: - /example + pathType: - host: example2.com paths: - /example2 - /example2/healthz + pathType: tls: [] ``` Legacy deployment-template ingress format @@ -249,10 +259,12 @@ ingressInternal: - host: example1.com paths: - /example + pathType: - host: example2.com paths: - /example2 - /example2/healthz + pathType: tls: [] ``` @@ -260,8 +272,9 @@ ingressInternal: | :--- | :--- | | `enabled` | Enable or disable ingress | | `annotations` | To configure some options depending on the Ingress controller | -| `path` | Path name | | `host` | Host name | +| `path` | Path name | +| `pathType` | Path type. Supported path types are `ImplementationSpecific`, `Exact` and `Prefix`.| | `tls` | It contains security details | ### Init Containers From 0d9ffc772e50d5e389d6a0b94ba73c63108c4852 Mon Sep 17 00:00:00 2001 From: shubham9t9 Date: Tue, 15 Feb 2022 13:39:14 +0530 Subject: [PATCH 2/7] Corrections --- docs/setup/install/install-devtron-helm-2.md | 2 +- docs/setup/install/install-devtron-helm-3.md | 2 +- docs/setup/install/install-devtron-using-kubectl.md | 3 +-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/setup/install/install-devtron-helm-2.md b/docs/setup/install/install-devtron-helm-2.md index 5be5afa00d..cb402d6f94 100644 --- a/docs/setup/install/install-devtron-helm-2.md +++ b/docs/setup/install/install-devtron-helm-2.md @@ -70,7 +70,7 @@ kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync ``` The install commands initiates Devtron-operator which spins up all the Devtron micro-services one by one in about 20 mins. You can use the above command to check the status of the installation if the installation is still in progress, it will print `Downloaded`. When the installation is complete, it prints `Applied`. -During devtron installation process, you can check logs of installer. To check logs of installer, run the following command : +Meanwhile, you can check logs of the installer by executing the following command: ```bash kubectl logs -f -l app=inception -n devtroncd diff --git a/docs/setup/install/install-devtron-helm-3.md b/docs/setup/install/install-devtron-helm-3.md index 1231cf3e45..cce1c1872b 100644 --- a/docs/setup/install/install-devtron-helm-3.md +++ b/docs/setup/install/install-devtron-helm-3.md @@ -63,7 +63,7 @@ kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync ``` The install commands initiates Devtron-operator which spins up all the Devtron micro-services one by one in about 20 mins. You can use the above command to check the status of the installation if the installation is still in progress, it will print `Downloaded`. When the installation is complete, it prints `Applied`. -During devtron installation process, you can check logs of installer. To check logs of installer, run the following command : +Meanwhile, you can check logs of the installer by executing the following command: ```bash kubectl logs -f -l app=inception -n devtroncd diff --git a/docs/setup/install/install-devtron-using-kubectl.md b/docs/setup/install/install-devtron-using-kubectl.md index 9cad365dee..090c952bda 100644 --- a/docs/setup/install/install-devtron-using-kubectl.md +++ b/docs/setup/install/install-devtron-using-kubectl.md @@ -35,8 +35,7 @@ kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync ``` The install commands initiates Devtron-operator which spins up all the Devtron micro-services one by one in about 20 mins. You can use the above command to check the status of the installation if the installation is still in progress, it will print `Downloaded`. When the installation is complete, it prints `Applied`. -During devtron installation process, you can check logs of installer. To check logs of installer, run the following command : - +Meanwhile, you can check logs of the installer by executing the following command: ```bash kubectl logs -f -l app=inception -n devtroncd ``` From da0c412725f1e359ef93fb8236f021db1ff3b59f Mon Sep 17 00:00:00 2001 From: Shubham Kumar <87755583+Shubham9t9@users.noreply.github.com> Date: Tue, 15 Feb 2022 13:40:57 +0530 Subject: [PATCH 3/7] Update install-devtron-using-kubectl.md --- docs/setup/install/install-devtron-using-kubectl.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/setup/install/install-devtron-using-kubectl.md b/docs/setup/install/install-devtron-using-kubectl.md index 090c952bda..2c253afb7c 100644 --- a/docs/setup/install/install-devtron-using-kubectl.md +++ b/docs/setup/install/install-devtron-using-kubectl.md @@ -36,6 +36,7 @@ kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync The install commands initiates Devtron-operator which spins up all the Devtron micro-services one by one in about 20 mins. You can use the above command to check the status of the installation if the installation is still in progress, it will print `Downloaded`. When the installation is complete, it prints `Applied`. Meanwhile, you can check logs of the installer by executing the following command: + ```bash kubectl logs -f -l app=inception -n devtroncd ``` From b0ee2ee51004b7738634ddc1d27c870a87eae843 Mon Sep 17 00:00:00 2001 From: shubham9t9 Date: Tue, 15 Feb 2022 13:43:23 +0530 Subject: [PATCH 4/7] Corrections --- .../deployment-template/rollout-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md index a29272d4d2..05ebddbbe6 100644 --- a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md +++ b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md @@ -274,7 +274,7 @@ ingressInternal: | `annotations` | To configure some options depending on the Ingress controller | | `host` | Host name | | `path` | Path name | -| `pathType` | Path type. Supported path types are `ImplementationSpecific`, `Exact` and `Prefix`.| +| `pathType` | Supported path types are `ImplementationSpecific`, `Exact` and `Prefix`.| | `tls` | It contains security details | ### Init Containers From 23a53abf123e57c9d26cd7af339815f73eb18385 Mon Sep 17 00:00:00 2001 From: shubham9t9 Date: Tue, 15 Feb 2022 14:56:39 +0530 Subject: [PATCH 5/7] Corrections --- .../deployment-template/rollout-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md index 05ebddbbe6..731cf1c86c 100644 --- a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md +++ b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md @@ -148,7 +148,7 @@ ReadinessProbe: | `successThreshold` | It defines the number of successes required before a given container is said to fulfill the readiness probe. | | `timeoutSeconds` | It defines the time for checking timeout. | | `failureThreshold` | It defines the maximum number of failures that are acceptable before a given container is not considered as ready. | -| `command` | The mentioned command is executed to perform the livenessProbe. | +| `command` | The mentioned command is executed to perform the readinessProbe. | | `httpHeaders` | Custom headers to set in the request. HTTP allows repeated headers,You can override the default headers by defining .httpHeaders for the probe. | | `scheme` | Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP. | `tcp` | The kubelet will attempt to open a socket to your container on the specified port. If it can establish a connection, the container is considered healthy. | From 4835353e3118806b46b279bafc241476017b342b Mon Sep 17 00:00:00 2001 From: shubham9t9 Date: Wed, 16 Feb 2022 09:18:40 +0530 Subject: [PATCH 6/7] corrections --- .../deployment-template/rollout-deployment.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md index 731cf1c86c..1a4ce2004f 100644 --- a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md +++ b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md @@ -72,8 +72,8 @@ LivenessProbe: timeoutSeconds: 5 failureThreshold: 3 command: - - cat - - /example/healthy + - python + - /etc/app/healthcheck.py httpHeaders: - name: Custom-Header value: abc @@ -89,7 +89,7 @@ LivenessProbe: | `successThreshold` | It defines the number of successes required before a given container is said to fulfil the liveness probe. | | `timeoutSeconds` | It defines the time for checking timeout. | | `failureThreshold` | It defines the maximum number of failures that are acceptable before a given container is not considered as live. | -| `command` | The mentioned command is executed to perform the livenessProbe. | +| `command` | The mentioned command is executed to perform the livenessProbe. If the command returns a non-zero value, it's equivalent to a failed probe. | | `httpHeaders` | Custom headers to set in the request. HTTP allows repeated headers,You can override the default headers by defining .httpHeaders for the probe. | | `scheme` | Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP. | `tcp` | The kubelet will attempt to open a socket to your container on the specified port. If it can establish a connection, the container is considered healthy. | @@ -131,8 +131,8 @@ ReadinessProbe: timeoutSeconds: 5 failureThreshold: 3 command: - - cat - - /example/healthy + - python + - /etc/app/healthcheck.py httpHeaders: - name: Custom-Header value: abc @@ -148,7 +148,7 @@ ReadinessProbe: | `successThreshold` | It defines the number of successes required before a given container is said to fulfill the readiness probe. | | `timeoutSeconds` | It defines the time for checking timeout. | | `failureThreshold` | It defines the maximum number of failures that are acceptable before a given container is not considered as ready. | -| `command` | The mentioned command is executed to perform the readinessProbe. | +| `command` | The mentioned command is executed to perform the readinessProbe. If the command returns a non-zero value, it's equivalent to a failed probe. | | `httpHeaders` | Custom headers to set in the request. HTTP allows repeated headers,You can override the default headers by defining .httpHeaders for the probe. | | `scheme` | Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP. | `tcp` | The kubelet will attempt to open a socket to your container on the specified port. If it can establish a connection, the container is considered healthy. | From acfaab15410d0e568a80b3a908e556ad6502a556 Mon Sep 17 00:00:00 2001 From: shubham9t9 Date: Sat, 12 Mar 2022 16:19:54 +0530 Subject: [PATCH 7/7] corrections in ingress --- .../deployment-template/rollout-deployment.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md index 1a4ce2004f..3d5be5472a 100644 --- a/docs/user-guide/creating-application/deployment-template/rollout-deployment.md +++ b/docs/user-guide/creating-application/deployment-template/rollout-deployment.md @@ -214,14 +214,14 @@ ingress: annotations: {} hosts: - host: example1.com + pathType: "ImplementationSpecific" paths: - /example - pathType: - host: example2.com + pathType: "ImplementationSpecific" paths: - /example2 - /example2/healthz - pathType: tls: [] ``` Legacy deployment-template ingress format @@ -241,8 +241,9 @@ ingress: | :--- | :--- | | `enabled` | Enable or disable ingress | | `annotations` | To configure some options depending on the Ingress controller | -| `path` | Path name | | `host` | Host name | +| `pathType` | Path in an Ingress is required to have a corresponding path type. Supported path types are `ImplementationSpecific`, `Exact` and `Prefix`. | +| `path` | Path name | | `tls` | It contains security details | ### Ingress Internal @@ -257,14 +258,14 @@ ingressInternal: annotations: {} hosts: - host: example1.com + pathType: "ImplementationSpecific" paths: - /example - pathType: - host: example2.com + pathType: "ImplementationSpecific" paths: - /example2 - /example2/healthz - pathType: tls: [] ``` @@ -273,6 +274,7 @@ ingressInternal: | `enabled` | Enable or disable ingress | | `annotations` | To configure some options depending on the Ingress controller | | `host` | Host name | +| `pathType` | Path in an Ingress is required to have a corresponding path type. Supported path types are `ImplementationSpecific`, `Exact` and `Prefix`. | | `path` | Path name | | `pathType` | Supported path types are `ImplementationSpecific`, `Exact` and `Prefix`.| | `tls` | It contains security details |