Skip to content

Commit 51ebbe4

Browse files
authored
Merge branch 'main' into create-cluster-doc
2 parents af531fe + 11336cd commit 51ebbe4

32 files changed

+2325
-712
lines changed

.gitbook.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ redirects:
5959
user-guide/creating-application/deployment-template/job-and-cronjob: usage/applications/creating-application/deployment-template/job-and-cronjob
6060
user-guide/creating-application/workflow: user-guide/creating-application/workflow/README.md
6161
user-guide/creating-application/workflow/ci-pipeline: user-guide/creating-application/workflow/ci-pipeline.md
62-
user-guide/creating-application/workflow/ci-pipeline/ci-build-pre-post-plugins: user-guide/creating-application/workflow/ci-build-pre-post-plugins.md
63-
usage/applications/creating-application/ci-pipeline/ci-build-pre-post-plugins: user-guide/creating-application/workflow/ci-build-pre-post-plugins.md
62+
user-guide/creating-application/workflow/ci-pipeline/ci-build-pre-post-plugins: user-guide/creating-application/workflow/pre-post-tasks.md
63+
usage/applications/creating-application/ci-pipeline/ci-build-pre-post-plugins: user-guide/creating-application/workflow/pre-post-tasks.md
6464
usage/applications/creating-application/ci-pipeline: user-guide/creating-application/workflow/ci-pipeline.md
6565
user-guide/creating-application/workflow/cd-pipeline: user-guide/creating-application/workflow/cd-pipeline.md
6666
user-guide/creating-application/workflow/ci-pipeline-legacy: user-guide/creating-application/workflow/ci-pipeline.md
@@ -164,5 +164,5 @@ redirects:
164164
user-guide/command-bar: user-guide/command-bar.md
165165
setup/install/enterprise-license: setup/install/freemium.md
166166
enterprise-license: setup/install/freemium.md
167-
168-
167+
usage/applications/creating-application/workflow/ci-pipeline/ci-build-pre-post-plugins: user-guide/creating-application/workflow/pre-post-tasks.md
168+
usage/applications/creating-application/workflow/ci-pipeline/container-registry-override: user-guide/creating-application/workflow/ci-pipeline.md

docs/FAQs/devtron-troubleshoot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -617,9 +617,9 @@ Follow the below steps if you are getting the above error:
617617

618618
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/deployment-charts/empty-values.jpg)
619619

620-
This happens due to a missing [app-values.yaml](../user-guide/global-configurations/deployment-charts.md#3-add-app-values.yaml) file in your deployment chart.
620+
This happens due to a missing [app-values.yaml](../user-guide/global-configurations/deployment-charts.md#id-3.-add-app-values.yaml) file in your deployment chart.
621621

622-
To fix this issue, include an `app-values.yaml` file in your deployment helm chart before uploading the chart. Refer [adding app-values.yaml](../user-guide/global-configurations/deployment-charts.md#3-add-app-values.yaml) to know more.
622+
To fix this issue, include an `app-values.yaml` file in your deployment helm chart before uploading the chart. Refer [adding app-values.yaml](../user-guide/global-configurations/deployment-charts.md#id-3.-add-app-valuesyaml) to know more.
623623

624624
#### 31. Unable to create a GitOps deployment pipeline or encountering errors with GitOps deployment.
625625

docs/SUMMARY.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
* [Permission Groups](user-guide/global-configurations/authorization/permission-groups.md)
4545
* [API Tokens](user-guide/global-configurations/authorization/api-tokens.md)
4646
* [Notifications](user-guide/global-configurations/manage-notification.md)
47+
* [Application Templates](user-guide/global-configurations/application-template.md)
4748
* [Deployment Window](user-guide/global-configurations/deployment-window.md)
4849
* [Approval Policy](user-guide/global-configurations/approval-policy.md)
4950
* [External Links](user-guide/global-configurations/external-links.md)
@@ -72,6 +73,7 @@
7273
* [Applications](user-guide/applications.md)
7374
* [Create a New Application](user-guide/create-application.md)
7475
* [Clone an Existing Application](user-guide/cloning-application.md)
76+
* [Create Application From Template](user-guide/using-application-templates.md)
7577
* [Deploy a Sample Application](user-guide/Deploy-sample-app/nodejs_app.md)
7678
* [App Configuration](user-guide/creating-application/README.md)
7779
* [Git Repository](user-guide/creating-application/git-material.md)
@@ -84,9 +86,8 @@
8486
* [GitOps Configuration](user-guide/creating-application/gitops-config.md)
8587
* [Workflow Editor](user-guide/creating-application/workflow/README.md)
8688
* [CI Pipeline](user-guide/creating-application/workflow/ci-pipeline.md)
87-
* [Pre-Build/Post-Build Stages](user-guide/creating-application/workflow/ci-build-pre-post-plugins.md)
88-
* [Override Build Configuration](user-guide/creating-application/container-registry-override.md)
8989
* [CD Pipeline](user-guide/creating-application/workflow/cd-pipeline.md)
90+
* [Pre/Post Stages](user-guide/creating-application/workflow/pre-post-tasks.md)
9091
* [ConfigMaps](user-guide/creating-application/config-maps.md)
9192
* [Secrets](user-guide/creating-application/secrets.md)
9293
* [External Secret Operator (ESO)](user-guide/creating-application/eso/README.md)
@@ -119,12 +120,15 @@
119120
* [Resource Browser](user-guide/resource-browser/README.md)
120121
* [Overview Page](user-guide/resource-browser/overview.md)
121122
* [Discover and Manage Resources](user-guide/resource-browser/manage-resources.md)
123+
* [Compare & Sync Clusters](user-guide/resource-browser/compare-and-sync.md)
122124
* [Nodes and Operations](user-guide/resource-browser/nodes.md)
123125
* [Pod Management and Debugging](user-guide/resource-browser/pods.md)
124126
* [Resource Recommender](user-guide/resource-browser/resource-recommender.md)
125127
* [Cluster Terminal](user-guide/resource-browser/cluster-terminal.md)
126128
* [Add Monitoring Dashboards/Graphs](user-guide/resource-browser/monitoring-graphs.md)
127129
* [Run Kubectl Commands Locally](user-guide/resource-browser/kubectl-local.md)
130+
* [Configure GUI Schema](user-guide/operations/edit-gui-schema.md)
131+
* [Configure Lock Schema](user-guide/operations/edit-lock-schema.md)
128132
* [Resource Watcher](user-guide/resource-watcher.md)
129133
* [Chart Store](user-guide/deploy-chart/README.md)
130134
* [Deploy Charts](user-guide/deploy-chart/deployment-of-charts.md)

docs/reference/glossary.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,13 @@ An OCI-compliant registry can also store artifacts (such as helm charts). Here,
6666

6767
Temporarily marking a node as unschedulable, preventing new pods from being assigned to it. In Devtron, you can cordon a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Cordon (available in blue). [Read More...](../user-guide/resource-browser/nodes.md#cordon-a-node)
6868

69+
### CRD
70+
71+
A Custom Resource Definition (CRD) allows you to add custom resource types to Kubernetes, extending its capabilities to support configurations specific to your application. In Devtron, CRDs enable you to manage these custom resources alongside standard Kubernetes resources, making it easier to handle specialized application requirements within the platform.
72+
6973
### CronJob
7074

71-
CronJob is used to create Jobs on a repeating schedule. It is commonly used for running periodic tasks with no manual intervention. In Devtron, you can view a list of cronjobs by going to Resource Browser → (choose a cluster) → Workloads → CronJob. [Read More...](../user-guide/creating-application/deployment-template/job-and-cronjob.md#2.-cronjob)
75+
CronJob is used to create Jobs on a repeating schedule. It is commonly used for running periodic tasks with no manual intervention. In Devtron, you can view a list of cronjobs by going to Resource Browser → (choose a cluster) → Workloads → CronJob. [Read More...](../user-guide/creating-application/deployment-template/job-and-cronjob.md#id-2.-cronjob)
7276

7377
### Deployment Charts
7478

@@ -86,10 +90,6 @@ A defined approach for deploying updates or changes to applications. Devtron sup
8690

8791
In Devtron, you can choose a deployment strategy by going to Applications (choose your app) → App Configuration (tab) → Workflow Editor → (edit deployment pipeline) → Deployment Strategy. [Read More...](../user-guide/creating-application/workflow/cd-pipeline.md#deployment-strategies)
8892

89-
### Devtron Agent
90-
91-
Your Kubernetes cluster gets mapped with Devtron when you save the cluster configurations. Now, the Devtron agent (rollout controller) must be installed from the chart store on the added cluster so that you can deploy your applications on that cluster. [Read More...](../user-guide/global-configurations/cluster-and-environments.md#installing-devtron-agent)
92-
9393
### Devtron Apps
9494

9595
Devtron Apps are the micro-services deployed using Kubernetes-native CI/CD with Devtron. To create one, go to Applications → Create (button) → Custom App.
@@ -164,7 +164,7 @@ In Devtron, you can view the manifest of K8s resources under `App Details` and a
164164

165165
### Material
166166

167-
In Git Repo, the source code of your application in a given commit is referred as material. The option to choose a Git material will be available in the CI stage under the `Build & Deploy` tab of your application. [Read More...](../user-guide/jobs/triggering-job.md#triggering-job-pipeline.md)
167+
In Git Repo, the source code of your application in a given commit is referred as material. The option to choose a Git material will be available in the CI stage under the `Build & Deploy` tab of your application. [Read More...](../user-guide/jobs/triggering-job.md#triggering-job-pipeline)
168168

169169
### Namespace
170170

@@ -204,19 +204,19 @@ In Devtron, you can view a list of Pods by going to Resource Browser → (choose
204204

205205
Actions or processes performed before the actual image-building process in a containerized application's deployment pipeline, e.g., Jira Issue Validator.
206206

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

209209
### Post-build
210210

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

213-
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)
213+
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/pre-post-tasks.md#creating-prepost-tasks)
214214

215215
### Pre-deployment
216216

217217
Steps, scripts, or configurations executed before deploying a new version of an application to a Kubernetes cluster.
218218

219-
In Devtron, you can configure pre-deployment actions by going to Applications (choose your app) → App Configuration (tab) → Workflow Editor → (edit deployment pipeline) → Pre-deployment stage (tab) → Add task (button). [Read More...](../user-guide/creating-application/workflow/cd-pipeline.md#3.-pre-deployment-stage)
219+
In Devtron, you can configure pre-deployment actions by going to Applications (choose your app) → App Configuration (tab) → Workflow Editor → (edit deployment pipeline) → Pre-deployment stage (tab) → Add task (button). [Read More...](../user-guide/creating-application/workflow/cd-pipeline.md#pre-deployment-stage)
220220

221221
### Post-deployment
222222

docs/user-guide/application-groups.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ This feature aims at helping the user clone existing CI/CD pipelines for new tar
195195
| Configuration Item | Cloning Behavior |
196196
|----------------------------------|--------------------------------------------------------------|
197197
| [**CI Workflow**](../user-guide/creating-application/workflow/ci-pipeline.md) | Clones the source’s workflow CI as it is |
198-
| [**Pipeline Configuration**](../user-guide/creating-application/workflow/ci-build-pre-post-plugins.md) | Cloned, including Pre-CD and Post-CD scripts/plugins |
198+
| [**Pipeline Configuration**](../user-guide/creating-application/workflow/pre-post-tasks.md) | Cloned, including Pre-CD and Post-CD scripts/plugins |
199199
| [**Environment Configuration**](../user-guide/creating-application/README.md#app-configuration) | Cloned, including Deployment Template (DT), ConfigMap (CM), and Secret |
200200
| [**GitOps Configuration**](../user-guide/creating-application/gitops-config.md) | Not cloned |
201201
| [**Environment Policies**](../user-guide/creating-application/environment-overrides.md) | Cloned if at pipeline level; ignored if global |
@@ -391,7 +391,7 @@ Users can delete a saved filter if they have Admin/Manager access on all applica
391391
Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#devtron-apps-permissions) or above (along with access to the environment and applications) to update their branch.
392392
{% endhint %}
393393

394-
Assume you have a few applications whose [build pipelines](../reference/glossary.md#build-pipeline) fetch from the `main` branch of your code repository. However, you decided to maintain a `master` branch, and you want all the upcoming CI builds to consider the `master` branch as the source. Devtron provides you the option to change the branch at both levelsindividual application as well as application group.
394+
Assume you have a few applications whose [build pipelines](../reference/glossary.md#build-pipeline) fetch from the `main` branch of your code repository. However, you decided to maintain a `master` branch, and you want all the upcoming CI builds to consider the `master` branch as the source. Devtron provides you the option to change the branch at both levels, individual application as well as application group.
395395

396396
1. In the **Build & Deploy** tab of your application group, select the intended applications and click the **Change Branch** button present at the bottom.
397397

0 commit comments

Comments
 (0)