Skip to content
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
* [App Details](user-guide/creating-application/app-details.md)
* [Debugging Deployment And Monitoring](user-guide/debugging-deployment-and-monitoring.md)
* [Application Metrics](user-guide/creating-application/app-metrics.md)
* [Overview](user-guide/creating-application/overview.md)
* [Charts](user-guide/deploy-chart/README.md)
* [Charts Overview](user-guide/deploy-chart/overview-of-charts.md)
* [Deploy & Observe](user-guide/deploy-chart/deployment-of-charts.md)
Expand Down
32 changes: 9 additions & 23 deletions docs/user-guide/creating-application/app-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,41 +7,27 @@ The users can access the [configured external links](../../user-guide/global-con
1. Select **Applications** from the left navigation pane.
2. After selecting a configured application, select the **App Details** tab.

> **Note**: The external link configured on the cluster where your app is located is the only one that is visible.
> **Note**: If you enable `App admins can edit` on the `External Links` page, then only non-super admin users can view the selected links on the `App-Details` page.

As shown in the screenshot, the monitoring tool appears at the configured component level:
As shown in the screenshot, the external links appear on the `App-Details` level:

![External links at apps and pod level](https://devtron-public-asset.s3.us-east-2.amazonaws.com/external-tools/link-app-pod-level.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/external-links/app-details-external-link.png)

![External links at container level](https://devtron-public-asset.s3.us-east-2.amazonaws.com/external-tools/link-container-level.png)


3. Click on an external link to access the Monitoring Tool.
3. You can hover around an external link (e.g. Grafana) to view the description.

The link opens in a new tab with the context you specified as env variables in the [Add an external link](./global-configurations/../../global-configurations/external-links.md) section.

## Change Project of your Application

You can change the project of your application by selecting **About app** from your application.

![About app](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/debugging-deployment-and-monitoring/about-app3.png)

![Project Change](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/debugging-deployment-and-monitoring/project-change.png)
## Manage External Links

The following fields are provided on the **About** page:
On the `App Configuration` page, select `External Links` from the navigation pane.
You can see the configured external links which can be searched, edited or deleted.

| 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 currect project of the application. You can change the project by selecting a different project from the drop-down list. |
You can also `Add Link` to add a new external link.

Click **Save**. The application will be moved to the selected project.
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/external-links/app-config-external-link.jpg)

**Note**: If you change the project:
* The current users will lose the access to the application.
* The users who already have an access to the selected project, will get an access to the application automatically.


## Ingress Host URL
Expand Down
34 changes: 34 additions & 0 deletions docs/user-guide/creating-application/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Overview


The `Overview` section contains the brief information of the application, any added tags, configured external links and deployment details of the particular application.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/overview/overview-app-latest.jpg)


The following details are provided on the **Overview** page:

| 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 currect project of the application. You can change the project by selecting a different project from the drop-down list. |


## Change Project of your Application

You can change the project of your application by selecting **Project** on the `Overview` section.

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/change-project-app.jpg)


Click **Save**. The application will be moved to the selected project.

**Note**: If you change the project:
* The current users will lose the access to the application.
* The users who already have an access to the selected project, will get an access to the application automatically.

96 changes: 68 additions & 28 deletions docs/user-guide/global-configurations/external-links.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,102 @@
# Link to external Monitoring Tools
# External Links

External links allow you to connect to the third-party Monitoring Tools within your Devtron dashboard for seamlessly monitoring/debugging/logging/analyzing your applications.
The Monitoring Tool is available as a bookmark at various component levels, such as application, pods, and container.
External Links allow you to connect to the third-party applications within your Devtron dashboard for seamlessly monitoring/debugging/logging/analyzing your applications. You can select from the pre-defined thrid-party applications such as `Grafana` to link to your application for quick access.

## Use case
Configured external links will be available on the `App details` page. You can also integrate `Document` or `Folder` using **External Links**.

Some of the third-party applications which are pre-defined on `Devtron` Dashboard are:
* Grafana
* Kibana
* Newrelic
* Coralogix
* Datadog
* Loki
* Cloudwatch
* Swagger
* Jira etc.



## Use Case for Monitoring Tool

To monitor/debug an application using a specific Monitoring Tool (such as Grafana, Kibana, etc.), you may need to navigate to the tool's page, then to the respective app/resource page.

External links take you directly to the tool's page, which includes the context of the application, environment, pod, and container.
`External Links` can take you directly to the tool's page, which includes the context of the application, environment, pod, and container.

## Prerequisites

Before you begin, configure an application in the Devtron dashboard.

- Super admin access*
- Super admin access
- Monitoring tool URL

<sup>*</sup>External links can only be added/managed by a super admin, but other users can [access the configured Monitoring tools](././../creating-application/app-details.md) on their app's page.
**Note**: External links can only be added/managed by a super admin, but non-super admin users can [access the configured external links](././../creating-application/app-details.md) on the `App Details` page.

## Add an external link
## Add an External Link

1. On the Devtron dashboard, select `Global Configurations` from the left navigation pane.
1. On the Devtron dashboard, go to the `Global Configurations` from the left navigation pane.
2. Select `External links`.

![External links welcome page](https://devtron-public-asset.s3.us-east-2.amazonaws.com/external-tools/external-links-welcome.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/external-tools/external-links-welcome.png)

3. Select **Add Link**.
4. On the `Add Link` page, select the external link (e.g. Grafana) which you want to link to your application from Webpage.

3. Select **Add link**.
4. On the `Add link` page, enter the following fields:

![Create an external link](https://devtron-public-asset.s3.us-east-2.amazonaws.com/external-tools/add-external-link.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/external-links/external-add-link.png)

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/external-links/external-link-specific-applications.png)

The following fields are provided on the **Add Link** page:

<table>
<row>
<th>Field name</th>
<th>Field</th>
<th>Description</th>
</row>
<tr>
<td><b>Monitoring Tool</b></td>
<td>Select a Monitoring Tool from the drop-down list. To add a different tool, select 'Other'.</td>
<td><b>Link name</b></td>
<td>Provide name for the tool you want to link.</td>
</tr>
<tr>
<td><b>Description</b></td>
<td>Description of the link name.</td>
</tr>
<tr>
<td><b>Name</b></td>
<td>Enter a user-defined name for the Monitoring Tool</td>
<td><b>Show link in</b></td>
<td> <ul>
<li>All apps in specific clusters: Select this option to select the cluster.</li>
<li>Specific applications: Select this option to select the application.</li>
</ul></td>
</tr>
<tr>
<td><b>Clusters</b></td>
<td>
Choose the clusters for which you want to configure the selected tool.
Choose the clusters for which you want to configure the selected external tool with.
<ul>
<li>Select more than one cluster name, to enable the link on multiple clusters</li>
<li>Select 'Cluster: All', to enable the link on the existing clusters and future clusters</li>
<li>Select one or more than one cluster to enable the link on the specified clusters.</li>
<li>Select All Clusters to enable the link on all the clusters.</li>
</ul>
</td>
</tr>
<tr>
<td><b>Applications</b></td>
<td>
Choose the application for which you want to configure the selected external tool with.
<ul>
<li>Select one or more than one application to enable the link on the specified application.</li>
<li>Select All applications to enable the link on all the applications.<br>Note: If you enable `App admins can edit`, then you can view the selected links on the App-Details page. </li>
</ul>
</td>
</tr>
<tr>
<td><b>URL Template</b></td>
<td>
The configured URL Template is used by apps deployed on the selected clusters.
The configured URL Template is used by apps deployed on the selected clusters/applications.
By combining one or more of the env variables, a URL with the structure shown below can be created:<br></br>
<i>http://www.domain.com/{namespace}/{appName}/details/{appId}/env/{envId}/details/{podName}</i>
<br></br>
If you include the variables {podName} and {containerName} in the URL template, then the configured links (e.g. Grafana) will be visible only on the pod level and container level respectively.<br></br>
The env variables:
<ul>
<li>{appName}</li>
Expand All @@ -69,26 +106,29 @@ Before you begin, configure an application in the Devtron dashboard.
<li>{podName}: If used, the link will only be visible at the pod level on the <a href="../creating-application/app-details.md"> App details </a> page.
<li>{containerName}: If used, the link will only be visible at the container level on the <a href="../creating-application/app-details.md">App details</a> page. </li>
</ul>
<b>Note: The env variables will be dynamically replaced by the values that you used to configure the link.
<b>Note: The env variables will be dynamically replaced by the values that you used to configure the link.
</td>
</tr>
</table>


> Note: To add multiple links, select **+ Add another** at the top-left corner.

Select **Save**.
Click **Save**.

## Access an external link

The users (admin and others) can access the configured external link from the [App details](././../creating-application/app-details.md) page.
The users (admin and others) can access the configured external link on the [App Details](././../creating-application/app-details.md) page.

**Note**: If you enable `App admins can edit` on the `External Links` page, then only non-super admin users can view the selected links on the `App-Details` page.

## Manage external links
## Manage External links

On this page, the configured external links can be filtered/searched, as well as edited/deleted.
On the `External Links` page, the configured external links can be filtered/searched, as well as edited/deleted.

Select `Global Configurations > External links`.

![Manage external links](https://devtron-public-asset.s3.us-east-2.amazonaws.com/external-tools/manage-external-links.png)
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/external-links/manage-external-links.png)

* Filter and search the links based on the tool's name or a user-defined name.
* Edit a link by selecting the edit icon next to an external link.
Expand Down