Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/FAQs/devtron-troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ The other way is to get the password in the encoded form using the cmd
Error: UPGRADE FAILED: cannot patch "postgresql-postgresql" with kind StatefulSet: StatefulSet.apps "postgresql-postgresql" is invalid: spec: Forbidden: updates to statefulset spec for fields other than 'replicas', 'template', 'updateStrategy' and 'minReadySeconds' are forbidden
```
`Solution:`
Verify if annotations & lables are set to all k8s resources in `devtroncd` namespace and add `--set components.postgres.persistence.volumeSize=20Gi` parameter in Devtron upgrade command.
Verify if annotations & labels are set to all k8s resources in `devtroncd` namespace and add `--set components.postgres.persistence.volumeSize=20Gi` parameter in Devtron upgrade command.
```bash
helm upgrade devtron devtron/devtron-operator --namespace devtroncd \
-f https://raw.githubusercontent.com/devtron-labs/devtron/main/charts/devtron/devtron-bom.yaml \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Select the Cluster & Environment section of global configuration and click on `A

To add a cluster on devtron, you must have superadmin access.

Navigate to the `Global Configurations` → `Clusters and Environments` on devtron and click on `Add Cluster`. Provide the below informations to add your kubernetes cluster:
Navigate to the `Global Configurations` → `Clusters and Environments` on devtron and click on `Add Cluster`. Provide the below information to add your kubernetes cluster:

1. Name
2. Kubernetes Cluster Info
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Click on `Add User`, to add one or multiple users.
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/hyperion/user-guide/global-configurations/user-access/hyperion-gc-add-user.jpg)

### 2. Search the existing User
Click on `Seach Box`, and type your user's email
Click on `Search Box`, and type your user's email

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/hyperion/user-guide/global-configurations/user-access/hyperion-gc-search-user.jpg)

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ If you are a super-admin in Devtron, you can view Jobs in the sidebar.

Distributes incoming network traffic across multiple instances or nodes to ensure efficient resource utilization and improved performance. In Kubernetes, Load Balancer is a service type. Behind the scenes, the managed Kubernetes service connects to the load balancer service of the respective cloud service provider and creates a load balancer, mapping it to the Kubernetes service.

GKE and AKE provide the public IP of the Load Balancer as the service endpoint, while in the case of EKS, it provides a non-customizable DNS name.
GKE and AKS provide the public IP of the Load Balancer as the service endpoint, while in the case of EKS, it provides a non-customizable DNS name.

### Manifest

Expand Down
2 changes: 1 addition & 1 deletion docs/setup/getting-started/why-devtron.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This is where **Devtron** comes into the picture!

The need to declaratively manage Kubernetes clusters and application delivery is what is driving **Devtron** on Kubernetes.

Devtron is an open-source modular product that provides a `seamless` and `implementated agnostic uniform interface`, that can be integrated with both open-source and commercial tools across the entire application lifecycle.
Devtron is an open-source modular product that provides a `seamless` and `implementation-agnostic uniform interface`, that can be integrated with both open-source and commercial tools across the entire application lifecycle.

With Devtron, you can efficiently handle security, stability, cost, and more in a unified experience.

Expand Down
2 changes: 1 addition & 1 deletion docs/setup/install/install-devtron-helm-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ We also release beta versions of devtron every few days before the stable releas

This chart is currently not available on the official helm repository therefore you need to download it to install it.

1. Clone Devtron Repositry
1. Clone Devtron Repository
2. Upgrade Helm Dependency
3. Install Devtron

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/app-labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ We also add or remove labels for app from here.

* `id` : integer unique label id
* `appId` : integer application id
* `key` : string key is tha part of label stores individually in db.
* `value` : string value is tha part of label stores individually in db.
* `key` : string key is the part of label stored individually in db.
* `value` : string value is the part of label stored individually in db.
4 changes: 2 additions & 2 deletions docs/user-guide/cloning-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Click on `Create New` and the select `Custom app` to create a new application.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cloning-application/custom-app.jpg)

As soon you click on `Custom app`, you will get a popup window on screen where you have to enter `app name` and `project` for the application. there are two radio buttons present on the popup window, one is for `Blank app` and another one is for `Clone an existing app`. For cloning an existing application, select the second one. After this, one more drop-down will appear on the window from which you can select the application that you want to clone. For this, you will have to type minimum three character to see the matching results in the drop-down. After typing the matching characters, select the applicaion that you want to clone. You also can add additional information about the application (eg. `created by`, `Created on`) using `tags` (only key:value allowed).
As soon you click on `Custom app`, you will get a popup window on screen where you have to enter `app name` and `project` for the application. there are two radio buttons present on the popup window, one is for `Blank app` and another one is for `Clone an existing app`. For cloning an existing application, select the second one. After this, one more drop-down will appear on the window from which you can select the application that you want to clone. For this, you will have to type minimum three character to see the matching results in the drop-down. After typing the matching characters, select the application that you want to clone. You also can add additional information about the application (eg. `created by`, `Created on`) using `tags` (only key:value allowed).

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cloning-application/clone-app.jpg)

Expand All @@ -13,7 +13,7 @@ Click on `Create New` and the select `Custom app` to create a new application.
| `App Name` | Name of the new app you want to Create |
| `Project` | Project name |
| `Select an app to clone` | Select the application that you want to clone |
| `Tags` | Additional informations about the application |
| `Tags` | Additional information about the application |

Now click on `Clone App` to clone the selected application.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,6 @@ kubectl describe pod <podname>
Here, you can see configuration information about the container(s) and Pod (labels, resource requirements, etc.), as well as status information about the container(s) and Pod (state, readiness, restart count, events, etc.).


**Note**: A container can have no or multiple shells running in it. If you are not able to create a successfull connection, try changing the shell, as the container may not have that shell running.
**Note**: A container can have no or multiple shells running in it. If you are not able to create a successful connection, try changing the shell, as the container may not have that shell running.


2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/app-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ CPU usage is a utilization metric that shows the overall utilization of cpu by a

## Status Code Metrics

This metrics indicates the application’s response to client’s request with a specific status code i.e 1xx(Communicate transfer protocol leve information), 2xx(Client’s request was accepted successfully), 3xx(Client must take some additional action to complete their request), 4xx(Client side error) or 5xx(Server side error).
This metrics indicates the application’s response to client’s request with a specific status code i.e 1xx(Communicate transfer protocol-level information), 2xx(Client’s request was accepted successfully), 3xx(Client must take some additional action to complete their request), 4xx(Client side error) or 5xx(Server side error).

## Latency Metrics

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Within the same application, you can override a `container registry`, `container

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/build-allow-override.jpg)

To override a container registry, container image or target paltform:
To override a container registry, container image or target platform:

* Go to **Applications** and select your application from the **Devtron Apps** tabs.
* On the **App Configuration** tab, select **Workflow Editor**.
Expand All @@ -19,7 +19,7 @@ To override a container registry, container image or target paltform:

* Click **Update Pipeline**.

The overriden container registry/container image location/target platform will be reflected on the [Build Configuration](docker-build-configuration.md) page. You can also see the number of build pipelines for which the container registry/container image location/target platform is overriden.
The overridden container registry/container image location/target platform will be reflected on the [Build Configuration](docker-build-configuration.md) page. You can also see the number of build pipelines for which the container registry/container image location/target platform is overridden.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-ci-pipeline/build-configuration-overridden.jpg)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ flaggerCanary:
| `enabled` | Set true to enable canary releases using flagger else set false |
| `addOtherGateways` | To provide multiple istio gateways for flagger |
| `addOtherHosts` | Add multiple hosts for istio service mesh with flagger |
| `analysis` | Define how the canary release should progresss and at what interval |
| `analysis` | Define how the canary release should progress and at what interval |
| `annotations` | Annotation to add on flagger resource |
| `labels` | Labels to add on flagger resource |
| `appProtocol` | Protocol to use for canary |
Expand Down Expand Up @@ -1008,12 +1008,12 @@ winterSoldier:

| Key | values | Description |
| :--- | :--- | :--- |
| `enabled` | `fasle`,`true` | decide the enabling factor |
| `enabled` | `false`,`true` | decide the enabling factor |
| `apiVersion` | `pincher.devtron.ai/v1beta1`, `pincher.devtron.ai/v1alpha1` | specific api version |
| `action` | `sleep`,`delete`, `scale` | This specify the action need to perform. |
| `timeRangesWithZone`:`timeZone` | eg:- `"Asia/Kolkata"`,`"US/Pacific"` | It use to specify the timeZone used. (It uses standard format. please refer [this](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)) |
| `timeRangesWithZone`:`timeRanges` | array of [ `timeFrom`, `timeTo`, `weekdayFrom`, `weekdayTo`] | It use to define time period/range on which the user need to perform the specified action. you can have multiple timeRanges. <br /> These settings will take `action` on Sat and Sun from 00:00 to 23:59:59, |
| `targetReplicas` | `[n]` : n - number of replicas to scale. | These is mandatory field when the `action` is `scale` <br /> Defalut value is `[]`. |
| `targetReplicas` | `[n]` : n - number of replicas to scale. | These is mandatory field when the `action` is `scale` <br /> Default value is `[]`. |
| `fieldSelector` | `- AfterTime(AddTime( ParseTime({{metadata.creationTimestamp}}, '2006-01-02T15:04:05Z'), '5m'), Now()) ` | These value will take a list of methods to select the resources on which we perform specified `action` . |


Expand Down Expand Up @@ -1044,7 +1044,7 @@ winterSoldier:
fieldSelector:
- AfterTime(AddTime( ParseTime({{metadata.creationTimestamp}}, '2006-01-02T15:04:05Z'), '10h'), Now())
```
Above settings will take action on `Sat` and `Sun` from 00:00 to 23:59:59, and on `Mon`-`Fri` from 00:00 to 08:00 and 20:00 to 23:59:59. If `action:sleep` then runs hibernate at timeFrom and unhibernate at `timeTo`. If `action: delete` then it will delete workloads at `timeFrom` and `timeTo`. Here the `action:scale` thus it scale the number of resource replicas to `targetReplicas: [1,1,1]`. Here each element of `targetReplicas` array is mapped with the corresponding elments of array `timeRangesWithZone/timeRanges`. Thus make sure the length of both array is equal, otherwise the cnages cannot be observed.
Above settings will take action on `Sat` and `Sun` from 00:00 to 23:59:59, and on `Mon`-`Fri` from 00:00 to 08:00 and 20:00 to 23:59:59. If `action:sleep` then runs hibernate at timeFrom and unhibernate at `timeTo`. If `action: delete` then it will delete workloads at `timeFrom` and `timeTo`. Here the `action:scale` thus it scale the number of resource replicas to `targetReplicas: [1,1,1]`. Here each element of `targetReplicas` array is mapped with the corresponding elements of array `timeRangesWithZone/timeRanges`. Thus make sure the length of both array is equal, otherwise the cnages cannot be observed.

The above example will select the application objects which have been created 10 hours ago across all namespaces excluding application's namespace. Winter soldier exposes following functions to handle time, cpu and memory.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ EnvVariables:
value: xyz
```

But `ConfigMap` and `Secret` are the prefered way to inject env variables. You can create this in `App Configuration` Section.
But `ConfigMap` and `Secret` are the preferred way to inject env variables. You can create this in `App Configuration` Section.

### ConfigMap

Expand Down Expand Up @@ -1012,7 +1012,7 @@ envoyproxy.resources.limits.memory >= envoyproxy.resources.requests.memory

### KEDA Autoscaling

**Prerequisite:** KEDA contoller should be installed in the cluster. To install KEDA controller using Helm, navigate to chart store and search for `keda` chart and deploy it. You can follow this [documentation](../../deploy-chart/deployment-of-charts.md) for deploying a Helm chart on Devtron.
**Prerequisite:** KEDA controller should be installed in the cluster. To install KEDA controller using Helm, navigate to chart store and search for `keda` chart and deploy it. You can follow this [documentation](../../deploy-chart/deployment-of-charts.md) for deploying a Helm chart on Devtron.

KEDA Helm repo : https://kedacore.github.io/charts

Expand Down Expand Up @@ -1157,12 +1157,12 @@ winterSoldier:

| Key | values | Description |
| :--- | :--- | :--- |
| `enabled` | `fasle`,`true` | decide the enabling factor |
| `enabled` | `false`,`true` | decide the enabling factor |
| `apiVersion` | `pincher.devtron.ai/v1beta1`, `pincher.devtron.ai/v1alpha1` | specific api version |
| `action` | `sleep`,`delete`, `scale` | This specify the action need to perform. |
| `timeRangesWithZone`:`timeZone` | eg:- `"Asia/Kolkata"`,`"US/Pacific"` | It use to specify the timeZone used. (It uses standard format. please refer [this](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)) |
| `timeRangesWithZone`:`timeRanges` | array of [ `timeFrom`, `timeTo`, `weekdayFrom`, `weekdayTo`] | It use to define time period/range on which the user need to perform the specified action. you can have multiple timeRanges. <br /> These settings will take `action` on Sat and Sun from 00:00 to 23:59:59, |
| `targetReplicas` | `[n]` : n - number of replicas to scale. | These is mandatory field when the `action` is `scale` <br /> Defalut value is `[]`. |
| `targetReplicas` | `[n]` : n - number of replicas to scale. | These is mandatory field when the `action` is `scale` <br /> Default value is `[]`. |
| `fieldSelector` | `- AfterTime(AddTime( ParseTime({{metadata.creationTimestamp}}, '2006-01-02T15:04:05Z'), '5m'), Now()) ` | These value will take a list of methods to select the resources on which we perform specified `action` . |


Expand Down Expand Up @@ -1194,7 +1194,7 @@ winterSoldier:
- AfterTime(AddTime( ParseTime({{metadata.creationTimestamp}}, '2006-01-02T15:04:05Z'), '10h'), Now())
```

Above settings will take action on `Sat` and `Sun` from 00:00 to 23:59:59, and on `Mon`-`Fri` from 00:00 to 08:00 and 20:00 to 23:59:59. If `action:sleep` then runs hibernate at timeFrom and unhibernate at `timeTo`. If `action: delete` then it will delete workloads at `timeFrom` and `timeTo`. Here the `action:scale` thus it scale the number of resource replicas to `targetReplicas: [1,1,1]`. Here each element of `targetReplicas` array is mapped with the corresponding elments of array `timeRangesWithZone/timeRanges`. Thus make sure the length of both array is equal, otherwise the cnages cannot be observed.
Above settings will take action on `Sat` and `Sun` from 00:00 to 23:59:59, and on `Mon`-`Fri` from 00:00 to 08:00 and 20:00 to 23:59:59. If `action:sleep` then runs hibernate at timeFrom and unhibernate at `timeTo`. If `action: delete` then it will delete workloads at `timeFrom` and `timeTo`. Here the `action:scale` thus it scale the number of resource replicas to `targetReplicas: [1,1,1]`. Here each element of `targetReplicas` array is mapped with the corresponding elements of array `timeRangesWithZone/timeRanges`. Thus make sure the length of both array is equal, otherwise the cnages cannot be observed.

The above example will select the application objects which have been created 10 hours ago across all namespaces excluding application's namespace. Winter soldier exposes following functions to handle time, cpu and memory.

Expand Down
Loading