Skip to content

Commit 3904ddf

Browse files
sandersonCopilotjstirnaman
authored
feat: telegraf-controller scaffolding (#6625)
* feat: telegraf-ui scaffolding * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> * Apply suggestions from code review Co-authored-by: Jason Stirnaman <[email protected]> --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Jason Stirnaman <[email protected]>
1 parent 4cecc27 commit 3904ddf

File tree

11 files changed

+142
-17
lines changed

11 files changed

+142
-17
lines changed

‎assets/styles/layouts/article/blocks/_special-state.scss‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@
1515

1616
p {margin-bottom: 1rem;}
1717

18+
.btn {
19+
border-radius: $radius * 2;
20+
@include gradient($grad-burningDusk);
21+
22+
&:after {
23+
background: linear-gradient(45deg, #a8085a, #7b14d6);
24+
}
25+
}
26+
1827
.expand-wrapper {
1928
border: none;
2029
margin: .5rem 0 1.5rem;

‎content/telegraf/controller/_index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Telegraf Controller documentation
3+
description: >
4+
Documentation for Telegraf Controller, the application for managing Telegraf
5+
deployments at scale. Create and manage Telegraf configurations, monitor
6+
the health of your agents, and more.
7+
menu:
8+
telegraf_controller:
9+
name: Telegraf Controller
10+
weight: 1
11+
---
12+
13+
<!-- TODO - Add intro content for Telegraf Controller -->

‎content/telegraf/controller/agents/_index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Manage Telegraf agents
3+
seotitle: Manage Telegraf agents with Telegraf Controller
4+
description: >
5+
Use Telegraf Controller to create, monitor, and delete Telegraf agents.
6+
menu:
7+
telegraf_controller:
8+
name: Manage agents
9+
weight: 4
10+
cascade:
11+
draft: true
12+
---

‎content/telegraf/controller/configs/_index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Manage Telegraf configurations
3+
seotitle: Manage Telegraf configurations with Telegraf Controller
4+
description: >
5+
Use Telegraf Controller to create, update, and delete Telegraf configurations.
6+
menu:
7+
telegraf_controller:
8+
name: Manage configurations
9+
weight: 3
10+
cascade:
11+
draft: true
12+
---

‎content/telegraf/controller/install.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Install Telegraf Controller
3+
description: >
4+
Download and install Telegraf Controller on Linux, macOS, and Windows operating systems.
5+
menu:
6+
telegraf_controller:
7+
name: Install Telegraf Controller
8+
weight: 2
9+
draft: true
10+
---
11+
12+
<!-- TODO Write installation instructions
13+
1. Requirements
14+
2. Download - Need to accept terms of use before downloading
15+
3. Set up your database
16+
4. Start Telegraf Controller
17+
-->

‎content/telegraf/controller/labels/_index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Manage Telegraf Controller labels
3+
description: >
4+
Use labels to customize and organize Telegraf configurations
5+
and agents in Telegraf Controller.
6+
menu:
7+
telegraf_controller:
8+
name: Manage labels
9+
weight: 5
10+
cascade:
11+
draft: true
12+
---

‎content/telegraf/controller/telegraf-enterprise.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Telegraf Enterprise
3+
description: >
4+
Telegraf Enterprise is a premium, enterprise-grade offering that combines the
5+
Telegraf Controller, a web application for managing Telegraf deployments,
6+
with an Enterprise Support Contract for Telegraf. It is designed for
7+
organizations running Telegraf at scale who require centralized configuration
8+
management, operational visibility, governance, and expert support from
9+
InfluxData.
10+
menu:
11+
telegraf_controller:
12+
name: Telegraf Enterprise
13+
weight: 10
14+
draft: true
15+
---
16+
17+
<!-- TODO Add information about Telegraf Enterprise
18+
- Telegraf Enterprise includes both Telegraf Controller and Telegraf Support
19+
- CTA for more information about Telegraf Enterprise.
20+
21+
This will likely be shared content and have a counter part in the main Telegraf docs
22+
-->

‎data/products.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,19 @@ telegraf:
252252
- How do I use Telegraf for MQTT?
253253
ai_input_placeholder: "Ask questions about Telegraf and InfluxDB"
254254

255+
telegraf_controller:
256+
name: Telegraf Controller
257+
namespace: telegraf
258+
menu_category: other
259+
versions: [v1]
260+
latest: 0.0
261+
latest_patch: 0.0.0
262+
# ai_sample_questions:
263+
# - How do I configure Telegraf for InfluxDB 3?
264+
# - How do I write a custom Telegraf plugin?
265+
# - How do I use Telegraf for MQTT?
266+
# ai_input_placeholder: "Ask questions about Telegraf and InfluxDB"
267+
255268
chronograf:
256269
name: Chronograf
257270
namespace: chronograf

‎layouts/partials/article/special-state.html‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,34 @@
22
{{ $productPathData := split .RelPermalink "/" }}
33
{{ $product := index $productPathData 1 }}
44
{{ $version := index $productPathData 2 }}
5-
{{ $productKey := cond (eq $product "influxdb3") (print "influxdb3_" (replaceRE "-" "_" $version)) $product }}
5+
{{ $isInfluxDB3 := eq $product "influxdb3" }}
6+
{{ $isTelegrafController := and (eq $product "telegraf") (eq $version "controller") }}
7+
{{ .Store.Set "productKey" $product }}
8+
{{ if $isInfluxDB3 }}
9+
{{ .Store.Set "productKey" (print "influxdb3_" (replaceRE "-" "_" $version)) }}
10+
{{ else if $isTelegrafController }}
11+
{{ .Store.Set "productKey" "telegraf_controller" }}
12+
{{ end }}
13+
{{ $productKey := .Store.Get "productKey" }}
614
{{ $productData := index $.Site.Data.products $productKey }}
715
{{ $displayName := $productData.name }}
8-
{{ $earlyAccessList := slice "" }}
16+
{{ $productPathWhitelist := slice "telegraf/controller" }}
917

10-
{{ if in $earlyAccessList (print $product "/" $version )}}
18+
{{ if in $productPathWhitelist (print $product "/" $version )}}
1119
<div class="block special-state">
1220
<div class="state-content">
13-
<h4 id="influxdb3-explorer-ga">{{ $displayName }} is Generally Available</h4>
21+
<h4 id="telegraf-controller-private-alpha">{{ $displayName }} is in Private Alpha</h4>
1422
<p>
15-
{{ $displayName }} is generally available and is ready for production use.
16-
We welcome and encourage your input about your experience with Explorer and
17-
invite you to <strong>join our public channels</strong> for updates and to
18-
share feedback.
23+
{{ $displayName }} is in private alpha. If you are interested in being a
24+
part of the private alpha program, please sign up:
1925
</p>
26+
<p><a href="https://www.influxdata.com/products/telegraf-enterprise" class="btn">Sign Up for the Alpha</a></p>
2027
<p>
21-
<em>The {{ $displayName}} documentation is a work in progress, and we are actively
28+
While in alpha, {{ $displayName }} is <strong>not meant for production use</strong>.
29+
The {{ $displayName}} documentation is a work in progress, and we are actively
2230
working to improve it. If you have any questions or suggestions, please
23-
<a href="https://github.com/influxdata/docs-v2/issues/new?labels=InfluxDB%203%20Explorer">submit an issue</a>.
24-
We welcome any and all contributions.</em>
31+
<a href="https://github.com/influxdata/docs-v2/issues/new?labels=Telegraf%20Controller">submit an issue</a>.
32+
We welcome any and all contributions.
2533
</p>
2634
<div class="expand-wrapper">
2735
<div class="expand" id="feedback-channels">
@@ -30,9 +38,9 @@ <h4 id="influxdb3-explorer-ga">{{ $displayName }} is Generally Available</h4>
3038
</p>
3139
<div class="expand-content" style="display: none;" >
3240
<ul class="feedback-channels">
33-
<li><a href="https://discord.gg/9zaNCW2PRT" target="_blank" class="discord">InfluxDB Discord Server <em style="opacity:.5">(Preferred)</em></a></li>
41+
<!-- <li><a href="https://discord.gg/9zaNCW2PRT" target="_blank" class="discord">InfluxDB Discord Server <em style="opacity:.5">(Preferred)</em></a></li> -->
42+
<li><a href="https://influxdata.com/slack" target="_blank" class="slack">InfluxDB Community Slack <em style="opacity:.5">(Preferred)</em></a></li>
3443
<li><a href="https://community.influxdata.com" target="_blank" class="community">InfluxData Community</a></li>
35-
<li><a href="https://influxdata.com/slack" target="_blank" class="slack">InfluxDB Community Slack</a></li>
3644
<li><a href="https://reddit.com/r/influxdb" target="_blank" class="reddit">InfluxDB Subreddit</a></li>
3745
</ul>
3846
</div>

‎layouts/partials/sidebar.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ <h4 class="flux">Flux</h4>
9292
{{ end }}
9393

9494
<!-- Platform menu for 1.x docs -->
95-
{{ $platformWhitelist := `telegraf|chronograf|kapacitor|enterprise_influxdb|influxdb_1` }}
96-
{{ if gt (len (findRE $platformWhitelist $menuKey)) 0 }}
95+
{{ $platformWhitelist := (slice "telegraf_v1" "chronograf_v1" "kapacitor_v1" "enterprise_influxdb_v1" "influxdb_v1") }}
96+
{{ if (in $platformWhitelist $menuKey) }}
9797
<h4 class="platform">InfluxData Platform</h4>
9898
{{ partial "sidebar/nested-menu" (dict "page" $currentPage "menu" $platformMenu) . }}
9999
{{ end }}

0 commit comments

Comments
 (0)