From d415b06e40b153d618cd84906d9be8923bb22972 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 1 Apr 2025 13:04:37 +0530 Subject: [PATCH 01/10] docs: Revamp Application Overview Doc --- .../creating-application/overview.md | 248 ++++++++++++++---- 1 file changed, 191 insertions(+), 57 deletions(-) diff --git a/docs/user-guide/creating-application/overview.md b/docs/user-guide/creating-application/overview.md index 7fa87a0b4..11c8a373d 100644 --- a/docs/user-guide/creating-application/overview.md +++ b/docs/user-guide/creating-application/overview.md @@ -1,122 +1,256 @@ # Overview -The `Overview` section contains the brief information of the application, any added tags, configured external links and deployment details of the particular application. -In this section, you can also [change project of your application](#change-project-of-your-application) and [manage tags](#manage-tags) if you added them while creating application. +The Overview page provides a centralized view of an application’s details within Devtron. It allows users to quickly access information about the application, manage tags, view deployment environments, and understand inter-app dependencies — all in a single, organized interface. + +The `Overview` page contains three main sections: +* [`About`](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and configure PVCs. +* [`Environments`](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. +* [`Dependencies`](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it — helping visualize inter-app relationships. ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg) +## About + +The `About` section allows you to: + +* View key application details +* Change the project your application is assigned to +* Manage tags that you may have added during the application’s creation +* Configure Persistent Volume Claims (PVCs) -The following details are provided on the **Overview** page: +The left side of the `About` section displays essential information about the application. -| Fields | Description | -| :--- | :--- | -| **App Name** | Displays the name of the application. | -| **Created on** | Displays the day, date and time the application was created. | -| **Created by** | Displays the email address of a user who created the application. | -| **Project** | Displays the current project of the application. You can change the project by selecting a different project from the drop-down list. | +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/left-about.jpg) + The table below captures all the key elements presented in this section, along with their descriptions and whether they can be edited by the user. -## Change Project of your Application +| Field Name | User Editable |Description| +| :--------- | :--------------- |:--------- | +| `Application Name` | No |Displays the name of the application (e.g., backend-healthcare-app).| +| `Short Description`|Yes|A short, optional description to summarize the application's purpose.| +| `Project` |Yes|Indicates the current project under which the application is organized.
You can change the project directly from this section.
  1. Click the `Edit` icon next to the current project.
  2. In the `Change Project` window, select the new project from the dropdown.
  3. Click `Save`.
Changing the project will revoke access for existing users and grant access only to those who have permissions in the newly selected project.| +| `Created on` |No|Shows the exact date and time when the application was created.| +| `Created by`|No|Displays the email address of the user who created the application.| +| `Code Source` |No|Shows the connected Git repository or template used for the application.| +| `Part of release track` |No|Lists all release track names linked to the app.| +| `Tags` |Yes|Key-value pairs used for identifying and organizing the application.
Users can propagate tags as Kubernetes labels to enable filtering, bulk operations, and integrations with Kubernetes tools.
  1. Click the `Edit` icon next to `Tags`.
  2. On the `Manage Tags` page, Click `+ Add tag` to add a new tag.
  3. You can click `X` icon to delete an existing tag.
  4. You can click the `propagation icon` to propagate a tag (turns dark grey when propagated), click again to remove propagation.
    [[Snapshot](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-latest-1.jpg)]
  5. Click `Save`, Configured Tags will reflect immediately under `Tags` in `About` Section
| -You can change the project of your application by clicking **Project** on the `Overview` section. +### Readme +The right side of the `About` section contains a `README` area where you can maintain application-specific notes or documentation. The `Readme` supports Markdown formatting, making it easy to include formatted text, instructions, or important context related to the application. -1. Click `Project`. -2. On the `Change project` dialog box, select the different project you want to change from the drop-down list. +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme-edit.jpg) - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/change-project-app-1.jpg) +To add or update the `README`: +1. Click the `Edit` button in the Readme section. +2. A Markdown editor will appear where you can write or modify content under the `Write` tab. +3. Use standard Markdown syntax to format text, create lists, insert links, and more. +4. Preview the content using the `Preview` tab. +5. Click `Save` to update the README. -3. Click **Save**. The application will be moved to the selected project. +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme.jpg) {% hint style="info" %} -### If you change the project: + After saving, the system displays the email address of the user who last updated the README, along with the date and time. This information appears in the header of the Readme section, beside the title. +{% endhint %} + +### Deployment Window [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) + +The `Deployment Window` in the `About` section displays all `Blackout Windows` and `Maintenance Windows` configured for your application’s environments. -The current users will lose the access to the application. +These windows are defined by `Super-Admins` to control when deployments and related actions are allowed or blocked. The goal is to minimize disruptions during critical business hours or maintenance periods. -The users who already have an access to the selected project, will get an access to the application automatically. +* `Blackout Window`: Periods during which deployments are strictly blocked. +* `Maintenance Window`: Periods during which deployments are allowed; outside of this window, they are blocked. +* If both are configured for the same time period, `Blackout Window` takes precedence. + +You can expand each environment row to view detailed information like window name, duration, and frequency. + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg) + +{% hint style=“info” %} +This section is view-only and does not require any configuration at the application level. {% endhint %} +> To learn how to configure deployment windows, refer to the [Deployment Window documentation](../global-configurations/deployment-window.md). -## Manage Tags +### Catalog [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) -`Tags` are key-value pairs. You can add one or multiple tags in your application. When tags are propagated, they are considered as labels to Kubernetes resources. Kubernetes offers integrated support for using these labels to query objects and perform bulk operations e.g., consolidated billing using labels. You can use these tags to filter/identify resources via CLI or in other Kubernetes tools. +The `Catalog` in the `About` section displays information about your application—such as documentation references, ownership details, and technical specifications. This data is managed using [Devtron’s Catalog Framework](../global-configurations/catalog-framework.md). -`Manage tags` is the central place where you can create, edit, and delete tags. You can also propagate tags as labels to Kubernetes resources for the application. +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg) -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-latest-1.jpg) +`Super-Admins` define a custom JSON schema that determines what fields are shown in the catalog form. This schema is specific to each resource type, such as Devtron applications. -* Click `Edit`. -* On the `Manage tags` page, click `+ Add tag` to add a new tag. -* Click `X` to delete a tag. -* Click the symbol on the left side of your tag to propagate a tag.
+When you click the `Edit` icon, a form appears based on the defined schema. As an application owner or client, you can fill out fields like: +* Documentation (e.g., API contract, service documentation) +* Code owners and on-call responsibilities +* Service attributes (e.g., internet-facing flag, communication method, framework, language) -{% hint style="info" %} -Dark grey colour in symbol specifies that the tags are propagated. +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-expanded.jpg) + +{% hint style= "info" %} +The structure and labels in the catalog form are entirely configurable by your platform team via JSON schema in `Catalog Framework`. Field names and sections may vary depending on how the schema was defined by your organization. {% endhint %} -* To remove the tags from propagation, click the symbol again. +Once saved, this information is displayed in a readable format within the Catalog subsection and is accessible to all users who have permission to view the application. + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-final.jpg) -* Click `Save`. +### Configure PersistentVolumeClaim (PVC) -The changes in the tags will be reflected in the `Tags` on the `Overview` section. +A [PersistentVolumeClaim (PVC)](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) is a request for storage, which is used to mount a PersistentVolume (PV) into a Pod that can be used by your application’s CI pipeline. +In Devtron, you can use a PersistentVolumeClaim (PVC) to provide persistent storage to the Pod that runs your CI pipeline, enabling the pod to store and reuse cached data such as dependencies. This is particularly beneficial when building for multiple target platforms like amd64 and arm64, where caching can significantly reduce build time. -## Configure PersistentVolumeClaim (PVC) for Build Time Optimization +Mounting a PVC into the build Pod gives it access to a dedicated storage volume for caching, without interfering with the normal build process, which continues to run based on the architecture and operating system of the Kubernetes node where the CI pipeline is executed. - A PersistentVolumeClaim (PVC) volume is a request for storage, which is used to mount a PersistentVolume (PV) into a Pod. In order to optimize build time, you can configure PVC in your application. +#### Configure PVC in Your Application -If you want to optimize build time for the multiple target platforms (e.g., arm64, amd64), mounting a PVC will provide volume directly to a pod which helps in shorter build time by storing build cache. Mounting a PVC into a pod will provide storage for build cache which will not impact the normal build where the image is built on the basis of architecture and operating system of the K8s node on which CI is running. +**1.** **Create a PVC** -### Create PVC file +Before you can configure an Application to use a PVC, you need to make sure the PVC is created in the Kubernetes cluster. -* The following configuration file describes persistent volume claim e.g.,`cache-pvc.yaml`, where you have to define the metadata `name` and `storageClassname`. +The following is a sample PVC YAML configuration. You can modify it as needed based on your storage class, access mode, and resource requirements: -```bash +``` apiVersion: v1 kind: PersistentVolumeClaim metadata: - name: cache-pvc # here comes the name of PVC + name: cache-pvc + namespace: devtron-ci spec: accessModes: - ReadWriteOnce - storageClassName: # here comes storage class name + storageClassName: standard-rwo resources: requests: storage: 30Gi -``` +``` +You can apply this configuration using either of the following methods: -* Create the PersistentVolumeClaim by running the following command: +##### Apply using kubectl -```bash -kubectl apply -f https://k8s.io/examples/pods/storage/pv-claim.yaml -n {namespace} +1. Save the above YAML in a file named `cache-pvc.yaml`. +2. Run the following command: +``` +kubectl apply -f cache-pvc.yaml ``` +3. The PVC will now be created and visible using: +``` +kubectl get pvc -n devtron-ci +``` +4. You should see its status as `Bound`, indicating that it’s successfully created and ready to be used by your CI pipelines. + +##### Apply using Devtron’s Resource Browser + +1. Navigate to `Resource Browser` in the Devtron sidebar. +2. Select the Cluster where your CI pipelines run. +3. Click `Create Resource`. +4. Paste the YAML into the editor and click `Create`. +5. The PVC will now be created and will appear under `Resource Browser` → `Config & Storage` → `PersistentVolumeClaim` with the status shown as `Bound` + +**2.** **Apply PVC to CI Pipelines Using Tags** + +Once PVC is created and in the Bound state, the next step is to configure it within your application using tags from the `About` section. + +Devtron allows you to define special tags as key-value pairs. These tags act as instructions for Devtron to mount the specified PVC to the Pod where the CI pipeline runs, making the storage available during pipeline execution. + +You can choose to mount the PVC for all pipelines in the application or for a specific pipeline, depending on your use case. The configuration remains the same in both cases — the only difference lies in the tag key used to define the scope of the PVC. + +Follow the steps below to apply the PVC to all or specific pipelines +1. Navigate to your application’s `Overview` → `About` section. +2. Click the `Edit` icon next to the Tags section. + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pvc-edit-tags-1.jpg) + +3. Add one of the following key-value tags depending on how you want the PVC to be applied + * To mount the PVC across all pipelines in the application + +| Key | Value| +|:--- |:--- | +|devtron.ai/ci-pvc-all | cache-pvc | + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-pvc-1.jpg) + + * To mount the PVC for a specific pipeline only in the application + +| Key | Value| +|:--- |:--- | +|devtron.ai/ci-pvc-| cache-pvc | + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-name-pvc-1.jpg) + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-level-tag.jpg) + +> Replace with the exact name of the CI pipeline (visible in the Workflow Editor). + +4. Click `Save` to apply the tag. + +After saving, Devtron will automatically mount the PVC into your CI pipeline Pod, allowing it to use the configured persistent storage for caching purposes. No further manual configuration is required. + +## Environments + +The Environments section provides a detailed view of all environments where the application is configured. For each environment, it displays + +| Field Name |Description| +| :--------- |:--------- | +| Application Status |The current application status in that particular environment.| +| Environment | Displays the name of the Environment.| +| Last Deployed|Shows the image tag or artifact version from the latest deployment. If the application has not been deployed yet, this shows Not Deployed.| +| Comit|Displays the Git commit hash associated with the last deployment.| +| Deployed AT|Indicates who deployed the application and when, it is shown as the email ID of the user along with a relative timestamp (e.g.,9 days ago).| + +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg) + +## Dependencies [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) + +The Dependencies section displays the relationship of the current application with other Devtron-managed applications in the form of upstream and downstream dependencies. + +* `Upstream dependencies` are other applications that the current application depends on. +* `Downstream dependencies` are applications that rely on the current application. + +### Upstream Dependencies + +Upstream dependencies are other Devtron applications that your current application depends on. You can manually define upstream dependencies to indicate that your application depends on certain devtron applications. + +To add upstream dependencies: +1. Click the `Add Dependency` button in the `Dependencies` section. If dependencies already exist, click the `Edit Dependency` button on the right instead. -For more detail, refer [Kubernetes PVC](https://kubernetes.io/docs/tasks/configure-pod-container/configure-persistent-volume-storage/#create-a-persistentvolumeclaim). +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies.jpg) +2. In the right-side panel, under `UPSTREAM DEPENDENCY`, click `+ Add Dependency`. -## Configure PVC +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg) -In order to configure PVC: -* Go to the `Overview` section of your application. -* On the right-corner, click `Edit`. +3. Use the search bar to find and select one or more applications that your app depends on. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pvc-edit-tags-1.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-3.jpg) -* For app level PVC mounting, enter the following:
  • key:`devtron.ai/ci-pvc-all`
  • value: metadata name (e.g., `cache-pvc)` which you define on the [PVC template](#create-pvc-file).
`Note`: This PVC mounting will impact all the build pipelines of the application. +4. Click `Map Environments` to associate each selected application with a specific environment. + * This helps Devtron understand where your dependencies are running. By mapping environments, you can view the correct deployment details (like image, commit, and status) for each dependency. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-pvc-1.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-4.jpg) -* For pipeline level, enter the following:
  • key:`devtron.ai/ci-pvc-{pipelinename}`
  • value: metadata name which you define on the [PVC template](#create-pvc-file).
`Note`: This PVC mounting will impact only the particular build pipeline. +5. Once you’ve mapped the environments, click `Save` to confirm and apply the upstream dependencies. -To know the `pipelinename` detail, go to the `App Configuration`, click `Workflow Editor` the pipeline name will be on the `Build` pipeline as shown below. +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-5.jpg) - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-name-pvc-1.jpg) +6. After saving: +* The selected applications will appear under `Dependent Applications` above your current application as Upstream Dependencies. +* Your current application will be shown in bold, displaying its mapped environment and latest deployment details. + * You can switch the environment of your current application using the dropdown next to its name under `Environment`. This allows you to view the upstream and downstream dependencies specific to that environment. The table will refresh to show deployment details for the selected environment. +* Any applications that have added your app as an upstream will automatically be listed below your app as Downstream Dependencies. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-level-tag.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-6.jpg) -* Click `Save`. +### Downstream Dependencies +Downstream dependencies are Devtron applications that rely on current application. These are automatically listed when your app is added as an upstream in another application’s configuration. +You don’t need to configure anything manually for downstream entries — they are system-generated based on how other apps define their upstreams. +For every downstream application listed, a `Map Environment` link appears beside its name. +* Clicking this link redirects you to that application’s Dependencies section, where your app will appear in the upstream list. - +* From there, you can assign or update the environment mapping for your app in the context of that downstream application. \ No newline at end of file From c5ddad64f2377a051caaf40fb2bc67612c1dd413 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 1 Apr 2025 18:01:33 +0530 Subject: [PATCH 02/10] added image ations --- .../creating-application/overview.md | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/user-guide/creating-application/overview.md b/docs/user-guide/creating-application/overview.md index 11c8a373d..78af7f19f 100644 --- a/docs/user-guide/creating-application/overview.md +++ b/docs/user-guide/creating-application/overview.md @@ -7,7 +7,7 @@ The `Overview` page contains three main sections: * [`Environments`](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. * [`Dependencies`](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it — helping visualize inter-app relationships. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg) +![Figure 1: Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg) ## About @@ -20,7 +20,7 @@ The `About` section allows you to: The left side of the `About` section displays essential information about the application. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/left-about.jpg) +![Figure 2a: About Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/left-about.jpg) The table below captures all the key elements presented in this section, along with their descriptions and whether they can be edited by the user. @@ -38,7 +38,7 @@ The left side of the `About` section displays essential information about the ap ### Readme The right side of the `About` section contains a `README` area where you can maintain application-specific notes or documentation. The `Readme` supports Markdown formatting, making it easy to include formatted text, instructions, or important context related to the application. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme-edit.jpg) +![Figure 2b: Readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme-edit.jpg) To add or update the `README`: 1. Click the `Edit` button in the Readme section. @@ -65,7 +65,7 @@ These windows are defined by `Super-Admins` to control when deployments and rela You can expand each environment row to view detailed information like window name, duration, and frequency. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg) +![Figure 2c: Deployement Window](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg) {% hint style=“info” %} This section is view-only and does not require any configuration at the application level. @@ -77,7 +77,7 @@ This section is view-only and does not require any configuration at the applicat The `Catalog` in the `About` section displays information about your application—such as documentation references, ownership details, and technical specifications. This data is managed using [Devtron’s Catalog Framework](../global-configurations/catalog-framework.md). -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg) +![Figure 2d: Catalog](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg) `Super-Admins` define a custom JSON schema that determines what fields are shown in the catalog form. This schema is specific to each resource type, such as Devtron applications. @@ -86,7 +86,7 @@ When you click the `Edit` icon, a form appears based on the defined schema. As a * Code owners and on-call responsibilities * Service attributes (e.g., internet-facing flag, communication method, framework, language) -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-expanded.jpg) +![Figure 2e: Catalog Form ](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-expanded.jpg) {% hint style= "info" %} The structure and labels in the catalog form are entirely configurable by your platform team via JSON schema in `Catalog Framework`. Field names and sections may vary depending on how the schema was defined by your organization. @@ -94,7 +94,7 @@ The structure and labels in the catalog form are entirely configurable by your p Once saved, this information is displayed in a readable format within the Catalog subsection and is accessible to all users who have permission to view the application. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-final.jpg) +![Figure 2e: Catalog final view ](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-final.jpg) ### Configure PersistentVolumeClaim (PVC) @@ -161,7 +161,7 @@ Follow the steps below to apply the PVC to all or specific pipelines 1. Navigate to your application’s `Overview` → `About` section. 2. Click the `Edit` icon next to the Tags section. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pvc-edit-tags-1.jpg) +![Figure 3a: Click on the Edit Icon](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pvc-edit-tags-1.jpg) 3. Add one of the following key-value tags depending on how you want the PVC to be applied * To mount the PVC across all pipelines in the application @@ -170,7 +170,7 @@ Follow the steps below to apply the PVC to all or specific pipelines |:--- |:--- | |devtron.ai/ci-pvc-all | cache-pvc | -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-pvc-1.jpg) +![Figure 3b: Mount PVC across all pipelines](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-pvc-1.jpg) * To mount the PVC for a specific pipeline only in the application @@ -178,9 +178,9 @@ Follow the steps below to apply the PVC to all or specific pipelines |:--- |:--- | |devtron.ai/ci-pvc-| cache-pvc | -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-name-pvc-1.jpg) +![Figure 3c: Find Pipeline name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-name-pvc-1.jpg) -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-level-tag.jpg) +![Figure 3d: Mount PVC to a specific pipeline](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-level-tag.jpg) > Replace with the exact name of the CI pipeline (visible in the Workflow Editor). @@ -200,7 +200,7 @@ The Environments section provides a detailed view of all environments where the | Comit|Displays the Git commit hash associated with the last deployment.| | Deployed AT|Indicates who deployed the application and when, it is shown as the email ID of the user along with a relative timestamp (e.g.,9 days ago).| -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg) +![Figure 4: Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg) ## Dependencies [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) @@ -216,24 +216,24 @@ Upstream dependencies are other Devtron applications that your current applicati To add upstream dependencies: 1. Click the `Add Dependency` button in the `Dependencies` section. If dependencies already exist, click the `Edit Dependency` button on the right instead. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies.jpg) +![Figure 5a: Dependencies Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies.jpg) 2. In the right-side panel, under `UPSTREAM DEPENDENCY`, click `+ Add Dependency`. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg) +![Figure 5b:Add Dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg) 3. Use the search bar to find and select one or more applications that your app depends on. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-3.jpg) +![Figure 5c: Select dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-3.jpg) 4. Click `Map Environments` to associate each selected application with a specific environment. * This helps Devtron understand where your dependencies are running. By mapping environments, you can view the correct deployment details (like image, commit, and status) for each dependency. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-4.jpg) +![Figure 5d: Map Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-4.jpg) 5. Once you’ve mapped the environments, click `Save` to confirm and apply the upstream dependencies. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-5.jpg) +![Figure 5e: Select environments for each dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-5.jpg) 6. After saving: * The selected applications will appear under `Dependent Applications` above your current application as Upstream Dependencies. @@ -241,7 +241,7 @@ To add upstream dependencies: * You can switch the environment of your current application using the dropdown next to its name under `Environment`. This allows you to view the upstream and downstream dependencies specific to that environment. The table will refresh to show deployment details for the selected environment. * Any applications that have added your app as an upstream will automatically be listed below your app as Downstream Dependencies. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-6.jpg) +![Figure 5f: Dependencies List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-6.jpg) ### Downstream Dependencies From afee0777056cfc6c80c4ce0710d1d7874a6ba46d Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Wed, 2 Apr 2025 18:50:19 +0530 Subject: [PATCH 03/10] fixed formatting --- .../creating-application/overview.md | 108 +++++++++--------- 1 file changed, 54 insertions(+), 54 deletions(-) diff --git a/docs/user-guide/creating-application/overview.md b/docs/user-guide/creating-application/overview.md index 78af7f19f..39c6a45a0 100644 --- a/docs/user-guide/creating-application/overview.md +++ b/docs/user-guide/creating-application/overview.md @@ -2,23 +2,23 @@ The Overview page provides a centralized view of an application’s details within Devtron. It allows users to quickly access information about the application, manage tags, view deployment environments, and understand inter-app dependencies — all in a single, organized interface. -The `Overview` page contains three main sections: -* [`About`](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and configure PVCs. -* [`Environments`](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. -* [`Dependencies`](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it — helping visualize inter-app relationships. +The **Overview** page contains three main sections: +* [**About**](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and configure PVCs. +* [**Environments**](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. +* [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it — helping visualize inter-app relationships. ![Figure 1: Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg) ## About -The `About` section allows you to: +The **About** section allows you to: * View key application details * Change the project your application is assigned to * Manage tags that you may have added during the application’s creation * Configure Persistent Volume Claims (PVCs) -The left side of the `About` section displays essential information about the application. +The left side of the **About** section displays essential information about the application. ![Figure 2a: About Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/left-about.jpg) @@ -26,26 +26,26 @@ The left side of the `About` section displays essential information about the ap | Field Name | User Editable |Description| | :--------- | :--------------- |:--------- | -| `Application Name` | No |Displays the name of the application (e.g., backend-healthcare-app).| -| `Short Description`|Yes|A short, optional description to summarize the application's purpose.| -| `Project` |Yes|Indicates the current project under which the application is organized.
You can change the project directly from this section.
  1. Click the `Edit` icon next to the current project.
  2. In the `Change Project` window, select the new project from the dropdown.
  3. Click `Save`.
Changing the project will revoke access for existing users and grant access only to those who have permissions in the newly selected project.| -| `Created on` |No|Shows the exact date and time when the application was created.| -| `Created by`|No|Displays the email address of the user who created the application.| -| `Code Source` |No|Shows the connected Git repository or template used for the application.| -| `Part of release track` |No|Lists all release track names linked to the app.
  • Clicking a release opens its detailed view in the Software Distribution Hub.
  • This is an enterprise-only feature available as part of Devtron's SDH offering.
| -| `Tags` |Yes|Key-value pairs used for identifying and organizing the application.
Users can propagate tags as Kubernetes labels to enable filtering, bulk operations, and integrations with Kubernetes tools.
  1. Click the `Edit` icon next to `Tags`.
  2. On the `Manage Tags` page, Click `+ Add tag` to add a new tag.
  3. You can click `X` icon to delete an existing tag.
  4. You can click the `propagation icon` to propagate a tag (turns dark grey when propagated), click again to remove propagation.
    [[Snapshot](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-latest-1.jpg)]
  5. Click `Save`, Configured Tags will reflect immediately under `Tags` in `About` Section
  • Tags can also be used to [configure PersistentVolumeClaims (PVCs)](#configure-persistentvolumeclaim-pvc) for build time optimization.
| +| **Application Name** | No |Displays the name of the application (e.g., backend-healthcare-app).| +| **Short Description**|Yes|A short, optional description to summarize the application's purpose.| +| **Project** |Yes|Indicates the current project under which the application is organized.
You can change the project directly from this section.
  1. Click the **Edit** icon next to the current project.
  2. In the **Change Project** window, select the new project from the dropdown.
  3. Click **Save**.
Changing the project will revoke access for existing users and grant access only to those who have permissions in the newly selected project.| +| **Created on** |No|Shows the exact date and time when the application was created.| +| **Created by**|No|Displays the email address of the user who created the application.| +| **Code Source** |No|Shows the connected Git repository or template used for the application.| +| **Part of release track** |No|Lists all release track names linked to the app.
  • Clicking a release opens its detailed view in the Software Distribution Hub.
  • This is an enterprise-only feature available as part of Devtron's SDH offering.
| +| **Tags** |Yes|Key-value pairs used for identifying and organizing the application.
Users can propagate tags as Kubernetes labels to enable filtering, bulk operations, and integrations with Kubernetes tools.
  1. Click the **Edit** icon next to **Tags**.
  2. On the **Manage Tags** page, Click **+ Add tag** to add a new tag.
  3. You can click **X** icon to delete an existing tag.
  4. You can click the **propagation icon** to propagate a tag (turns dark grey when propagated), click again to remove propagation.
    [[Snapshot](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-latest-1.jpg)]
  5. Click `Save`, Configured Tags will reflect immediately under **Tags** in **About** Section
  • Tags can also be used to [configure PersistentVolumeClaims (PVCs)](#configure-persistentvolumeclaim-pvc) for build time optimization.
| ### Readme -The right side of the `About` section contains a `README` area where you can maintain application-specific notes or documentation. The `Readme` supports Markdown formatting, making it easy to include formatted text, instructions, or important context related to the application. +The right side of the **About** section contains a **Readme** area where you can maintain application-specific notes or documentation. The **Readme** supports Markdown formatting, making it easy to include formatted text, instructions, or important context related to the application. ![Figure 2b: Readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme-edit.jpg) -To add or update the `README`: -1. Click the `Edit` button in the Readme section. -2. A Markdown editor will appear where you can write or modify content under the `Write` tab. +To add or update the **Readme**: +1. Click the **Edit** button in the Readme section. +2. A Markdown editor will appear where you can write or modify content under the **Write** tab. 3. Use standard Markdown syntax to format text, create lists, insert links, and more. -4. Preview the content using the `Preview` tab. -5. Click `Save` to update the README. +4. Preview the content using the **Preview** tab. +5. Click **Save** to update the Readme. ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme.jpg) @@ -55,13 +55,13 @@ To add or update the `README`: ### Deployment Window [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) -The `Deployment Window` in the `About` section displays all `Blackout Windows` and `Maintenance Windows` configured for your application’s environments. +The **Deployment Window** in the **About** section displays all Blackout Windows and Maintenance Windows configured for your application’s environments. -These windows are defined by `Super-Admins` to control when deployments and related actions are allowed or blocked. The goal is to minimize disruptions during critical business hours or maintenance periods. +These windows are defined by Super-Admins to control when deployments and related actions are allowed or blocked. The goal is to minimize disruptions during critical business hours or maintenance periods. -* `Blackout Window`: Periods during which deployments are strictly blocked. -* `Maintenance Window`: Periods during which deployments are allowed; outside of this window, they are blocked. -* If both are configured for the same time period, `Blackout Window` takes precedence. +* **Blackout Window**: Periods during which deployments are strictly blocked. +* **Maintenance Window**: Periods during which deployments are allowed; outside of this window, they are blocked. +* If both are configured for the same time period, **Blackout Window** takes precedence. You can expand each environment row to view detailed information like window name, duration, and frequency. @@ -75,13 +75,13 @@ This section is view-only and does not require any configuration at the applicat ### Catalog [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) -The `Catalog` in the `About` section displays information about your application—such as documentation references, ownership details, and technical specifications. This data is managed using [Devtron’s Catalog Framework](../global-configurations/catalog-framework.md). +The **Catalog** in the **About** section displays information about your application—such as documentation references, ownership details, and technical specifications. This data is managed using [Devtron’s Catalog Framework](../global-configurations/catalog-framework.md). ![Figure 2d: Catalog](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg) -`Super-Admins` define a custom JSON schema that determines what fields are shown in the catalog form. This schema is specific to each resource type, such as Devtron applications. +Super-Admins define a custom JSON schema that determines what fields are shown in the catalog form. This schema is specific to each resource type, such as Devtron applications. -When you click the `Edit` icon, a form appears based on the defined schema. As an application owner or client, you can fill out fields like: +When you click the **Edit** icon, a form appears based on the defined schema. As an application owner or client, you can fill out fields like: * Documentation (e.g., API contract, service documentation) * Code owners and on-call responsibilities * Service attributes (e.g., internet-facing flag, communication method, framework, language) @@ -89,7 +89,7 @@ When you click the `Edit` icon, a form appears based on the defined schema. As a ![Figure 2e: Catalog Form ](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-expanded.jpg) {% hint style= "info" %} -The structure and labels in the catalog form are entirely configurable by your platform team via JSON schema in `Catalog Framework`. Field names and sections may vary depending on how the schema was defined by your organization. +The structure and labels in the catalog form are entirely configurable by your platform team via JSON schema in **Catalog Framework**. Field names and sections may vary depending on how the schema was defined by your organization. {% endhint %} Once saved, this information is displayed in a readable format within the Catalog subsection and is accessible to all users who have permission to view the application. @@ -106,7 +106,7 @@ Mounting a PVC into the build Pod gives it access to a dedicated storage volume #### Configure PVC in Your Application -**1.** **Create a PVC** +##### Create a PVC Before you can configure an Application to use a PVC, you need to make sure the PVC is created in the Kubernetes cluster. @@ -128,7 +128,7 @@ spec: ``` You can apply this configuration using either of the following methods: -##### Apply using kubectl +**Apply using kubectl** 1. Save the above YAML in a file named `cache-pvc.yaml`. 2. Run the following command: @@ -141,25 +141,25 @@ kubectl get pvc -n devtron-ci ``` 4. You should see its status as `Bound`, indicating that it’s successfully created and ready to be used by your CI pipelines. -##### Apply using Devtron’s Resource Browser +**Apply using Devtron’s Resource Browser** -1. Navigate to `Resource Browser` in the Devtron sidebar. +1. Navigate to [Resource Browser](../resource-browser.md) in the Devtron sidebar. 2. Select the Cluster where your CI pipelines run. -3. Click `Create Resource`. -4. Paste the YAML into the editor and click `Create`. -5. The PVC will now be created and will appear under `Resource Browser` → `Config & Storage` → `PersistentVolumeClaim` with the status shown as `Bound` +3. Click **Create Resource**. +4. Paste the YAML into the editor and click **Create**. +5. The PVC will now be created and will appear under **Resource Browser** → **Config & Storage** → **PersistentVolumeClaim** with the status shown as `Bound` **2.** **Apply PVC to CI Pipelines Using Tags** -Once PVC is created and in the Bound state, the next step is to configure it within your application using tags from the `About` section. +Once PVC is created and in the Bound state, the next step is to configure it within your application using tags from the **About** section. Devtron allows you to define special tags as key-value pairs. These tags act as instructions for Devtron to mount the specified PVC to the Pod where the CI pipeline runs, making the storage available during pipeline execution. You can choose to mount the PVC for all pipelines in the application or for a specific pipeline, depending on your use case. The configuration remains the same in both cases — the only difference lies in the tag key used to define the scope of the PVC. Follow the steps below to apply the PVC to all or specific pipelines -1. Navigate to your application’s `Overview` → `About` section. -2. Click the `Edit` icon next to the Tags section. +1. Navigate to your application’s **Overview** → **About** section. +2. Click the **Edit** icon next to the Tags section. ![Figure 3a: Click on the Edit Icon](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pvc-edit-tags-1.jpg) @@ -184,7 +184,7 @@ Follow the steps below to apply the PVC to all or specific pipelines > Replace with the exact name of the CI pipeline (visible in the Workflow Editor). -4. Click `Save` to apply the tag. +4. Click **Save** to apply the tag. After saving, Devtron will automatically mount the PVC into your CI pipeline Pod, allowing it to use the configured persistent storage for caching purposes. No further manual configuration is required. @@ -194,11 +194,11 @@ The Environments section provides a detailed view of all environments where the | Field Name |Description| | :--------- |:--------- | -| Application Status |The current application status in that particular environment.| -| Environment | Displays the name of the Environment.| -| Last Deployed|Shows the image tag or artifact version from the latest deployment. If the application has not been deployed yet, this shows Not Deployed.| -| Comit|Displays the Git commit hash associated with the last deployment.| -| Deployed AT|Indicates who deployed the application and when, it is shown as the email ID of the user along with a relative timestamp (e.g.,9 days ago).| +| **Application Status** |The current application status in that particular environment.| +| **Environment** | Displays the name of the Environment.| +| **Last Deployed**|Shows the image tag or artifact version from the latest deployment. If the application has not been deployed yet, this shows Not Deployed.| +| **Comit**|Displays the Git commit hash associated with the last deployment.| +| **Deployed AT**|Indicates who deployed the application and when, it is shown as the email ID of the user along with a relative timestamp (e.g.,9 days ago).| ![Figure 4: Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg) @@ -206,19 +206,19 @@ The Environments section provides a detailed view of all environments where the The Dependencies section displays the relationship of the current application with other Devtron-managed applications in the form of upstream and downstream dependencies. -* `Upstream dependencies` are other applications that the current application depends on. -* `Downstream dependencies` are applications that rely on the current application. +* Upstream dependencies are other applications that the current application depends on. +* Downstream dependencies are applications that rely on the current application. ### Upstream Dependencies Upstream dependencies are other Devtron applications that your current application depends on. You can manually define upstream dependencies to indicate that your application depends on certain devtron applications. To add upstream dependencies: -1. Click the `Add Dependency` button in the `Dependencies` section. If dependencies already exist, click the `Edit Dependency` button on the right instead. +1. Click the **Add Dependency** button in the **Dependencies** section. If dependencies already exist, click the **Edit Dependency** button on the right instead. ![Figure 5a: Dependencies Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies.jpg) -2. In the right-side panel, under `UPSTREAM DEPENDENCY`, click `+ Add Dependency`. +2. In the right-side panel, under Upstream Dependency, click **+ Add Dependency**. ![Figure 5b:Add Dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg) @@ -226,19 +226,19 @@ To add upstream dependencies: ![Figure 5c: Select dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-3.jpg) -4. Click `Map Environments` to associate each selected application with a specific environment. +4. Click **Map Environments** to associate each selected application with a specific environment. * This helps Devtron understand where your dependencies are running. By mapping environments, you can view the correct deployment details (like image, commit, and status) for each dependency. ![Figure 5d: Map Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-4.jpg) -5. Once you’ve mapped the environments, click `Save` to confirm and apply the upstream dependencies. +5. Once you’ve mapped the environments, click **Save** to confirm and apply the upstream dependencies. ![Figure 5e: Select environments for each dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-5.jpg) 6. After saving: -* The selected applications will appear under `Dependent Applications` above your current application as Upstream Dependencies. +* The selected applications will appear under **Dependent Applications** above your current application as Upstream Dependencies. * Your current application will be shown in bold, displaying its mapped environment and latest deployment details. - * You can switch the environment of your current application using the dropdown next to its name under `Environment`. This allows you to view the upstream and downstream dependencies specific to that environment. The table will refresh to show deployment details for the selected environment. + * You can switch the environment of your current application using the dropdown next to its name under **Environment**. This allows you to view the upstream and downstream dependencies specific to that environment. The table will refresh to show deployment details for the selected environment. * Any applications that have added your app as an upstream will automatically be listed below your app as Downstream Dependencies. ![Figure 5f: Dependencies List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-6.jpg) @@ -249,7 +249,7 @@ Downstream dependencies are Devtron applications that rely on current applicatio You don’t need to configure anything manually for downstream entries — they are system-generated based on how other apps define their upstreams. -For every downstream application listed, a `Map Environment` link appears beside its name. +For every downstream application listed, a **Map Environment** link appears beside its name. * Clicking this link redirects you to that application’s Dependencies section, where your app will appear in the upstream list. From 4ae7832b08b18e3ea20206db412ff919989a5f78 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 4 Apr 2025 17:35:38 +0530 Subject: [PATCH 04/10] changed the name from overview to Application Overview --- docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 20d798f4d..f5cb063cf 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -100,7 +100,7 @@ * [Debugging Deployment And Monitoring](user-guide/debugging-deployment-and-monitoring.md) * [Using Ephemeral Containers](user-guide/app-details/ephemeral-containers.md) * [Application Metrics](user-guide/creating-application/app-metrics.md) - * [Overview](user-guide/creating-application/overview.md) + * [Application Overview](user-guide/creating-application/overview.md) * [Jobs](user-guide/jobs/README.md) * [Create a new job](user-guide/jobs/create-job.md) * [Configurations](user-guide/jobs/configuration-job.md) From 625fb4487fdddc27fc1dab3cc749f5b247c137df Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Sat, 12 Apr 2025 01:15:59 +0530 Subject: [PATCH 05/10] docs: implemented the requested changes --- .../creating-application/overview.md | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/docs/user-guide/creating-application/overview.md b/docs/user-guide/creating-application/overview.md index 39c6a45a0..2f6f9a370 100644 --- a/docs/user-guide/creating-application/overview.md +++ b/docs/user-guide/creating-application/overview.md @@ -5,7 +5,7 @@ The Overview page provides a centralized view of an application’s details with The **Overview** page contains three main sections: * [**About**](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and configure PVCs. * [**Environments**](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. -* [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it — helping visualize inter-app relationships. +* [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it thus helping visualize microservices dependency. ![Figure 1: Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg) @@ -126,20 +126,7 @@ spec: requests: storage: 30Gi ``` -You can apply this configuration using either of the following methods: - -**Apply using kubectl** - -1. Save the above YAML in a file named `cache-pvc.yaml`. -2. Run the following command: -``` -kubectl apply -f cache-pvc.yaml -``` -3. The PVC will now be created and visible using: -``` -kubectl get pvc -n devtron-ci -``` -4. You should see its status as `Bound`, indicating that it’s successfully created and ready to be used by your CI pipelines. +You can apply this configuration using Devtron’s **Resource Browser** **Apply using Devtron’s Resource Browser** @@ -197,7 +184,7 @@ The Environments section provides a detailed view of all environments where the | **Application Status** |The current application status in that particular environment.| | **Environment** | Displays the name of the Environment.| | **Last Deployed**|Shows the image tag or artifact version from the latest deployment. If the application has not been deployed yet, this shows Not Deployed.| -| **Comit**|Displays the Git commit hash associated with the last deployment.| +| **Commit**|Displays the Git commit hash associated with the last deployment.| | **Deployed AT**|Indicates who deployed the application and when, it is shown as the email ID of the user along with a relative timestamp (e.g.,9 days ago).| ![Figure 4: Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg) From 433a33fd781d32e6178bef3f59cf33832e62ed26 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Mon, 28 Apr 2025 01:10:30 +0530 Subject: [PATCH 06/10] docs: changes implemented --- docs/user-guide/creating-application/overview.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/creating-application/overview.md b/docs/user-guide/creating-application/overview.md index 2f6f9a370..7143a9374 100644 --- a/docs/user-guide/creating-application/overview.md +++ b/docs/user-guide/creating-application/overview.md @@ -3,7 +3,7 @@ The Overview page provides a centralized view of an application’s details within Devtron. It allows users to quickly access information about the application, manage tags, view deployment environments, and understand inter-app dependencies — all in a single, organized interface. The **Overview** page contains three main sections: -* [**About**](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and configure PVCs. +* [**About**](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and [Configure PVCs](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims). * [**Environments**](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. * [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it thus helping visualize microservices dependency. @@ -16,7 +16,7 @@ The **About** section allows you to: * View key application details * Change the project your application is assigned to * Manage tags that you may have added during the application’s creation -* Configure Persistent Volume Claims (PVCs) +* [Configure Persistent Volume Claims (PVCs)](#configure-persistentvolumeclaim-pvc) The left side of the **About** section displays essential information about the application. @@ -47,7 +47,7 @@ To add or update the **Readme**: 4. Preview the content using the **Preview** tab. 5. Click **Save** to update the Readme. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme.jpg) +![Figure 2c: Edit readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme.jpg) {% hint style="info" %} After saving, the system displays the email address of the user who last updated the README, along with the date and time. This information appears in the header of the Readme section, beside the title. @@ -57,7 +57,7 @@ To add or update the **Readme**: The **Deployment Window** in the **About** section displays all Blackout Windows and Maintenance Windows configured for your application’s environments. -These windows are defined by Super-Admins to control when deployments and related actions are allowed or blocked. The goal is to minimize disruptions during critical business hours or maintenance periods. +These windows are defined by Super-Admins to control when deployments and related actions are allowed or blocked. The goal is to minimize disruptions during critical business hours. * **Blackout Window**: Periods during which deployments are strictly blocked. * **Maintenance Window**: Periods during which deployments are allowed; outside of this window, they are blocked. @@ -65,7 +65,7 @@ These windows are defined by Super-Admins to control when deployments and relate You can expand each environment row to view detailed information like window name, duration, and frequency. -![Figure 2c: Deployement Window](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg) +![Figure 2c: Deployment Window](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg) {% hint style=“info” %} This section is view-only and does not require any configuration at the application level. @@ -79,9 +79,12 @@ The **Catalog** in the **About** section displays information about your applica ![Figure 2d: Catalog](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg) +You can use the **Catalog framework** to maintain information about your application such as Documentation (e.g., API contract, service documentation), ownership details, technical attributes etc. This makes it easier for others to understand, manage and use your application. + Super-Admins define a custom JSON schema that determines what fields are shown in the catalog form. This schema is specific to each resource type, such as Devtron applications. When you click the **Edit** icon, a form appears based on the defined schema. As an application owner or client, you can fill out fields like: + * Documentation (e.g., API contract, service documentation) * Code owners and on-call responsibilities * Service attributes (e.g., internet-facing flag, communication method, framework, language) @@ -100,7 +103,7 @@ Once saved, this information is displayed in a readable format within the Catalo A [PersistentVolumeClaim (PVC)](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) is a request for storage, which is used to mount a PersistentVolume (PV) into a Pod that can be used by your application’s CI pipeline. -In Devtron, you can use a PersistentVolumeClaim (PVC) to provide persistent storage to the Pod that runs your CI pipeline, enabling the pod to store and reuse cached data such as dependencies. This is particularly beneficial when building for multiple target platforms like amd64 and arm64, where caching can significantly reduce build time. +In Devtron, you can use a [PersistentVolumeClaim (PVC)](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) to provide persistent storage to the Pod that runs your CI pipeline, enabling the pod to store and reuse cached data such as dependencies. Mounting a PVC into the build Pod gives it access to a dedicated storage volume for caching, without interfering with the normal build process, which continues to run based on the architecture and operating system of the Kubernetes node where the CI pipeline is executed. From 345ad75d094517c32590d5642a64857c16a2112f Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 29 Apr 2025 15:03:36 +0530 Subject: [PATCH 07/10] docs:fixes links --- .../creating-application/overview.md | 2 +- .../workflow/ci-pipeline-new.md | 110 ++++++++++++++++++ docs/user-guide/jobs/getting-started-job.md | 21 ++++ 3 files changed, 132 insertions(+), 1 deletion(-) create mode 100644 docs/user-guide/creating-application/workflow/ci-pipeline-new.md create mode 100644 docs/user-guide/jobs/getting-started-job.md diff --git a/docs/user-guide/creating-application/overview.md b/docs/user-guide/creating-application/overview.md index 7143a9374..70dff5ab2 100644 --- a/docs/user-guide/creating-application/overview.md +++ b/docs/user-guide/creating-application/overview.md @@ -3,7 +3,7 @@ The Overview page provides a centralized view of an application’s details within Devtron. It allows users to quickly access information about the application, manage tags, view deployment environments, and understand inter-app dependencies — all in a single, organized interface. The **Overview** page contains three main sections: -* [**About**](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and [Configure PVCs](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims). +* [**About**](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and [Configure PVCs](#configure-persistentvolumeclaim-pvc). * [**Environments**](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. * [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it thus helping visualize microservices dependency. diff --git a/docs/user-guide/creating-application/workflow/ci-pipeline-new.md b/docs/user-guide/creating-application/workflow/ci-pipeline-new.md new file mode 100644 index 000000000..a167b1aa7 --- /dev/null +++ b/docs/user-guide/creating-application/workflow/ci-pipeline-new.md @@ -0,0 +1,110 @@ +# CI Pipeline + +{% hint style="info" %} +For Devtron version older than v0.4.0, please refer the [CI Pipeline (legacy)](https://docs.devtron.ai/v/v0.4/devtron/user-guide/creating-application/workflow/ci-pipeline-legacy) page. +{% endhint %} + +## Introduction + +In Devtron, the Build and Deploy from Source Code method allows users to build container images directly from a Git repository and deploy them in a Kubernetes environment. + +## When to Use This Method? + +* When you need to build a container image from your application's source code. +* When you want automated builds triggered by code changes. +* When you require pre-build and post-build customization steps. + +{% hint style="info" %} +hint about docker image +{% endhint %} + +## Step-by-Step Guide to Creating a CI Pipeline + +1. Navigate to Workflow Editor +2. From the Applications menu, select your application. +3. Go to the App Configuration page and select Workflow Editor. +4. Click + New Workflow. +5. Select Build and Deploy from Source Code. + +### Configure Build Pipeline +1. In the Create Build Pipeline window, enter the following details: + +| Field Name | Required/Optional | Description | +| :--- | :--- | :--- | +| Pipeline Name | Required | A unique name for the build pipeline. | +| Source type | Required | Source type to trigger the CI. Available options: [Branch Fixed](#source-type-branch-fixed) \| [Branch Regex](#source-type-branch-regex) \|[Pull Request](#source-type-pull-request) \| [Tag Creation](#source-type-tag-creation) | +| Branch Name | Required | Branch that triggers the CI build | +| Advanced Options | Optional | Create Pre-Build, Build, and Post-Build tasks | + +#### Understanding Source Types + +Devtron provides multiple ways to trigger a build pipeline: + +| Source Type | Description | Additional Requirements | +| :--- | :--- | :--- | +| Branch Fixed | Triggers a CI build whenever changes are pushed to a specified branch. | Requires a predefined branch name.| +| Branch Regex | Allows dynamic branch selection based on a regex pattern, useful for branches following a common naming convention (e.g., feature-*). | Requires a regex pattern to be defined.| +| Pull Request (PR) | Triggers a CI build when a new pull request is created.| Requires webhook configuration for GitHub or Bitbucket.| +| Tag Creation | Triggers a build whenever a new tag is created. | Requires webhook configuration for GitHub or Bitbucket.| + +2. Click Create Pipeline to save the configuration and proceed. You can now use the default settings, or continue below to explore additional configuration options for customizing your pipeline. + +### Configuring Advanced Options + +Devtron provides three stages in a CI pipeline: Pre-Build, Build, and Post-Build. + +1. Pre-Build Stage: This stage is used for preparing the environment before the actual build begins. Tasks such as dependency installation, secret management, and validation can be configured here. + +2. Build Stage: The core stage where the application source code is compiled, a container image is built, and the necessary artifacts are generated. + +3. Post-Build Stage: This stage runs after the build is complete, where additional tasks such as security scans, notifications, or artifact uploads can be executed. + +This guide focuses on configuring the Build Stage. If you want to set up Pre-Build and Post-Build stages, refer to the separate documentation + +* Pre-Build Stage Configuration +* Post-Build Stage Configuration + +#### Scan for Vulnerabilities + +Devtron supports security scanning after the build stage. + +##### Prerequisite + +Ensure you have installed one of the following integrations: +* Clair +* Trivy + +##### How to Enable Security Scan? + +* In the Build Stage tab, enable Scan for vulnerabilities. +* This will scan the built container image for known vulnerabilities. + +#### Custom Image Tag Pattern + +You can define custom image tags for better version tracking. + +* Enable the Custom Image Tag Pattern toggle. +* Define an alphanumeric pattern (e.g., test-v1.0.{x} where x auto-increments with each build). +* Click Update Pipeline. + +{% hint style="info" %} +Ensure custom tags do not start or end with a period (.) or comma (,). +{% endhint %} + +#### Triggering a Build + +Once the CI pipeline is set up, follow these steps to trigger a build: + +* Navigate to Build & Deploy. + +* Click Select Material. + +* Choose the Git commit to build. + +* Click Start Build. + +Once successful, the image tag will be available in: + +* Build History +* Docker Registry  +* CD Pipeline (Image Selection) \ No newline at end of file diff --git a/docs/user-guide/jobs/getting-started-job.md b/docs/user-guide/jobs/getting-started-job.md new file mode 100644 index 000000000..f90452c34 --- /dev/null +++ b/docs/user-guide/jobs/getting-started-job.md @@ -0,0 +1,21 @@ +# Getting Started With Jobs + +Devtron Jobs provide a streamlined way to execute specific tasks or set of tasks within your application environment direlty on the source code. Devtron Jobs leverage Kubernetes Jobs to run isolated, task-specific operations within your Kubernetes cluster. + +Unlike Devtron CI/CD pipelines that primarily focus on building, testing, and deploying applications, Devtron Jobs are designed to handle independent, ephemeral tasks and allows you to execute tasks without impacting Ci/CD workflows or pipelines, making them ideal for specific tasks. + +Each Devtron Job corresponds to a [Kubernetes Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) that creates one or more Pods to carry out a specified task. Once the task is completed, the Pods are terminated, making Devtron Jobs an ideal solution for one-time, recurring, or event-driven workloads. + +Jobs can be configured to run as: + +* **One-time tasks**: Useful for maintenance operations, data migrations, backups, or environment cleanups. + +* **Recurring tasks**: Scheduled operations like daily scans, periodic backups, or routine security checks. + +* **Event-driven tasks**: Triggered by specific events such as commits, pull requests, or tag creation. + + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/create-job/jobs.jpg) + +Additionally, Devtron provides integrated [plugins]() that can be utilized within Jobs to enhance automation and streamline operations. You can explore the full list of plugins and their configurations in the [Devtron Plugin Documentation]() + +To learn how to create a new Job in Devtron, continue with the next section. \ No newline at end of file From 352d8fe08dc3dd85ba5d1b0d3ce38de83f37a368 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 29 Apr 2025 15:18:56 +0530 Subject: [PATCH 08/10] docs: removed unnecessary files --- .../workflow/ci-pipeline-new.md | 110 ------------------ docs/user-guide/jobs/getting-started-job.md | 21 ---- 2 files changed, 131 deletions(-) delete mode 100644 docs/user-guide/creating-application/workflow/ci-pipeline-new.md delete mode 100644 docs/user-guide/jobs/getting-started-job.md diff --git a/docs/user-guide/creating-application/workflow/ci-pipeline-new.md b/docs/user-guide/creating-application/workflow/ci-pipeline-new.md deleted file mode 100644 index a167b1aa7..000000000 --- a/docs/user-guide/creating-application/workflow/ci-pipeline-new.md +++ /dev/null @@ -1,110 +0,0 @@ -# CI Pipeline - -{% hint style="info" %} -For Devtron version older than v0.4.0, please refer the [CI Pipeline (legacy)](https://docs.devtron.ai/v/v0.4/devtron/user-guide/creating-application/workflow/ci-pipeline-legacy) page. -{% endhint %} - -## Introduction - -In Devtron, the Build and Deploy from Source Code method allows users to build container images directly from a Git repository and deploy them in a Kubernetes environment. - -## When to Use This Method? - -* When you need to build a container image from your application's source code. -* When you want automated builds triggered by code changes. -* When you require pre-build and post-build customization steps. - -{% hint style="info" %} -hint about docker image -{% endhint %} - -## Step-by-Step Guide to Creating a CI Pipeline - -1. Navigate to Workflow Editor -2. From the Applications menu, select your application. -3. Go to the App Configuration page and select Workflow Editor. -4. Click + New Workflow. -5. Select Build and Deploy from Source Code. - -### Configure Build Pipeline -1. In the Create Build Pipeline window, enter the following details: - -| Field Name | Required/Optional | Description | -| :--- | :--- | :--- | -| Pipeline Name | Required | A unique name for the build pipeline. | -| Source type | Required | Source type to trigger the CI. Available options: [Branch Fixed](#source-type-branch-fixed) \| [Branch Regex](#source-type-branch-regex) \|[Pull Request](#source-type-pull-request) \| [Tag Creation](#source-type-tag-creation) | -| Branch Name | Required | Branch that triggers the CI build | -| Advanced Options | Optional | Create Pre-Build, Build, and Post-Build tasks | - -#### Understanding Source Types - -Devtron provides multiple ways to trigger a build pipeline: - -| Source Type | Description | Additional Requirements | -| :--- | :--- | :--- | -| Branch Fixed | Triggers a CI build whenever changes are pushed to a specified branch. | Requires a predefined branch name.| -| Branch Regex | Allows dynamic branch selection based on a regex pattern, useful for branches following a common naming convention (e.g., feature-*). | Requires a regex pattern to be defined.| -| Pull Request (PR) | Triggers a CI build when a new pull request is created.| Requires webhook configuration for GitHub or Bitbucket.| -| Tag Creation | Triggers a build whenever a new tag is created. | Requires webhook configuration for GitHub or Bitbucket.| - -2. Click Create Pipeline to save the configuration and proceed. You can now use the default settings, or continue below to explore additional configuration options for customizing your pipeline. - -### Configuring Advanced Options - -Devtron provides three stages in a CI pipeline: Pre-Build, Build, and Post-Build. - -1. Pre-Build Stage: This stage is used for preparing the environment before the actual build begins. Tasks such as dependency installation, secret management, and validation can be configured here. - -2. Build Stage: The core stage where the application source code is compiled, a container image is built, and the necessary artifacts are generated. - -3. Post-Build Stage: This stage runs after the build is complete, where additional tasks such as security scans, notifications, or artifact uploads can be executed. - -This guide focuses on configuring the Build Stage. If you want to set up Pre-Build and Post-Build stages, refer to the separate documentation - -* Pre-Build Stage Configuration -* Post-Build Stage Configuration - -#### Scan for Vulnerabilities - -Devtron supports security scanning after the build stage. - -##### Prerequisite - -Ensure you have installed one of the following integrations: -* Clair -* Trivy - -##### How to Enable Security Scan? - -* In the Build Stage tab, enable Scan for vulnerabilities. -* This will scan the built container image for known vulnerabilities. - -#### Custom Image Tag Pattern - -You can define custom image tags for better version tracking. - -* Enable the Custom Image Tag Pattern toggle. -* Define an alphanumeric pattern (e.g., test-v1.0.{x} where x auto-increments with each build). -* Click Update Pipeline. - -{% hint style="info" %} -Ensure custom tags do not start or end with a period (.) or comma (,). -{% endhint %} - -#### Triggering a Build - -Once the CI pipeline is set up, follow these steps to trigger a build: - -* Navigate to Build & Deploy. - -* Click Select Material. - -* Choose the Git commit to build. - -* Click Start Build. - -Once successful, the image tag will be available in: - -* Build History -* Docker Registry  -* CD Pipeline (Image Selection) \ No newline at end of file diff --git a/docs/user-guide/jobs/getting-started-job.md b/docs/user-guide/jobs/getting-started-job.md deleted file mode 100644 index f90452c34..000000000 --- a/docs/user-guide/jobs/getting-started-job.md +++ /dev/null @@ -1,21 +0,0 @@ -# Getting Started With Jobs - -Devtron Jobs provide a streamlined way to execute specific tasks or set of tasks within your application environment direlty on the source code. Devtron Jobs leverage Kubernetes Jobs to run isolated, task-specific operations within your Kubernetes cluster. - -Unlike Devtron CI/CD pipelines that primarily focus on building, testing, and deploying applications, Devtron Jobs are designed to handle independent, ephemeral tasks and allows you to execute tasks without impacting Ci/CD workflows or pipelines, making them ideal for specific tasks. - -Each Devtron Job corresponds to a [Kubernetes Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) that creates one or more Pods to carry out a specified task. Once the task is completed, the Pods are terminated, making Devtron Jobs an ideal solution for one-time, recurring, or event-driven workloads. - -Jobs can be configured to run as: - -* **One-time tasks**: Useful for maintenance operations, data migrations, backups, or environment cleanups. - -* **Recurring tasks**: Scheduled operations like daily scans, periodic backups, or routine security checks. - -* **Event-driven tasks**: Triggered by specific events such as commits, pull requests, or tag creation. - - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/create-job/jobs.jpg) - -Additionally, Devtron provides integrated [plugins]() that can be utilized within Jobs to enhance automation and streamline operations. You can explore the full list of plugins and their configurations in the [Devtron Plugin Documentation]() - -To learn how to create a new Job in Devtron, continue with the next section. \ No newline at end of file From 54867a876e3a1c209250112c46d00c30880547dd Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 1 May 2025 15:17:37 +0530 Subject: [PATCH 09/10] docs: minor fixes --- .../creating-application/overview.md | 57 ++++++++++--------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/docs/user-guide/creating-application/overview.md b/docs/user-guide/creating-application/overview.md index 70dff5ab2..e6c377e24 100644 --- a/docs/user-guide/creating-application/overview.md +++ b/docs/user-guide/creating-application/overview.md @@ -7,7 +7,7 @@ The **Overview** page contains three main sections: * [**Environments**](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. * [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it thus helping visualize microservices dependency. -![Figure 1: Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg) +![Figure 1: Overview Tab](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg) ## About @@ -20,7 +20,7 @@ The **About** section allows you to: The left side of the **About** section displays essential information about the application. -![Figure 2a: About Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/left-about.jpg) +![Figure 2: About Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/left-about.jpg) The table below captures all the key elements presented in this section, along with their descriptions and whether they can be edited by the user. @@ -33,12 +33,12 @@ The left side of the **About** section displays essential information about the | **Created by**|No|Displays the email address of the user who created the application.| | **Code Source** |No|Shows the connected Git repository or template used for the application.| | **Part of release track** |No|Lists all release track names linked to the app.
  • Clicking a release opens its detailed view in the Software Distribution Hub.
  • This is an enterprise-only feature available as part of Devtron's SDH offering.
| -| **Tags** |Yes|Key-value pairs used for identifying and organizing the application.
Users can propagate tags as Kubernetes labels to enable filtering, bulk operations, and integrations with Kubernetes tools.
  1. Click the **Edit** icon next to **Tags**.
  2. On the **Manage Tags** page, Click **+ Add tag** to add a new tag.
  3. You can click **X** icon to delete an existing tag.
  4. You can click the **propagation icon** to propagate a tag (turns dark grey when propagated), click again to remove propagation.
    [[Snapshot](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-latest-1.jpg)]
  5. Click `Save`, Configured Tags will reflect immediately under **Tags** in **About** Section
  • Tags can also be used to [configure PersistentVolumeClaims (PVCs)](#configure-persistentvolumeclaim-pvc) for build time optimization.
| +| **Tags** |Yes|Key-value pairs used for identifying and organizing the application.
Users can propagate tags as Kubernetes labels to enable filtering, bulk operations, and integrations with Kubernetes tools.
  1. Click the **Edit** icon next to **Tags**.
  2. On the **Manage Tags** page, Click **+ Add tag** to add a new tag.
  3. You can click **X** icon to delete an existing tag.
  4. You can click the **propagation icon** to propagate a tag (turns dark grey when propagated), click again to remove propagation.
    [[Snapshot](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-latest-1.jpg)]
  5. Click **Save**, Configured Tags will reflect immediately under **Tags** in **About** Section
  • Tags can also be used to [configure PersistentVolumeClaims (PVCs)](#configure-persistentvolumeclaim-pvc) for build time optimization.
| ### Readme The right side of the **About** section contains a **Readme** area where you can maintain application-specific notes or documentation. The **Readme** supports Markdown formatting, making it easy to include formatted text, instructions, or important context related to the application. -![Figure 2b: Readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme-edit.jpg) +![Figure 3: Readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme-edit.jpg) To add or update the **Readme**: 1. Click the **Edit** button in the Readme section. @@ -47,7 +47,7 @@ To add or update the **Readme**: 4. Preview the content using the **Preview** tab. 5. Click **Save** to update the Readme. -![Figure 2c: Edit readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme.jpg) +![Figure 4: Editing Readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme.jpg) {% hint style="info" %} After saving, the system displays the email address of the user who last updated the README, along with the date and time. This information appears in the header of the Readme section, beside the title. @@ -65,7 +65,7 @@ These windows are defined by Super-Admins to control when deployments and relate You can expand each environment row to view detailed information like window name, duration, and frequency. -![Figure 2c: Deployment Window](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg) +![Figure 5: Deployment Window](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg) {% hint style=“info” %} This section is view-only and does not require any configuration at the application level. @@ -77,7 +77,7 @@ This section is view-only and does not require any configuration at the applicat The **Catalog** in the **About** section displays information about your application—such as documentation references, ownership details, and technical specifications. This data is managed using [Devtron’s Catalog Framework](../global-configurations/catalog-framework.md). -![Figure 2d: Catalog](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg) +![Figure 6: Catalog](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg) You can use the **Catalog framework** to maintain information about your application such as Documentation (e.g., API contract, service documentation), ownership details, technical attributes etc. This makes it easier for others to understand, manage and use your application. @@ -89,7 +89,7 @@ When you click the **Edit** icon, a form appears based on the defined schema. As * Code owners and on-call responsibilities * Service attributes (e.g., internet-facing flag, communication method, framework, language) -![Figure 2e: Catalog Form ](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-expanded.jpg) +![Figure 7: Catalog Form](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-expanded.jpg) {% hint style= "info" %} The structure and labels in the catalog form are entirely configurable by your platform team via JSON schema in **Catalog Framework**. Field names and sections may vary depending on how the schema was defined by your organization. @@ -97,7 +97,7 @@ The structure and labels in the catalog form are entirely configurable by your p Once saved, this information is displayed in a readable format within the Catalog subsection and is accessible to all users who have permission to view the application. -![Figure 2e: Catalog final view ](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-final.jpg) +![Figure 8: Catalog Final View](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-final.jpg) ### Configure PersistentVolumeClaim (PVC) @@ -115,7 +115,8 @@ Before you can configure an Application to use a PVC, you need to make sure the The following is a sample PVC YAML configuration. You can modify it as needed based on your storage class, access mode, and resource requirements: -``` +{% code title="applyPolicy.sh" overflow="wrap" lineNumbers="true" %} +```bash apiVersion: v1 kind: PersistentVolumeClaim metadata: @@ -128,7 +129,9 @@ spec: resources: requests: storage: 30Gi -``` +``` +{% endcode %} + You can apply this configuration using Devtron’s **Resource Browser** **Apply using Devtron’s Resource Browser** @@ -139,7 +142,7 @@ You can apply this configuration using Devtron’s **Resource Browser** 4. Paste the YAML into the editor and click **Create**. 5. The PVC will now be created and will appear under **Resource Browser** → **Config & Storage** → **PersistentVolumeClaim** with the status shown as `Bound` -**2.** **Apply PVC to CI Pipelines Using Tags** +##### Apply PVC to CI Pipelines Using Tags Once PVC is created and in the Bound state, the next step is to configure it within your application using tags from the **About** section. @@ -151,7 +154,7 @@ Follow the steps below to apply the PVC to all or specific pipelines 1. Navigate to your application’s **Overview** → **About** section. 2. Click the **Edit** icon next to the Tags section. -![Figure 3a: Click on the Edit Icon](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pvc-edit-tags-1.jpg) +![Figure 9: Clicking Edit Icon](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pvc-edit-tags-1.jpg) 3. Add one of the following key-value tags depending on how you want the PVC to be applied * To mount the PVC across all pipelines in the application @@ -160,7 +163,7 @@ Follow the steps below to apply the PVC to all or specific pipelines |:--- |:--- | |devtron.ai/ci-pvc-all | cache-pvc | -![Figure 3b: Mount PVC across all pipelines](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-pvc-1.jpg) +![Figure 10: Mounting PVC across all pipelines](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-pvc-1.jpg) * To mount the PVC for a specific pipeline only in the application @@ -168,9 +171,9 @@ Follow the steps below to apply the PVC to all or specific pipelines |:--- |:--- | |devtron.ai/ci-pvc-| cache-pvc | -![Figure 3c: Find Pipeline name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-name-pvc-1.jpg) +![Figure 11a: Finding Pipeline name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-name-pvc-1.jpg) -![Figure 3d: Mount PVC to a specific pipeline](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-level-tag.jpg) +![Figure 11b: Mounting PVC to a specific pipeline](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-level-tag.jpg) > Replace with the exact name of the CI pipeline (visible in the Workflow Editor). @@ -188,9 +191,9 @@ The Environments section provides a detailed view of all environments where the | **Environment** | Displays the name of the Environment.| | **Last Deployed**|Shows the image tag or artifact version from the latest deployment. If the application has not been deployed yet, this shows Not Deployed.| | **Commit**|Displays the Git commit hash associated with the last deployment.| -| **Deployed AT**|Indicates who deployed the application and when, it is shown as the email ID of the user along with a relative timestamp (e.g.,9 days ago).| +| **Deployed At**|Indicates who deployed the application and when, it is shown as the email ID of the user along with a relative timestamp (e.g.,9 days ago).| -![Figure 4: Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg) +![Figure 12: Environments List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg) ## Dependencies [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) @@ -206,32 +209,32 @@ Upstream dependencies are other Devtron applications that your current applicati To add upstream dependencies: 1. Click the **Add Dependency** button in the **Dependencies** section. If dependencies already exist, click the **Edit Dependency** button on the right instead. -![Figure 5a: Dependencies Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies.jpg) +![Figure 13: Dependencies Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies.jpg) 2. In the right-side panel, under Upstream Dependency, click **+ Add Dependency**. -![Figure 5b:Add Dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg) +![Figure 14:Adding Dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg) 3. Use the search bar to find and select one or more applications that your app depends on. -![Figure 5c: Select dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-3.jpg) +![Figure 15: Selecting dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-3.jpg) 4. Click **Map Environments** to associate each selected application with a specific environment. * This helps Devtron understand where your dependencies are running. By mapping environments, you can view the correct deployment details (like image, commit, and status) for each dependency. -![Figure 5d: Map Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-4.jpg) +![Figure 16: Mapping Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-4.jpg) 5. Once you’ve mapped the environments, click **Save** to confirm and apply the upstream dependencies. -![Figure 5e: Select environments for each dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-5.jpg) +![Figure 17: Selecting environments for each dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-5.jpg) 6. After saving: -* The selected applications will appear under **Dependent Applications** above your current application as Upstream Dependencies. -* Your current application will be shown in bold, displaying its mapped environment and latest deployment details. + * The selected applications will appear under **Dependent Applications** above your current application as Upstream Dependencies. + * Your current application will be shown in bold, displaying its mapped environment and latest deployment details. * You can switch the environment of your current application using the dropdown next to its name under **Environment**. This allows you to view the upstream and downstream dependencies specific to that environment. The table will refresh to show deployment details for the selected environment. -* Any applications that have added your app as an upstream will automatically be listed below your app as Downstream Dependencies. + * Any applications that have added your app as an upstream will automatically be listed below your app as Downstream Dependencies. -![Figure 5f: Dependencies List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-6.jpg) +![Figure 18: Dependencies List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-6.jpg) ### Downstream Dependencies From 71076a1df8176708c4d778ad20b79ab22089dd1a Mon Sep 17 00:00:00 2001 From: Arpit Agrawal Date: Thu, 1 May 2025 15:31:16 +0530 Subject: [PATCH 10/10] docs: minor fixes v2 --- docs/user-guide/creating-application/overview.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/creating-application/overview.md b/docs/user-guide/creating-application/overview.md index e6c377e24..ed1a2f584 100644 --- a/docs/user-guide/creating-application/overview.md +++ b/docs/user-guide/creating-application/overview.md @@ -5,7 +5,7 @@ The Overview page provides a centralized view of an application’s details with The **Overview** page contains three main sections: * [**About**](#about): Contains application metadata such as name, description, project, creator, tags, and connected code source. It also includes options to manage tags and [Configure PVCs](#configure-persistentvolumeclaim-pvc). * [**Environments**](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows. -* [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it thus helping visualize microservices dependency. +* [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it, thus helping visualize microservices dependency. ![Figure 1: Overview Tab](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg) @@ -79,7 +79,7 @@ The **Catalog** in the **About** section displays information about your applica ![Figure 6: Catalog](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg) -You can use the **Catalog framework** to maintain information about your application such as Documentation (e.g., API contract, service documentation), ownership details, technical attributes etc. This makes it easier for others to understand, manage and use your application. +You can use the **Catalog framework** to maintain information about your application, such as Documentation (e.g., API contract, service documentation), ownership details, technical attributes, etc. This makes it easier for others to understand, manage, and use your application. Super-Admins define a custom JSON schema that determines what fields are shown in the catalog form. This schema is specific to each resource type, such as Devtron applications. @@ -115,7 +115,7 @@ Before you can configure an Application to use a PVC, you need to make sure the The following is a sample PVC YAML configuration. You can modify it as needed based on your storage class, access mode, and resource requirements: -{% code title="applyPolicy.sh" overflow="wrap" lineNumbers="true" %} +{% code title="pvc.yaml" overflow="wrap" lineNumbers="true" %} ```bash apiVersion: v1 kind: PersistentVolumeClaim @@ -204,7 +204,7 @@ The Dependencies section displays the relationship of the current application wi ### Upstream Dependencies -Upstream dependencies are other Devtron applications that your current application depends on. You can manually define upstream dependencies to indicate that your application depends on certain devtron applications. +Upstream dependencies are other Devtron applications that your current application depends on. You can manually define upstream dependencies to indicate that your application depends on certain Devtron applications. To add upstream dependencies: 1. Click the **Add Dependency** button in the **Dependencies** section. If dependencies already exist, click the **Edit Dependency** button on the right instead. @@ -213,7 +213,7 @@ To add upstream dependencies: 2. In the right-side panel, under Upstream Dependency, click **+ Add Dependency**. -![Figure 14:Adding Dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg) +![Figure 14: Adding Dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg) 3. Use the search bar to find and select one or more applications that your app depends on. @@ -246,4 +246,4 @@ For every downstream application listed, a **Map Environment** link appears besi * Clicking this link redirects you to that application’s Dependencies section, where your app will appear in the upstream list. -* From there, you can assign or update the environment mapping for your app in the context of that downstream application. \ No newline at end of file +* From there, you can assign or update the environment mapping for your app in the context of that downstream application.