Skip to content

Commit 3953b62

Browse files
authored
docs: add redirect and screenshots, fix preview links (#11)
Add redirect, re-add screenshots we inadvertently removed, and fix the Fern preview link extraction workflow step Signed-off-by: Alex Ball <aball@nvidia.com>
1 parent 2083d0e commit 3953b62

3 files changed

Lines changed: 49 additions & 1 deletion

File tree

.github/workflows/docs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,13 @@ jobs:
9191
}
9292
printf '%s\n' "$output"
9393
94-
preview_url="$(printf '%s\n' "$output" | sed -nE 's#.*(https://[^[:space:]]+-preview-[^[:space:]]+).*#\1#p' | head -n 1)"
94+
preview_url="$(printf '%s\n' "$output" | sed -nE 's#.*(https://[^[:space:])]+-preview-[^[:space:])]+).*#\1#p' | head -n 1)"
9595
if [ -z "$preview_url" ]; then
9696
echo "Fern preview completed, but no preview URL was found."
9797
exit 1
9898
fi
99+
# Remove accidental zero-width space bytes if present in CLI output.
100+
preview_url="$(printf '%s' "$preview_url" | tr -d '\342\200\213')"
99101
100102
echo "preview_url=${preview_url}" >> "$GITHUB_OUTPUT"
101103
echo "Preview URL: ${preview_url}"

docs/fern/docs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ layout:
2828
tabs-placement: header
2929
hide-feedback: true
3030

31+
redirects:
32+
- source: /switch-infrastructure
33+
destination: /switch-infrastructure/config-manager
34+
3135
#==============================================================================
3236
# Content navigation from here down
3337
#==============================================================================

docs/install/tui-wizard-reference.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Each size profile selects a matching Helm values overlay, such as `values-local-
4444

4545
Sites represent data centers managed by this Config Manager deployment. Each site name must match the slug of the corresponding Nautobot Location. Sites scope per-site network secrets such as device login credentials and BGP passwords.
4646

47+
![Cluster section screen](../assets/images/installer/01-cluster.svg)
48+
4749
## 2. Services
4850

4951
Choose which Config Manager services this deployment should run.
@@ -58,6 +60,8 @@ Choose which Config Manager services this deployment should run.
5860

5961
To use an existing Nautobot instance, configure it on the [External Services](#3-external-services) screen.
6062

63+
![Services section screen](../assets/images/installer/02-services.svg)
64+
6165
## 3. External Services
6266

6367
Connect Config Manager to existing Nautobot, Redis, Slack, or PostgreSQL services. Leave a service disabled to use the default in-cluster deployment.
@@ -69,6 +73,8 @@ Connect Config Manager to existing Nautobot, Redis, Slack, or PostgreSQL service
6973
| Slack | Configure a Slack channel for notifications |
7074
| PostgreSQL | Use external PostgreSQL, port, Temporal host, Temporal Visibility host, Config Store host, DHCP host, Nautobot host |
7175

76+
![External Services section screen](../assets/images/installer/03-external-services.svg)
77+
7278
## 4. App Secrets
7379

7480
Choose where application secrets are stored, and configure Git repository tokens for Nautobot Git sync.
@@ -94,6 +100,8 @@ Git tokens create `git-token-<name>` Kubernetes secrets or ESO-backed Vault refe
94100
If you are using local Kubernetes secrets, you can optionally supply manual values for each secret, or leave them blank to auto-generate a random secret.
95101
</Note>
96102

103+
![App Secrets section screen](../assets/images/installer/04-app-secrets.svg)
104+
97105
## 5. Network Secrets
98106

99107
Configure network protocol and workflow secrets written to `config-secrets.ini`. Common entries are pre-seeded on first run, including `hash_salt`, `bgp_password`, `root_password`, and `api_user_key`.
@@ -107,6 +115,8 @@ Configure network protocol and workflow secrets written to `config-secrets.ini`.
107115

108116
The **Scan Plugin Templates** button inspects Jinja2 templates from Content plugin paths to discover additional required secrets. Add template plugin locations on the [Template Plugins](#7-template-plugins) screen.
109117

118+
![Network Secrets section screen](../assets/images/installer/05-network-secrets.svg)
119+
110120
## 6. Ingest Data
111121

112122
Configure custom Nautobot jobs, bootstrap jobs, and post-deploy job execution. Use this section to stage a Design Builder topology loader, include the standard bootstrap jobs, or run other Nautobot jobs after Helm deployment.
@@ -124,6 +134,10 @@ Custom jobs and bootstrap jobs require local Nautobot (`services.nautobot: true`
124134

125135
For a concrete Design Builder example, see [Design Builder Data Loading](../nautobot/design-builder-data-loading.mdx).
126136

137+
![Ingest Data section screen](../assets/images/installer/06-ingest-data.svg)
138+
139+
![Ingest Data file picker](../assets/images/installer/16-ingest-data-file-picker.svg)
140+
127141
## 7. Template Plugins
128142

129143
Configure Jinja2 template plugin directories used by the Render service. The node browser lets you pin plugin PVCs to a Kubernetes node on multi-node clusters that do not have shared RWX storage.
@@ -137,6 +151,10 @@ Configure Jinja2 template plugin directories used by the Render service. The nod
137151

138152
If a PVC is `ReadWriteOnce`, it can only mount on the node where it was first bound. Pin the pod to that node on multi-node clusters without shared NFS or RWX storage.
139153

154+
![Template Plugins section screen](../assets/images/installer/07-template-plugins.svg)
155+
156+
![Template Plugins node browser](../assets/images/installer/17-template-plugins-node-browser.svg)
157+
140158
## 8. OS Images
141159

142160
Configure where ZTP OS images are stored and which images should be uploaded during deployment.
@@ -161,6 +179,8 @@ For file storage, configure the PVC name, size, storage class, access mode, and
161179

162180
If a PVC is `ReadWriteOnce`, it can only mount on the node where it was first bound. Pin the pod to that node on multi-node clusters without shared NFS or RWX storage.
163181

182+
![OS Images section screen](../assets/images/installer/08-os-images.svg)
183+
164184
## 9. Workflows
165185

166186
Configure Temporal workflow RBAC defaults and per-workflow overrides.
@@ -174,6 +194,10 @@ Configure Temporal workflow RBAC defaults and per-workflow overrides.
174194

175195
The workflow list is generated from the Helm RBAC values file.
176196

197+
![Workflows section screen](../assets/images/installer/09-workflows.svg)
198+
199+
![Workflows override dropdown](../assets/images/installer/18-workflows-dropdown.svg)
200+
177201
## 10. Container Images
178202

179203
Configure image source and registry settings.
@@ -191,6 +215,12 @@ When **Pull from registry** is selected, the installer can fetch available tags
191215

192216
Per-image overrides can set a custom repository or tag for individual components. For local builds, images are tagged with a short content hash derived from the Docker image ID. Helm only restarts pods when image content changes.
193217

218+
![Container Images section screen](../assets/images/installer/10-container-images.svg)
219+
220+
![Container Images tags panel](../assets/images/installer/20-container-images-tags.svg)
221+
222+
![Container Images tag select dialog](../assets/images/installer/21-container-images-tag-select.svg)
223+
194224
## 11. SSO
195225

196226
Configure OIDC Single Sign-On for Config Manager services.
@@ -209,6 +239,8 @@ Configure OIDC Single Sign-On for Config Manager services.
209239

210240
The configuration samples use Keycloak as the example OIDC provider, but the installer accepts any OIDC provider that supplies the required issuer, client, secret, JWKS, audience, and scope settings.
211241

242+
![SSO section screen](../assets/images/installer/11-sso.svg)
243+
212244
## 12. SPIFFE
213245

214246
Configure SPIFFE identity for service-to-service authentication.
@@ -224,6 +256,8 @@ Configure SPIFFE identity for service-to-service authentication.
224256
| Socket Host Path | Host socket path for Teleport |
225257
| Group Prefix Mappings | Maps SPIFFE ID prefixes to authorization groups. Use "Auto-generate Default" to populate from the current namespace. |
226258

259+
![SPIFFE section screen](../assets/images/installer/12-spiffe.svg)
260+
227261
## 13. Infrastructure
228262

229263
Configure gateway behavior, TLS, database backups, monitoring resources, and load balancers.
@@ -241,6 +275,8 @@ Load balancer providers include None, MetalLB, Cilium, and AWS NLB. MetalLB and
241275
For local or lab deployments using self-signed TLS, the browser and any API clients must trust the generated certificate authority or explicitly accept the warning for each service hostname.
242276
</Info>
243277

278+
![Infrastructure section screen](../assets/images/installer/13-infrastructure.svg)
279+
244280
## 14. Values Preview
245281

246282
Generate and inspect the complete Helm values YAML before deploying. Use this screen to review exactly what the installer will pass to Helm.
@@ -250,6 +286,10 @@ Generate and inspect the complete Helm values YAML before deploying. Use this sc
250286
| Generate | Build values from the current configuration |
251287
| Write to File | Save generated values to the configured output path |
252288

289+
![Values Preview section screen](../assets/images/installer/14-values-preview.svg)
290+
291+
![Values Preview generated output](../assets/images/installer/19-values-preview-generated.svg)
292+
253293
## 15. Deploy
254294

255295
Run deployment orchestration with live monitoring.
@@ -269,3 +309,5 @@ Run deployment orchestration with live monitoring.
269309
Once you have set up your configuration, click the **Start Deployment** button to begin the deployment process. The deploy screen shows a step list, live pod status, deployment logs, individual pod/container log streams, and integration test output.
270310

271311
If anything goes wrong, correct the error and click the **Retry Deployment** button to try again.
312+
313+
![Deploy section screen](../assets/images/installer/15-deploy.svg)

0 commit comments

Comments
 (0)