You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guide/creating-application/app-details.md
+23-9Lines changed: 23 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,27 +7,41 @@ The users can access the [configured external links](../../user-guide/global-con
7
7
1. Select **Applications** from the left navigation pane.
8
8
2. After selecting a configured application, select the **App Details** tab.
9
9
10
-
> **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.
10
+
> **Note**: The external link configured on the cluster where your app is located is the only one that is visible.
11
11
12
-
As shown in the screenshot, the external links appear on the `App-Details` level:
12
+
As shown in the screenshot, the monitoring tool appears at the configured component level:
15
15
16
+
16
17
17
-
3. You can hover around an external link (e.g. Grafana) to view the description.
18
+
19
+
3. Click on an external link to access the Monitoring Tool.
18
20
19
21
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.
20
22
23
+
## Change Project of your Application
24
+
25
+
You can change the project of your application by selecting **About app** from your application.
Copy file name to clipboardExpand all lines: docs/user-guide/global-configurations/external-links.md
+28-68Lines changed: 28 additions & 68 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,102 +1,65 @@
1
-
# External Links
1
+
# Link to external Monitoring Tools
2
2
3
-
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.
3
+
External links allow you to connect to the third-party Monitoring Tools within your Devtron dashboard for seamlessly monitoring/debugging/logging/analyzing your applications.
4
+
The Monitoring Tool is available as a bookmark at various component levels, such as application, pods, and container.
4
5
5
-
Configured external links will be available on the `App details` page. You can also integrate `Document` or `Folder` using **External Links**.
6
-
7
-
Some of the third-party applications which are pre-defined on `Devtron` Dashboard are:
8
-
* Grafana
9
-
* Kibana
10
-
* Newrelic
11
-
* Coralogix
12
-
* Datadog
13
-
* Loki
14
-
* Cloudwatch
15
-
* Swagger
16
-
* Jira etc.
17
-
18
-
19
-
20
-
## Use Case for Monitoring Tool
6
+
## Use case
21
7
22
8
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.
23
9
24
-
`External Links` can take you directly to the tool's page, which includes the context of the application, environment, pod, and container.
10
+
External links take you directly to the tool's page, which includes the context of the application, environment, pod, and container.
25
11
26
12
## Prerequisites
27
13
28
14
Before you begin, configure an application in the Devtron dashboard.
29
15
30
-
- Super admin access
16
+
- Super admin access*
31
17
- Monitoring tool URL
32
18
33
-
**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.
19
+
<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.
34
20
35
-
## Add an External Link
21
+
## Add an external link
36
22
37
-
1. On the Devtron dashboard, go to the`Global Configurations` from the left navigation pane.
23
+
1. On the Devtron dashboard, select`Global Configurations` from the left navigation pane.
The following fields are provided on the **Add Link** page:
31
+
51
32
52
33
<table>
53
34
<row>
54
-
<th>Field</th>
35
+
<th>Field name</th>
55
36
<th>Description</th>
56
37
</row>
57
38
<tr>
58
-
<td><b>Link name</b></td>
59
-
<td>Provide name for the tool you want to link.</td>
60
-
</tr>
61
-
<tr>
62
-
<td><b>Description</b></td>
63
-
<td>Description of the link name.</td>
39
+
<td><b>Monitoring Tool</b></td>
40
+
<td>Select a Monitoring Tool from the drop-down list. To add a different tool, select 'Other'.</td>
64
41
</tr>
65
42
<tr>
66
-
<td><b>Show link in</b></td>
67
-
<td> <ul>
68
-
<li>All apps in specific clusters: Select this option to select the cluster.</li>
69
-
<li>Specific applications: Select this option to select the application.</li>
70
-
</ul></td>
43
+
<td><b>Name</b></td>
44
+
<td>Enter a user-defined name for the Monitoring Tool</td>
71
45
</tr>
72
46
<tr>
73
47
<td><b>Clusters</b></td>
74
48
<td>
75
-
Choose the clusters for which you want to configure the selected external tool with.
49
+
Choose the clusters for which you want to configure the selected tool.
76
50
<ul>
77
-
<li>Select one or more than one cluster to enable the link on the specified clusters.</li>
78
-
<li>Select All Clusters to enable the link on all the clusters.</li>
79
-
</ul>
80
-
</td>
81
-
</tr>
82
-
<tr>
83
-
<td><b>Applications</b></td>
84
-
<td>
85
-
Choose the application for which you want to configure the selected external tool with.
86
-
<ul>
87
-
<li>Select one or more than one application to enable the link on the specified application.</li>
88
-
<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>
51
+
<li>Select more than one cluster name, to enable the link on multiple clusters</li>
52
+
<li>Select 'Cluster: All', to enable the link on the existing clusters and future clusters</li>
89
53
</ul>
90
54
</td>
91
55
</tr>
92
56
<tr>
93
57
<td><b>URL Template</b></td>
94
58
<td>
95
-
The configured URL Template is used by apps deployed on the selected clusters/applications.
59
+
The configured URL Template is used by apps deployed on the selected clusters.
96
60
By combining one or more of the env variables, a URL with the structure shown below can be created:<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>
100
63
The env variables:
101
64
<ul>
102
65
<li>{appName}</li>
@@ -106,29 +69,26 @@ The following fields are provided on the **Add Link** page:
106
69
<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.
107
70
<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>
108
71
</ul>
109
-
<b>Note: The env variables will be dynamically replaced by the values that you used to configure the link.
72
+
<b>Note: The env variables will be dynamically replaced by the values that you used to configure the link.
110
73
</td>
111
74
</tr>
112
75
</table>
113
76
114
-
115
77
> Note: To add multiple links, select **+ Add another** at the top-left corner.
116
78
117
-
Click**Save**.
79
+
Select**Save**.
118
80
119
81
## Access an external link
120
82
121
-
The users (admin and others) can access the configured external link on the [App Details](././../creating-application/app-details.md) page.
122
-
123
-
**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.
83
+
The users (admin and others) can access the configured external link from the [App details](././../creating-application/app-details.md) page.
124
84
125
-
## Manage External links
85
+
## Manage external links
126
86
127
-
On the `External Links` page, the configured external links can be filtered/searched, as well as edited/deleted.
87
+
On this page, the configured external links can be filtered/searched, as well as edited/deleted.
0 commit comments