From 9dec64be26c47b5cdefa2ad8a8dbeddc255470a4 Mon Sep 17 00:00:00 2001 From: Bharathvaj Date: Wed, 14 May 2025 16:34:49 +0530 Subject: [PATCH 1/3] Rough Draft: Arrived at the Document Structure --- docs/user-guide/cloning-application.md | 28 +++++--------------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/docs/user-guide/cloning-application.md b/docs/user-guide/cloning-application.md index 2bdc36d0c..c4b1e8a59 100644 --- a/docs/user-guide/cloning-application.md +++ b/docs/user-guide/cloning-application.md @@ -1,27 +1,9 @@ -# Cloning Application +# CLone an Existing Application -Click on `Create New` and the select `Custom app` to create a new application. +## Introduction -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cloning-application/custom-app.jpg) +## Prerequisites - As soon you click on `Custom app`, you will get a popup window on screen where you have to enter `app name` and `project` for the application. there are two radio buttons present on the popup window, one is for `Blank app` and another one is for `Clone an existing app`. For cloning an existing application, select the second one. After this, one more drop-down will appear on the window from which you can select the application that you want to clone. For this, you will have to type minimum three character to see the matching results in the drop-down. After typing the matching characters, select the application that you want to clone. You also can add additional information about the application (eg. `created by`, `Created on`) using `tags` (only key:value allowed). - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cloning-application/clone-app.jpg) - -| Key | Description | -| :--- | :--- | -| `App Name` | Name of the new app you want to Create | -| `Project` | Project name | -| `Select an app to clone` | Select the application that you want to clone | -| `Tags` | Additional information about the application | - -Now click on `Clone App` to clone the selected application. - -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cloning-application/new-cloned-app.jpg) - -New application with a duplicate template is created. - -{% hint style="warning" %} -When cloning an application with GitOps configuration, the configuration itself is not copied. To set up the configuration for your new application, refer [GitOps Configuration](./creating-application/gitops-config.md) guide. -{% endhint %} +## Clone an Existing Application +## Next Steps \ No newline at end of file From c702f1e137ee7e614057dbf7933ac8e72210d790 Mon Sep 17 00:00:00 2001 From: Bharathvaj Date: Fri, 16 May 2025 13:07:07 +0530 Subject: [PATCH 2/3] Rough Draft: V1 --- docs/user-guide/cloning-application.md | 105 ++++++++++++++++++++++++- 1 file changed, 102 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/cloning-application.md b/docs/user-guide/cloning-application.md index c4b1e8a59..9c2fdbe42 100644 --- a/docs/user-guide/cloning-application.md +++ b/docs/user-guide/cloning-application.md @@ -1,9 +1,108 @@ -# CLone an Existing Application +# Clone an Existing Application ## Introduction +In Devtron, an application represents your software project. You can clone a Devtron application but not a Helm application created using the Chart store. So if you prefer to know more about creating Helm apps using Charts, please refer to [Charts](../user-guide/deploy-chart/README.md). However, when you clone a Devtron application, you can configure the CI/CD pipeline, build and deploy your application, and perform other related tasks just like how you would do when creating a new Devtron application. + +This document provides you step-by-step instructions on cloning an existing Devtron application. + +--- + ## Prerequisites -## Clone an Existing Application +To clone an existing 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). + +* An existing Devtron application. + +* A project created in the **Projects** page (**Global Configurations** → **Projects**). + +--- + +## Clone an Existing Devtron Application + +Follow the below instructions to clone an existing 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 clone an existing Devtron application. The **Create Devtron Application** page is then displayed. If you prefer to create a new Devtron application instead of cloning an existing one, please refer to [Create an Application](./create-application.md). + + ![Figure 2: Clone an Existing Devtron Application](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cloning-application/clone-application.jpg) + +4. Click **Clone application** to clone an existing Devtron application. + +5. 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. + +6. Enter your cloned 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. + +7. Enter the description for your cloned application in the **Description** text box (optional step). + +8. 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) + +9. Select your preferred existing application to clone from the **Select an app to clone** drop-down box. All Devtron applications created, irrespective of whether it is configured or not, are displayed as available options in the **Select an app to clone** drop-down box. + +10. Click the **Create Application** button. + + A cloned Devtron 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/cloning-application/clone-application-created.jpg) + +--- + +## Next Steps + +Now that a cloned application is created, the immediate next step is to modify the Git repositories, corresponding branches and container registries to be used for each CI pipeline if required. Please refer to [What is Cloned and What is Not](#what-is-cloned-and-what-is-not) section in this document to know what is cloned and what is not from the existing Devtron application. + +To know more about configuring a Devtron application, please refer to [Configuring a Devtron Application](./Deploy-sample-app/nodejs_app.md). + +--- + +## Extras + +### Propagate Tags to Your Application + +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 of 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. + +5. Click the **Create Application** button. + +### What is Cloned and What is Not + +Please refer to the below table to know what is cloned and what is not when you clone an existing Devtron application that is already configured: + +| Cloned | Not Cloned | +| ------ | ---------- | +| GitHub repository configurations | Build not triggered | +| Container registry and repository | Deployment not triggered | +| Target platform for the build | No commit is deployed | +| Base configurations | | +| CI/CD pipeline | | +| Trigger build & deploy pipeline configuration | | +| Deployment strategy | | +| Cluster | | +| Namespace | | +| Code source | | -## Next Steps \ No newline at end of file +When you clone an existing Devtron application that is not yet configured, then the cloned application will also have no configurations configured. \ No newline at end of file From be6a2c39672198fd7ad086a449bd07cb1b19324f Mon Sep 17 00:00:00 2001 From: Bharathvaj Date: Fri, 16 May 2025 14:42:27 +0530 Subject: [PATCH 3/3] Revamped the Document --- docs/user-guide/cloning-application.md | 28 +++++++++++++------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/user-guide/cloning-application.md b/docs/user-guide/cloning-application.md index 9c2fdbe42..b39f47035 100644 --- a/docs/user-guide/cloning-application.md +++ b/docs/user-guide/cloning-application.md @@ -2,7 +2,7 @@ ## Introduction -In Devtron, an application represents your software project. You can clone a Devtron application but not a Helm application created using the Chart store. So if you prefer to know more about creating Helm apps using Charts, please refer to [Charts](../user-guide/deploy-chart/README.md). However, when you clone a Devtron application, you can configure the CI/CD pipeline, build and deploy your application, and perform other related tasks just like how you would do when creating a new Devtron application. +In Devtron, an application represents your software project. You can clone a Devtron application, but not a Helm application created using the Chart store. If you prefer to know more about creating Helm apps using Charts, please refer to [Charts](../user-guide/deploy-chart/README.md). However, when you clone a Devtron application, you can configure the CI/CD pipeline, build and deploy your application, and perform other related tasks just as you would when creating a new Devtron application. This document provides you step-by-step instructions on cloning an existing Devtron application. @@ -26,13 +26,13 @@ Follow the below instructions to clone an existing Devtron application: 1. Navigate to the **Applications** page in Devtron. -2. Click the **Create** button at the top-right corner of the screen. +2. Click the **Create** button at the top-right corner of the page. ![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). + a. Click on the **From Chart store** option to create a Helm 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). @@ -40,11 +40,11 @@ Follow the below instructions to clone an existing Devtron application: ![Figure 2: Clone an Existing Devtron Application](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cloning-application/clone-application.jpg) -4. Click **Clone application** to clone an existing Devtron application. +4. Click **Clone application**. 5. 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. -6. Enter your cloned 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 name of your cloned application 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. 7. Enter the description for your cloned application in the **Description** text box (optional step). @@ -52,7 +52,7 @@ Follow the below instructions to clone an existing Devtron 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) -9. Select your preferred existing application to clone from the **Select an app to clone** drop-down box. All Devtron applications created, irrespective of whether it is configured or not, are displayed as available options in the **Select an app to clone** drop-down box. +9. Select your preferred existing Devtron application to clone from the **Select an app to clone** drop-down box. All Devtron applications created, irrespective of whether it is configured or not, are displayed as available options in the **Select an app to clone** drop-down box. 10. Click the **Create Application** button. @@ -64,7 +64,7 @@ Follow the below instructions to clone an existing Devtron application: ## Next Steps -Now that a cloned application is created, the immediate next step is to modify the Git repositories, corresponding branches and container registries to be used for each CI pipeline if required. Please refer to [What is Cloned and What is Not](#what-is-cloned-and-what-is-not) section in this document to know what is cloned and what is not from the existing Devtron application. +Now that a cloned application has been created, the next step is to modify the Git repository, corresponding configurations and container registries of your cloned application. Please refer to [What is Cloned and What is Not](#what-is-cloned-and-what-is-not) section in this document. To know more about configuring a Devtron application, please refer to [Configuring a Devtron Application](./Deploy-sample-app/nodejs_app.md). @@ -90,19 +90,19 @@ Follow the below instructions to propagate tag to your application: ### What is Cloned and What is Not -Please refer to the below table to know what is cloned and what is not when you clone an existing Devtron application that is already configured: +Please refer to the table below to know what is cloned and what is not when you clone an existing, configured Devtron application: -| Cloned | Not Cloned | +| What is Cloned | What is Not | | ------ | ---------- | -| GitHub repository configurations | Build not triggered | -| Container registry and repository | Deployment not triggered | +| GitHub repository configurations | No build is triggered | +| Container registry and repository | No deployment is triggered | | Target platform for the build | No commit is deployed | | Base configurations | | -| CI/CD pipeline | | -| Trigger build & deploy pipeline configuration | | +| Workflow editor | | +| Trigger build & deploy pipeline configurations | | | Deployment strategy | | | Cluster | | | Namespace | | | Code source | | -When you clone an existing Devtron application that is not yet configured, then the cloned application will also have no configurations configured. \ No newline at end of file +When you clone an existing Devtron application that is not yet configured, the cloned application will also remain unconfigured. \ No newline at end of file