Skip to content

Commit

Permalink
doc: pending revisions from PR-4753 (#4754)
Browse files Browse the repository at this point in the history
* Added Enterprise Tag to Custom Profile Section

* Simplified actual links to relative links

* Other fixes and typos

* CO Revision Incorporated

* CO Revision 2

* Revision 3

* Revision 4
  • Loading branch information
ashokdevtron committed Mar 6, 2024
1 parent 8364d22 commit 1f7e4ba
Show file tree
Hide file tree
Showing 14 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ In Devtron, you can configure pre-build actions by going to Applications (choose

Actions or processes performed after the [image](#image) building process in a containerized application's deployment pipeline, e.g., email notification about build status.

In Devtron, you can configure post-build actions by going to Applications (choose your app) → App Configuration (tab) → Workflow Editor → (edit build pipeline) → Post-build stage (tab) → Add task (button). [Read More...](../user-guide/creating-application/workflow/ci-build-pre-post-plugins#configuring-pre-post-build-tasks)
In Devtron, you can configure post-build actions by going to Applications (choose your app) → App Configuration (tab) → Workflow Editor → (edit build pipeline) → Post-build stage (tab) → Add task (button). [Read More...](../user-guide/creating-application/workflow/ci-build-pre-post-plugins.md#configuring-pre-post-build-tasks)

### Pre-deployment

Expand Down
2 changes: 1 addition & 1 deletion docs/setup/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can create a cluster using one of the following cloud providers as per your
| **AWS EKS** | Create a cluster using [AWS EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-console.html). <br>`Note`: You can also refer our customized documentation for installing `Devtron with CI/CD` on AWS EKS [here](https://github.com/devtron-labs/devtron/blob/b33a37bb608d07966c8f8b89e4f59287db873c6c/docs/setup/install/install-devtron-on-aws-eks.md).</br> |
| **Google Kubernetes Engine (GKE)** | Create a cluster using [GKE](https://cloud.google.com/kubernetes-engine/). |
| **Azure Kubernetes Service (AKS)** | Create a cluster using [AKS](https://learn.microsoft.com/en-us/azure/aks/). |
| **k3s - Lightweight Kubernetes** | Create a cluster using [k3s - Lightweight Kubernetes](https://devtron.ai/blog/deploy-your-applications-over-k3s-lightweight-kubernetes-in-no-time/).<br>`Note`: You can also refer our customized documentation for installing `Helm Dashboard by Devtron` on `Minikube, Microk8s, K3s, Kind` [here](../install/install-devtron-on-minikube-microk8s-k3s-kind.md).</br> |
| **k3s - Lightweight Kubernetes** | Create a cluster using [k3s - Lightweight Kubernetes](https://devtron.ai/blog/deploy-your-applications-over-k3s-lightweight-kubernetes-in-no-time/).<br>`Note`: You can also refer our customized documentation for installing `Helm Dashboard by Devtron` on `Minikube, Microk8s, K3s, Kind` [here](../install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md).</br> |



Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/application-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ As shown below, you can handle the configurations of more than one application f
![Figure 8: Configurations of each App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/configurations.jpg)

{% hint style="info" %}
Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to change their configuration. Please note, you might not be able to change the values of locked keys in deployment template. Refer [Lock Deployment Config](./global-configurations/lock-deployment-config.md) to know more.
Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to change their configuration. Please note, you might not be able to change the values of locked keys in deployment template. Refer [Lock Deployment Configuration](./global-configurations/lock-deployment-config.md) to know more.
{% endhint %}


Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/bulk-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This feature helps you to update Deployment Template, ConfigMaps & Secrets for m

Need to make some common changes across multiple devtron applications?
**Bulk Edit** allows you to do that.<br>
Eg. You can change the value for `MaxReplicas` in Deployment Templates of multiple Devtron applications or you can add key-value pairs in multiple ConfigMaps & Secrets. However, you might not be able to change the values of locked keys. Refer [Lock Deployment Config](./global-configurations/lock-deployment-config.md) to know more.
Eg. You can change the value for `MaxReplicas` in Deployment Templates of multiple Devtron applications or you can add key-value pairs in multiple ConfigMaps & Secrets. However, you might not be able to change the values of locked keys. Refer [Lock Deployment Configuration](./global-configurations/lock-deployment-config.md) to know more.

## Support
Bulk edit is currently supported for:
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/config-approval.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Let's assume you are the application admin and you wish to edit the deployment t
![Figure 3: Changed Values](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/config-approval/changed-values.jpg)

{% hint style="info" %}
If you are not a super-admin, you cannot modify the locked keys in deployment template. Refer [Lock Deployment Config](../global-configurations/lock-deployment-config.md) to know more.
If you are not a super-admin, you cannot modify the locked keys in deployment template. Refer [Lock Deployment Configuration](../global-configurations/lock-deployment-config.md) to know more.
{% endhint %}

4. If the configuration is protected, your changes won't be published right away. You can do either of the following:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ Enable **show application metrics** toggle to view the application metrics on th
Select **Save & Next** to save your configurations.

{% hint style="warning" %}
Super-admins can lock keys in base deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Config](../global-configurations/lock-deployment-config.md) to know more.
Super-admins can lock keys in base deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Configuration](../global-configurations/lock-deployment-config.md) to know more.
{% endhint %}
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can define application behavior by providing information in the following se
| `Show application metrics` | You can enable `Show application metrics` to see your application's metrics-CPU Service Monitor usage, Memory Usage, Status, Throughput and Latency.<br>Refer [Application Metrics](../../creating-application/app-metrics.md) for more detail.</br> |

{% hint style="warning" %}
Super-admins can lock keys in deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Config](../../global-configurations/lock-deployment-config.md) to know more.
Super-admins can lock keys in deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Configuration](../../global-configurations/lock-deployment-config.md) to know more.
{% endhint %}


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,5 @@ cronjobConfigs:
| `kind` | As with all other Kubernetes config, a Job and cronjob needs apiVersion, kind.cronjob and job also needs a section fields which is optional . these fields specify to deploy which job (conjob or job) should be kept. by default, they are set cronjob. |

{% hint style="warning" %}
Super-admins can lock keys in Job & CronJob deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Config](../../global-configurations/lock-deployment-config.md) to know more.
Super-admins can lock keys in Job & CronJob deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Configuration](../../global-configurations/lock-deployment-config.md) to know more.
{% endhint %}
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can define application behavior by providing information in the following se
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/deployment-template/deployment-template.gif)

{% hint style="warning" %}
Super-admins can lock keys in rollout deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Config](../../global-configurations/lock-deployment-config.md) to know more.
Super-admins can lock keys in rollout deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Configuration](../../global-configurations/lock-deployment-config.md) to know more.
{% endhint %}

## 1. Chart version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can select `StatefulSet` chart when you want to use only basic use cases whi
* **Resource Cleanup:** StatefulSets allow for easy cleanup of older versions by deleting StatefulSets and their associated Pods and persistent volumes that are no longer needed, ensuring efficient resource utilization.

{% hint style="warning" %}
Super-admins can lock keys in StatefulSet deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Config](../../global-configurations/lock-deployment-config.md) to know more.
Super-admins can lock keys in StatefulSet deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Configuration](../../global-configurations/lock-deployment-config.md) to know more.
{% endhint %}


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you want to configure **Basic** GUI at the application level, then you can pr
If `Basic` is locked, you can modify the configurations on `Advanced (YAML)` which will be the default page.

{% hint style="warning" %}
Super-admins can lock keys in deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Config](../../global-configurations/lock-deployment-config.md) to know more.
Super-admins can lock keys in deployment template to prevent non-super-admins from modifying those locked keys. Refer [Lock Deployment Configuration](../global-configurations/lock-deployment-config.md) to know more.
{% endhint %}

**Note**: **Delete Override** will discard the current overrides and the base configuration will be applicable to the environment.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/global-configurations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Before you start creating an application, we recommend to provide basic informat

[Filter Condition](filter-condition.md)

[Lock Deployment Config](lock-deployment-config.md)
[Lock Deployment Configuration](lock-deployment-config.md)

[Build Infra](build-infra.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/global-configurations/build-infra.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ From the left sidebar, go to **Global Configurations** → **Build Infra**.

![Figure 1: Global Configurations - Build Infra](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/build-infra/gc-build-infra.jpg)

You will see the [Default Profile](#default-profile) and a list of [Custom Profiles](#custom-profile) (if they exist). Setting up profiles makes it easier for you to manage the build infra configurations, ensuring its reusability in the long term.
You will see the [Default Profile](#default-profile) and a list of [Custom Profiles](#creating-custom-profile) (if they exist). Setting up profiles makes it easier for you to manage the build infra configurations, ensuring its reusability in the long term.

### Default Profile

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Lock Deployment Config
# Lock Deployment Configuration

## Introduction [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)

Expand All @@ -16,7 +16,7 @@ This stands true for deployment templates in:

The 'protect configuration' feature is meant to verify the edits by introducing an approval flow for any changes made to the configuration files, i.e., Deployment template, ConfigMaps, and Secrets. This is performed at application-level.

Whereas, the 'lock deployment config' feature goes one step further. It is meant to prevent any edits to specific keys by non-super-admins. This applies only to deployment templates and is performed at global-level.
Whereas, the 'lock deployment configuration' feature goes one step further. It is meant to prevent any edits to specific keys by non-super-admins. This applies only to deployment templates and is performed at global-level.

---

Expand Down

0 comments on commit 1f7e4ba

Please sign in to comment.