Skip to content

Commit 54867a8

Browse files
committed
docs: minor fixes
1 parent 352d8fe commit 54867a8

File tree

1 file changed

+30
-27
lines changed

1 file changed

+30
-27
lines changed

docs/user-guide/creating-application/overview.md

+30-27
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The **Overview** page contains three main sections:
77
* [**Environments**](#environments): Displays all environments where the application is deployed, along with their current status and quick access to associated workflows.
88
* [**Dependencies**](#dependencies): Shows which Devtron applications this application depends on, and which other Devtron applications depend on it thus helping visualize microservices dependency.
99

10-
![Figure 1: Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg)
10+
![Figure 1: Overview Tab](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-latest-1.jpg)
1111

1212
## About
1313

@@ -20,7 +20,7 @@ The **About** section allows you to:
2020

2121
The left side of the **About** section displays essential information about the application.
2222

23-
![Figure 2a: About Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/left-about.jpg)
23+
![Figure 2: About Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/left-about.jpg)
2424

2525
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.
2626

@@ -33,12 +33,12 @@ The left side of the **About** section displays essential information about the
3333
| **Created by**|No|Displays the email address of the user who created the application.|
3434
| **Code Source** |No|Shows the connected Git repository or template used for the application.|
3535
| **Part of release track** |No|Lists all release track names linked to the app.<ul><li>Clicking a release opens its detailed view in the Software Distribution Hub.</li><li>This is an enterprise-only feature available as part of Devtron's SDH offering.</li></ul>|
36-
| **Tags** |Yes|Key-value pairs used for identifying and organizing the application.<br>Users can propagate tags as Kubernetes labels to enable filtering, bulk operations, and integrations with Kubernetes tools.<ol><li> Click the **Edit** icon next to **Tags**.</li><li> On the **Manage Tags** page, Click **+ Add tag** to add a new tag. <li>You can click **X** icon to delete an existing tag.</li><li>You can click the **propagation icon** <img src="https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/donot-propagate.jpg" height="10"> to propagate a tag (turns dark grey when propagated), click again to remove propagation.<br>[[Snapshot](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-latest-1.jpg)]</li><li> Click `Save`, Configured Tags will reflect immediately under **Tags** in **About** Section </li></ol><ul><li>Tags can also be used to [configure PersistentVolumeClaims (PVCs)](#configure-persistentvolumeclaim-pvc) for build time optimization.</li></ul> |
36+
| **Tags** |Yes|Key-value pairs used for identifying and organizing the application.<br>Users can propagate tags as Kubernetes labels to enable filtering, bulk operations, and integrations with Kubernetes tools.<ol><li> Click the **Edit** icon next to **Tags**.</li><li> On the **Manage Tags** page, Click **+ Add tag** to add a new tag. <li>You can click **X** icon to delete an existing tag.</li><li>You can click the **propagation icon** <img src="https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/donot-propagate.jpg" height="10"> to propagate a tag (turns dark grey when propagated), click again to remove propagation.<br>[[Snapshot](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/manage-tags-latest-1.jpg)]</li><li> Click **Save**, Configured Tags will reflect immediately under **Tags** in **About** Section </li></ol><ul><li>Tags can also be used to [configure PersistentVolumeClaims (PVCs)](#configure-persistentvolumeclaim-pvc) for build time optimization.</li></ul> |
3737

3838
### Readme
3939
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.
4040

41-
![Figure 2b: Readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme-edit.jpg)
41+
![Figure 3: Readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme-edit.jpg)
4242

4343
To add or update the **Readme**:
4444
1. Click the **Edit** button in the Readme section.
@@ -47,7 +47,7 @@ To add or update the **Readme**:
4747
4. Preview the content using the **Preview** tab.
4848
5. Click **Save** to update the Readme.
4949

50-
![Figure 2c: Edit readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme.jpg)
50+
![Figure 4: Editing Readme](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/readme.jpg)
5151

5252
{% hint style="info" %}
5353
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
6565

6666
You can expand each environment row to view detailed information like window name, duration, and frequency.
6767

68-
![Figure 2c: Deployment Window](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg)
68+
![Figure 5: Deployment Window](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/deployement-window.jpg)
6969

7070
{% hint style=“info” %}
7171
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
7777

7878
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).
7979

80-
![Figure 2d: Catalog](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg)
80+
![Figure 6: Catalog](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog.jpg)
8181

8282
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.
8383

@@ -89,15 +89,15 @@ When you click the **Edit** icon, a form appears based on the defined schema. As
8989
* Code owners and on-call responsibilities
9090
* Service attributes (e.g., internet-facing flag, communication method, framework, language)
9191

92-
![Figure 2e: Catalog Form ](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-expanded.jpg)
92+
![Figure 7: Catalog Form](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-expanded.jpg)
9393

9494
{% hint style= "info" %}
9595
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.
9696
{% endhint %}
9797

9898
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.
9999

100-
![Figure 2e: Catalog final view ](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-final.jpg)
100+
![Figure 8: Catalog Final View](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/catalog-final.jpg)
101101

102102
### Configure PersistentVolumeClaim (PVC)
103103

@@ -115,7 +115,8 @@ Before you can configure an Application to use a PVC, you need to make sure the
115115

116116
The following is a sample PVC YAML configuration. You can modify it as needed based on your storage class, access mode, and resource requirements:
117117

118-
```
118+
{% code title="applyPolicy.sh" overflow="wrap" lineNumbers="true" %}
119+
```bash
119120
apiVersion: v1
120121
kind: PersistentVolumeClaim
121122
metadata:
@@ -128,7 +129,9 @@ spec:
128129
resources:
129130
requests:
130131
storage: 30Gi
131-
```
132+
```
133+
{% endcode %}
134+
132135
You can apply this configuration using Devtron’s **Resource Browser**
133136

134137
**Apply using Devtron’s Resource Browser**
@@ -139,7 +142,7 @@ You can apply this configuration using Devtron’s **Resource Browser**
139142
4. Paste the YAML into the editor and click **Create**.
140143
5. The PVC will now be created and will appear under **Resource Browser****Config & Storage****PersistentVolumeClaim** with the status shown as `Bound`
141144

142-
**2.** **Apply PVC to CI Pipelines Using Tags**
145+
##### Apply PVC to CI Pipelines Using Tags
143146

144147
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.
145148

@@ -151,7 +154,7 @@ Follow the steps below to apply the PVC to all or specific pipelines
151154
1. Navigate to your application’s **Overview****About** section.
152155
2. Click the **Edit** icon next to the Tags section.
153156

154-
![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)
157+
![Figure 9: Clicking Edit Icon](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pvc-edit-tags-1.jpg)
155158

156159
3. Add one of the following key-value tags depending on how you want the PVC to be applied
157160
* To mount the PVC across all pipelines in the application
@@ -160,17 +163,17 @@ Follow the steps below to apply the PVC to all or specific pipelines
160163
|:--- |:--- |
161164
|devtron.ai/ci-pvc-all | cache-pvc |
162165

163-
![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)
166+
![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)
164167

165168
* To mount the PVC for a specific pipeline only in the application
166169

167170
| Key | Value|
168171
|:--- |:--- |
169172
|devtron.ai/ci-pvc-<pipeline-name>| cache-pvc |
170173

171-
![Figure 3c: Find Pipeline name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-name-pvc-1.jpg)
174+
![Figure 11a: Finding Pipeline name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/pipeline-name-pvc-1.jpg)
172175

173-
![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)
176+
![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)
174177

175178
> Replace <pipeline-name> with the exact name of the CI pipeline (visible in the Workflow Editor).
176179
@@ -188,9 +191,9 @@ The Environments section provides a detailed view of all environments where the
188191
| **Environment** | Displays the name of the Environment.|
189192
| **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.|
190193
| **Commit**|Displays the Git commit hash associated with the last deployment.|
191-
| **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).|
194+
| **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).|
192195

193-
![Figure 4: Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg)
196+
![Figure 12: Environments List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/environments.jpg)
194197

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

@@ -206,32 +209,32 @@ Upstream dependencies are other Devtron applications that your current applicati
206209
To add upstream dependencies:
207210
1. Click the **Add Dependency** button in the **Dependencies** section. If dependencies already exist, click the **Edit Dependency** button on the right instead.
208211

209-
![Figure 5a: Dependencies Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies.jpg)
212+
![Figure 13: Dependencies Section](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies.jpg)
210213

211214
2. In the right-side panel, under Upstream Dependency, click **+ Add Dependency**.
212215

213-
![Figure 5b:Add Dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg)
216+
![Figure 14:Adding Dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-2.jpg)
214217

215218
3. Use the search bar to find and select one or more applications that your app depends on.
216219

217-
![Figure 5c: Select dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-3.jpg)
220+
![Figure 15: Selecting dependency](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-3.jpg)
218221

219222
4. Click **Map Environments** to associate each selected application with a specific environment.
220223
* 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.
221224

222-
![Figure 5d: Map Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-4.jpg)
225+
![Figure 16: Mapping Environments](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-4.jpg)
223226

224227
5. Once you’ve mapped the environments, click **Save** to confirm and apply the upstream dependencies.
225228

226-
![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)
229+
![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)
227230

228231
6. After saving:
229-
* The selected applications will appear under **Dependent Applications** above your current application as Upstream Dependencies.
230-
* Your current application will be shown in bold, displaying its mapped environment and latest deployment details.
232+
* The selected applications will appear under **Dependent Applications** above your current application as Upstream Dependencies.
233+
* Your current application will be shown in bold, displaying its mapped environment and latest deployment details.
231234
* 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.
232-
* Any applications that have added your app as an upstream will automatically be listed below your app as Downstream Dependencies.
235+
* Any applications that have added your app as an upstream will automatically be listed below your app as Downstream Dependencies.
233236

234-
![Figure 5f: Dependencies List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-6.jpg)
237+
![Figure 18: Dependencies List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/add-dependencies-part-6.jpg)
235238

236239
### Downstream Dependencies
237240

0 commit comments

Comments
 (0)