From e210d254834f7e6f5a6aa97f132d74967a03d2b7 Mon Sep 17 00:00:00 2001 From: Bharathvaj Date: Tue, 13 May 2025 13:13:17 +0530 Subject: [PATCH 1/4] Rough Draft: Arrived at the Document Structure --- docs/user-guide/create-application.md | 40 +++++---------------------- 1 file changed, 7 insertions(+), 33 deletions(-) diff --git a/docs/user-guide/create-application.md b/docs/user-guide/create-application.md index 682936ee8..f21d862f2 100644 --- a/docs/user-guide/create-application.md +++ b/docs/user-guide/create-application.md @@ -1,41 +1,15 @@ # Create a New Application -* On the Devtron dashboard, select **Applications**. -* On the upper-right corner of the screen, click **Create**. -* Select **Custom app** from the drop-down list. +## Introduction -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-app-1.jpg) +--- -A new application can be created from one of the following options: +## Prerequisites -* Custom App -* [From Chart Store](../user-guide/deploy-chart/README.md) +--- +## Creating a New Custom Devtron Application -## Create Custom App - -To create a new application from the custom app, select **Custom app**. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-application.jpg) - -* In the **Create application** window, enter an **App Name** and select a **Project**. -* Select either: -* If you select **Create from scratch**, select the project from the drop-down list.
`Note`: You have to add [project under Global Configurations](./global-configurations/projects.md). Only then, it will appear in the drop-down list here. -* If you select **Clone existing application**, select an app you want to clone from and the project from the drop-down list.
`Note`: You have to add [project under Global Configurations](./global-configurations/projects.md). Only then, it will appear in the drop-down list here.
- - -## Tags - -`Tags` are key-value pairs. You can add one or multiple tags in your application. - -**Propagate Tags** -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. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/propagate-tags.jpg) - -* Click `+ Add tag` to add a new tag. -* Click the symbol on the left side of your tag to propagate a tag.
`Note`: Dark grey colour in symbol specifies that the tags are propagated. -* To remove the tags from propagation, click the symbol again. -* Click `Save`. - +--- +## Next Steps \ No newline at end of file From 17555fde358ac2672d1f0bf89d301d81b1474c70 Mon Sep 17 00:00:00 2001 From: Bharathvaj Date: Wed, 14 May 2025 15:21:23 +0530 Subject: [PATCH 2/4] Final Draft: Document Ready for Review --- docs/user-guide/create-application.md | 68 ++++++++++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/create-application.md b/docs/user-guide/create-application.md index f21d862f2..8709cc72c 100644 --- a/docs/user-guide/create-application.md +++ b/docs/user-guide/create-application.md @@ -2,14 +2,80 @@ ## Introduction +In Devtron, an application represents your software project. When you create an application, you can configure the CI/CD pipeline, build and deploy your application, and perform other related tasks. You can create a Devtron application either by using the Chart Store or by creating it from scratch as a Custom Application. If you prefer to create a Devtron application using the Chart Store, please refer to [Charts](../user-guide/deploy-chart/README.md). + +This document provides you step-by-step instructions on creating a new custom application in Devtron. + --- ## Prerequisites +To create a custom application, you need: + +* **Admin** access to create, edit, deploy, and delete permitted Devtron applications. For more information, refer to [Devtron App Permissions](../user-guide/global-configurations/user-access.md). + +* Build and Deploy (CI/CD) integration set up in Devtron to automate the build and deployment process. For more information on the integration, please refer to [Build and Deploy (CI/CD)](../user-guide/deploying-application/README.md). + + {% hint style="warning" %} + + ### Important Note + + The **Devtron Apps** tab on the Applications page is displayed only after you have integrated Build and Deploy (CI/CD) with Devtron. If Build and Deploy (CI/CD) is not integrated, the **Devtron Apps** tab will not be visible. + + {% endhint %} + +* A project created in the **Projects** page (**Global Configurations** → **Projects**). + --- ## Creating a New Custom Devtron Application +Follow the below instructions to create a new custom Devtron application: + +1. Navigate to the **Applications** page in Devtron. + +2. Click the **Create** button at the top-right corner of the screen. + + ![Figure 1: Custom App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/custom-application.jpg) + +3. Perform one of the following actions: + + a. Click on the **From Chart store** option to create an application from the chart store. For more information, refer to [Charts](../user-guide/deploy-chart/README.md). + + b. Click on the **Job** option to create or clone a job. For more information, refer to [Jobs](./jobs/README.md). + + c. Click on the **Custom app** option to create a custom application. The **Create Devtron Application** page is then displayed. The **Blank application** option is selected by default. However, if you wish to clone an existing application, click on **Clone application**. For more information, refer to [Clone Application](cloning-application.md). + + ![Figure 2: Create a Devtron Application](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/create-application.jpg) + +4. Select your preferred project from the **Project** drop-down box. All the projects that you have created in the Projects page (**Global Configurations** → **Projects**) are displayed as available options in the **Project** drop-down box. + +5. Enter your application name in the **Application name** text box. You can enter a minimum of 3 and a maximum of 30 alphanumeric characters in the **Application name** text box. The usage of special characters and spaces are restricted. However, you can use hyphens (-) for separation. + +6. Enter the description for your application in the **Description** text box (optional step). + +7. Expand the **Add tags to application** (optional step). + + ![Figure 3: Add Tags to Application](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/tags.jpg) + + You can add propagate tags while creating an application. When you propagate tags to your application, the specified tags are automatically transferred from a high-level Kubernetes resource, such as your application, to the low-level Kubernetes resources, such as pods, services, etc., This way, tag propagation allows you to troubleshoot issues, query on related components, filter, group metrics and much more. + +8. Enter the key name in the **KEY** field and the corresponding value in the **VALUE** field. + +9. Click the symbol on the left side of the **KEY** column to propagate a tag. A dark color in the symbol represents that the tags are propagated. + +10. Click the symbol again to remove the tags from propagation. + +11. Click the **+** icon against **KEY** to add more tags, if required. + +12. Click the **Create Application** button. + + A new custom application is now created and displayed in the **Devtron Apps** tab in the **Applications** page. + + ![Figure 4: Applications Page](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/applications-page.jpg) + --- -## Next Steps \ No newline at end of file +## Next Steps + +Now that a new custom Devtron application has been created, the next step is to deploy it. To deploy an application, refer to [Deploy a Sample Application](./Deploy-sample-app/nodejs_app.md). \ No newline at end of file From 4bea37d07f5d7d6f9aad6e034b2d4a7de20e207d Mon Sep 17 00:00:00 2001 From: Bharathvaj Date: Wed, 14 May 2025 16:11:50 +0530 Subject: [PATCH 3/4] Replaced a Screenshot to Add More Context --- docs/user-guide/create-application.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/create-application.md b/docs/user-guide/create-application.md index 8709cc72c..c3b3c9f2b 100644 --- a/docs/user-guide/create-application.md +++ b/docs/user-guide/create-application.md @@ -70,9 +70,9 @@ Follow the below instructions to create a new custom Devtron application: 12. Click the **Create Application** button. - A new custom application is now created and displayed in the **Devtron Apps** tab in the **Applications** page. + A new custom application is now created. The same is also displayed in the **Devtron Apps** tab in the **Applications** page. - ![Figure 4: Applications Page](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/applications-page.jpg) + ![Figure 4: Application Configurations](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/application-created.jpg) --- From d1222ace66f4b8feb23b6a448ae8b45fbb135ea8 Mon Sep 17 00:00:00 2001 From: Bharathvaj Date: Thu, 15 May 2025 15:22:18 +0530 Subject: [PATCH 4/4] Added Extras Section + Fixed Review Comments --- docs/user-guide/create-application.md | 52 ++++++++++++++++----------- 1 file changed, 31 insertions(+), 21 deletions(-) diff --git a/docs/user-guide/create-application.md b/docs/user-guide/create-application.md index c3b3c9f2b..69b31a19a 100644 --- a/docs/user-guide/create-application.md +++ b/docs/user-guide/create-application.md @@ -2,15 +2,15 @@ ## Introduction -In Devtron, an application represents your software project. When you create an application, you can configure the CI/CD pipeline, build and deploy your application, and perform other related tasks. You can create a Devtron application either by using the Chart Store or by creating it from scratch as a Custom Application. If you prefer to create a Devtron application using the Chart Store, please refer to [Charts](../user-guide/deploy-chart/README.md). +In Devtron, an application represents your software project. You can create an application both by using the Chart Store (for Helm apps) and by creating it from scratch as a Custom Devtron Application. If you prefer to create a Helm application using the Chart Store, please refer to [Charts](../user-guide/deploy-chart/README.md). However, when you create a Devtron application is when you can configure the CI/CD pipeline, build and deploy your application, and perform other related tasks. -This document provides you step-by-step instructions on creating a new custom application in Devtron. +This document provides you step-by-step instructions on creating a new custom Devtron application. --- ## Prerequisites -To create a custom application, you need: +To create a custom Devtron application, you need: * **Admin** access to create, edit, deploy, and delete permitted Devtron applications. For more information, refer to [Devtron App Permissions](../user-guide/global-configurations/user-access.md). @@ -20,7 +20,7 @@ To create a custom application, you need: ### Important Note - The **Devtron Apps** tab on the Applications page is displayed only after you have integrated Build and Deploy (CI/CD) with Devtron. If Build and Deploy (CI/CD) is not integrated, the **Devtron Apps** tab will not be visible. + The **Devtron Apps** tab on the **Applications** page is displayed only after you have integrated Build and Deploy (CI/CD) with Devtron. If Build and Deploy (CI/CD) is not integrated, the **Devtron Apps** tab will not be visible. {% endhint %} @@ -28,7 +28,7 @@ To create a custom application, you need: --- -## Creating a New Custom Devtron Application +## Create a New Custom Devtron Application Follow the below instructions to create a new custom Devtron application: @@ -40,42 +40,52 @@ Follow the below instructions to create a new custom Devtron application: 3. Perform one of the following actions: - a. Click on the **From Chart store** option to create an application from the chart store. For more information, refer to [Charts](../user-guide/deploy-chart/README.md). + a. Click on the **From Chart store** option to create a Helm app from the Chart store. For more information on creating Helm apps, refer to [Charts](../user-guide/deploy-chart/README.md). b. Click on the **Job** option to create or clone a job. For more information, refer to [Jobs](./jobs/README.md). - c. Click on the **Custom app** option to create a custom application. The **Create Devtron Application** page is then displayed. The **Blank application** option is selected by default. However, if you wish to clone an existing application, click on **Clone application**. For more information, refer to [Clone Application](cloning-application.md). + c. Click on the **Custom app** option to create a custom Devtron application. The **Create Devtron Application** page is then displayed. The **Blank application** option is selected by default. However, if you wish to clone an existing application, click on **Clone application**. For more information, refer to [Clone Application](cloning-application.md). ![Figure 2: Create a Devtron Application](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/create-application.jpg) -4. Select your preferred project from the **Project** drop-down box. All the projects that you have created in the Projects page (**Global Configurations** → **Projects**) are displayed as available options in the **Project** drop-down box. +4. Select your preferred project from the **Project** drop-down box. All the projects that you have created in the **Projects** page (**Global Configurations** → **Projects**) are displayed as available options in the **Project** drop-down box. 5. Enter your application name in the **Application name** text box. You can enter a minimum of 3 and a maximum of 30 alphanumeric characters in the **Application name** text box. The usage of special characters and spaces are restricted. However, you can use hyphens (-) for separation. 6. Enter the description for your application in the **Description** text box (optional step). -7. Expand the **Add tags to application** (optional step). +7. Expand the **Add tags to application** (optional step). To propagate tags to your application, refer to [Propagate Tags to Your Application](#propagate-tags-to-your-application). ![Figure 3: Add Tags to Application](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/tags.jpg) - You can add propagate tags while creating an application. When you propagate tags to your application, the specified tags are automatically transferred from a high-level Kubernetes resource, such as your application, to the low-level Kubernetes resources, such as pods, services, etc., This way, tag propagation allows you to troubleshoot issues, query on related components, filter, group metrics and much more. +8. Click the **Create Application** button. + + A new custom Devtron application is now created. The same is also displayed in the **Devtron Apps** tab in the **Applications** page. -8. Enter the key name in the **KEY** field and the corresponding value in the **VALUE** field. + ![Figure 4: Application Configurations](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/application-created.jpg) -9. Click the symbol on the left side of the **KEY** column to propagate a tag. A dark color in the symbol represents that the tags are propagated. +--- -10. Click the symbol again to remove the tags from propagation. +## Next Steps -11. Click the **+** icon against **KEY** to add more tags, if required. +Now that a new custom Devtron application has been created, the next step is to configure it. To configure a Devtron application, refer to [Configure a Devtron Application](./Deploy-sample-app/nodejs_app.md). -12. Click the **Create Application** button. - - A new custom application is now created. The same is also displayed in the **Devtron Apps** tab in the **Applications** page. +--- - ![Figure 4: Application Configurations](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/create-custom-app/application-created.jpg) +## Extras ---- +### Propagate Tags to Your Application -## Next Steps +You can propagate tags while creating a Devtron application. When you propagate tags to your application, the specified tags are automatically transferred from a high-level Kubernetes resource, such as your application, to the low-level Kubernetes resources, such as pods, services, etc., This way, tag propagation allows you to troubleshoot issues, query on related components, filter, group metrics and much more. + +Follow the below instructions to propagate tag to your application: + +1. Enter the key name in the **KEY** field and the corresponding value in the **VALUE** field in the **Create Devtron Application** page. + +2. Click the symbol on the left side of the **KEY** column to propagate a tag. A dark color in the symbol represents that the tags are propagated. + +3. Click the symbol again to remove the tags from propagation. + +4. Click the **+** icon against **KEY** to add more tags, if required. -Now that a new custom Devtron application has been created, the next step is to deploy it. To deploy an application, refer to [Deploy a Sample Application](./Deploy-sample-app/nodejs_app.md). \ No newline at end of file +5. Click the **Create Application** button. \ No newline at end of file