Skip to content

docs: Clone an Existing App Page Revamp #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 98 additions & 17 deletions docs/user-guide/cloning-application.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,108 @@
# 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)
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.

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).
This document provides you step-by-step instructions on cloning an existing Devtron application.

![](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 |
## Prerequisites

Now click on `Clone App` to clone the selected application.
To clone an existing Devtron application, you need:

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cloning-application/new-cloned-app.jpg)
* **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).

New application with a duplicate template is created.
* An existing Devtron application.

{% 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 %}
* 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 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 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).

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**.

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

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

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

---

## 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 <img src = "https://docs.devtron.ai/~gitbook/image?url=https%3A%2F%2Fdevtron-public-asset.s3.us-east-2.amazonaws.com%2Fimages%2Fcreating-application%2Fdonot-propagate.jpg&width=300&dpr=2&quality=100&sign=a92f66cf&sv=2" height = 10> 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 <img src = "https://docs.devtron.ai/~gitbook/image?url=https%3A%2F%2Fdevtron-public-asset.s3.us-east-2.amazonaws.com%2Fimages%2Fcreating-application%2Fdonot-propagate.jpg&width=300&dpr=2&quality=100&sign=a92f66cf&sv=2" height = 10> 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 table below to know what is cloned and what is not when you clone an existing, configured Devtron application:

| What is Cloned | What is Not |
| ------ | ---------- |
| 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 | |
| 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, the cloned application will also remain unconfigured.