Skip to content

Commit f3dadfd

Browse files
committed
docs: use anchoring, rearrange section on Telemetry
Signed-off-by: Logan Blyth <[email protected]>
1 parent 499066e commit f3dadfd

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/install-upgrade/config.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Or import existing `fab.yaml` and wiring files:
2525

2626
After the above workflow a user will have a .img file suitable for installing the control node, then bringing up the switches which comprise the fabric.
2727

28-
## Complete Fab.yaml Example File
28+
## Complete Fab.yaml Example File <a name="example-file"></a>
2929

3030
``` { .yaml .annotate title="fab.yaml" linenums="1"}
3131
apiVersion: fabricator.githedgehog.com/v1beta1
@@ -114,7 +114,7 @@ In order to avoid conflicts, do not use the following usernames: `operator`,`hha
114114

115115
### NTP and DHCP
116116
The control node uses public NTP servers from Cloudflare and Google by default.
117-
The control node runs a DHCP server on the management network. See the [example file](#complete-example-file).
117+
The control node runs a DHCP server on the management network. See the [example file](#example-file).
118118

119119
### Control Node
120120
The control node is the host that manages all the switches, runs k3s, and serves images.
@@ -131,15 +131,6 @@ API](https://prometheus.io/docs/specs/prw/remote_write_spec/) and Loki API. Metr
131131
errors, operational status, transceivers, fans, power supplies, temperature
132132
sensors, BGP neighbors, LLDP neighbors, and more. Logs include Hedgehog agent logs.
133133

134-
Telemetry can be enabled after installation of the fabric. Open the following
135-
YAML file in an editor on the control node. Modify the fields as needed. Logs
136-
can be pushed to a grafana instance at the customer environment, or to grafana
137-
cloud. To enable the telemetry after install use:
138-
139-
``` shell
140-
kubectl patch -n fab --type merge fabricator/default --patch-file telemetry.yaml
141-
```
142-
143134
```{ .yaml title="telemetry.yaml" linenums="1" }
144135
spec:
145136
config:
@@ -173,5 +164,14 @@ spec:
173164
collectSyslogEnabled: true # collect /var/log/syslog on switches and forward to the lokiTargets
174165
```
175166

167+
Telemetry can be enabled after installation of the fabric. Open the following
168+
YAML file in an editor on the control node. Modify the fields as needed. Logs
169+
can be pushed to a grafana instance at the customer environment, or to grafana
170+
cloud. To enable the telemetry after install use:
171+
172+
``` shell
173+
kubectl patch -n fab --type merge fabricator/default --patch-file telemetry.yaml
174+
```
175+
176176
For additional options, see the `AlloyConfig` [struct in Fabric repo](https://github.com/githedgehog/fabric/blob/master/api/meta/alloy.go).
177177

0 commit comments

Comments
 (0)