forked from nautobot/nautobot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
315 lines (310 loc) · 14.9 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
---
dev_addr: "127.0.0.1:8001"
edit_uri: "edit/main/nautobot/docs"
site_dir: "nautobot/project-static/docs"
site_name: "Nautobot Documentation"
site_url: "https://docs.nautobot.com/projects/core/en/stable/"
repo_url: "https://github.com/nautobot/nautobot"
copyright: "Copyright © The Authors"
theme:
name: "material"
navigation_depth: 4
custom_dir: "docs/assets/overrides"
hljs_languages:
- "django"
- "yaml"
features:
- "navigation.tracking"
- "navigation.tabs"
- "navigation.tabs.sticky"
- "search.suggest"
- "search.highlight"
- "search.share"
favicon: "assets/favicon.ico"
logo: "assets/nautobot_logo.svg"
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: "default"
primary: "black"
toggle:
icon: "material/weather-sunny"
name: "Switch to dark mode"
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: "slate"
primary: "black"
toggle:
icon: "material/weather-night"
name: "Switch to light mode"
extra_css:
- "assets/extra.css"
# needed for RTD version flyout menu
# jquery is not (yet) injected by RTD automatically and it might be dropped
# as a dependency in the future
extra_javascript:
- "https://code.jquery.com/jquery-3.6.0.min.js"
extra:
generator: false
ntc_sponsor: true
social:
- icon: "fontawesome/solid/rss"
link: "https://blog.networktocode.com/blog/tags/nautobot"
name: "Network to Code Blog"
- icon: "fontawesome/brands/youtube"
link: "https://www.youtube.com/playlist?list=PLjA0bhxgryJ2Ts4GJMDA-tPzVWEncv4pb"
name: "Nautobot Videos"
- icon: "fontawesome/brands/slack"
link: "https://www.networktocode.com/community/"
name: "Network to Code Community"
- icon: "fontawesome/brands/github"
link: "https://github.com/nautobot/nautobot"
name: "GitHub Repo"
- icon: "fontawesome/brands/twitter"
link: "https://twitter.com/networktocode"
name: "Network to Code Twitter"
markdown_extensions:
- "admonition"
- "toc":
permalink: true
- "attr_list"
- "md_in_html"
- "pymdownx.details"
- "pymdownx.highlight":
anchor_linenums: true
- "pymdownx.inlinehilite"
- "pymdownx.snippets"
- "pymdownx.superfences"
plugins:
- "search"
- "gen-files":
scripts:
- docs/generate_code_reference_pages.py
- "include-markdown"
- "mkdocs-version-annotations"
- "mkdocstrings":
default_handler: "python"
handlers:
python:
paths: ["."]
options:
heading_level: 1
show_root_heading: true
show_root_members_full_path: true
nav:
- Overview: "index.md"
- Documentation:
- Installation:
- Installing Prerequisites: "installation/index.md"
- Installing Nautobot: "installation/nautobot.md"
- Deploying Nautobot Services: "installation/services.md"
- Configuring an HTTP Server: "installation/http-server.md"
- External Authentication (Optional): "installation/external-authentication.md"
- Nautobot Docker Images: "docker/index.md"
- Migration:
- Migrating from NetBox: "installation/migrating-from-netbox.md"
- Upgrading Nautobot: "installation/upgrading.md"
- Migrating from PostgreSQL to MySQL: "installation/migrating-from-postgresql.md"
- Configuration:
- Configuring Nautobot: "configuration/index.md"
- Required Settings: "configuration/required-settings.md"
- Optional Settings: "configuration/optional-settings.md"
- External Authentication:
- LDAP: "configuration/authentication/ldap.md"
- SSO: "configuration/authentication/sso.md"
- Remote Header: "configuration/authentication/remote.md"
- Administration:
- Nautobot Server: "administration/nautobot-server.md"
- Nautobot Shell: "administration/nautobot-shell.md"
- Permissions: "administration/permissions.md"
- Replicating Nautobot: "administration/replicating-nautobot.md"
- Task Queues: "administration/celery-queues.md"
- User Guides:
- Creating Devices: "user-guides/getting-started/creating-devices.md"
- Custom Fields: "user-guides/custom-fields.md"
- Getting Started In the Web UI: "user-guides/getting-started/index.md"
- Git as a Data Source: "user-guides/git-data-source.md"
- GraphQL: "user-guides/graphql.md"
- Interfaces: "user-guides/getting-started/interfaces.md"
- IP Address Management: "user-guides/getting-started/ipam.md"
- Platforms: "user-guides/getting-started/platforms.md"
- Regions: "user-guides/getting-started/regions.md"
- Tenants: "user-guides/getting-started/tenants.md"
- The Search Bar: "user-guides/getting-started/search-bar.md"
- Git as a Data Source: "user-guides/git-data-source.md"
- GraphQL: "user-guides/graphql.md"
- Relationships: "user-guides/relationships.md"
- Django Storages with S3: "user-guides/s3-django-storage.md"
- VLANS and VLAN Groups: "user-guides/getting-started/vlans-and-vlan-groups.md"
- Core Functionality:
- Circuits: "core-functionality/circuits.md"
- Devices and Cabling: "core-functionality/devices.md"
- Device Types: "core-functionality/device-types.md"
- IP Address Management: "core-functionality/ipam.md"
- Power Tracking: "core-functionality/power.md"
- Secrets: "core-functionality/secrets.md"
- Service Mapping: "core-functionality/services.md"
- Sites, Locations, and Racks: "core-functionality/sites-and-racks.md"
- Tenancy: "core-functionality/tenancy.md"
- Virtualization: "core-functionality/virtualization.md"
- VLAN Management: "core-functionality/vlans.md"
- Model Details:
- Circuits:
- Circuit: "models/circuits/circuit.md"
- Circuit Termination: "models/circuits/circuittermination.md"
- Circuit Type: "models/circuits/circuittype.md"
- Circuit Provider: "models/circuits/provider.md"
- Circuit Provider Network: "models/circuits/providernetwork.md"
- DCIM:
- Cable: "models/dcim/cable.md"
- Console Port: "models/dcim/consoleport.md"
- Console Port Template: "models/dcim/consoleporttemplate.md"
- Console Server Port: "models/dcim/consoleserverport.md"
- Console Server Port Template: "models/dcim/consoleserverporttemplate.md"
- Device: "models/dcim/device.md"
- Device Bay: "models/dcim/devicebay.md"
- Device Bay Template: "models/dcim/devicebaytemplate.md"
- Device Redundancy Group: "models/dcim/deviceredundancygroup.md"
- Device Role: "models/dcim/devicerole.md"
- Device Type: "models/dcim/devicetype.md"
- Front Port: "models/dcim/frontport.md"
- Front Port Template: "models/dcim/frontporttemplate.md"
- Interface: "models/dcim/interface.md"
- Interface Template: "models/dcim/interfacetemplate.md"
- Inventory Item: "models/dcim/inventoryitem.md"
- Location: "models/dcim/location.md"
- Location Type: "models/dcim/locationtype.md"
- Manufacturer: "models/dcim/manufacturer.md"
- Platform: "models/dcim/platform.md"
- Power Feed: "models/dcim/powerfeed.md"
- Power Outlet: "models/dcim/poweroutlet.md"
- Power Outlet Template: "models/dcim/poweroutlettemplate.md"
- Power Panel : "models/dcim/powerpanel.md"
- Power Port: "models/dcim/powerport.md"
- Power Port Template: "models/dcim/powerporttemplate.md"
- Rack: "models/dcim/rack.md"
- Rack Group: "models/dcim/rackgroup.md"
- Rack Reservation: "models/dcim/rackreservation.md"
- Rack Role: "models/dcim/rackrole.md"
- Rear Port: "models/dcim/rearport.md"
- Rear Port Template: "models/dcim/rearporttemplate.md"
- Region: "models/dcim/region.md"
- Site: "models/dcim/site.md"
- Virtual Chassis: "models/dcim/virtualchassis.md"
- Extras:
- Config Context: "models/extras/configcontext.md"
- Config Context Schema: "models/extras/configcontextschema.md"
- GraphQL Query: "models/extras/graphqlquery.md"
- Image Attachment: "models/extras/imageattachment.md"
- Job: "models/extras/job.md"
- Job Log Entry: "models/extras/joblogentry.md"
- Job Result: "models/extras/jobresult.md"
- Secret: "models/extras/secret.md"
- Secrets group: "models/extras/secretsgroup.md"
- IPAM:
- Aggregate: "models/ipam/aggregate.md"
- IP Address: "models/ipam/ipaddress.md"
- Prefix: "models/ipam/prefix.md"
- Rir: "models/ipam/rir.md"
- Role: "models/ipam/role.md"
- Route Target: "models/ipam/routetarget.md"
- Service: "models/ipam/service.md"
- VLAN: "models/ipam/vlan.md"
- VLAN Group: "models/ipam/vlangroup.md"
- VRF: "models/ipam/vrf.md"
- Tenancy:
- Tenant: "models/tenancy/tenant.md"
- Tenant Group: "models/tenancy/tenantgroup.md"
- Users:
- Object Permission: "models/users/objectpermission.md"
- Token: "models/users/token.md"
- Virtualization:
- Cluster: "models/virtualization/cluster.md"
- Cluster Group: "models/virtualization/clustergroup.md"
- Cluster Type: "models/virtualization/clustertype.md"
- Virtual Machine: "models/virtualization/virtualmachine.md"
- VM Interface: "models/virtualization/vminterface.md"
- Additional Features:
- Caching: "additional-features/caching.md"
- Change Logging: "additional-features/change-logging.md"
- Computed Fields: "models/extras/computedfield.md"
- Context Data: "additional-features/config-contexts.md"
- Custom Fields: "models/extras/customfield.md"
- Custom Links: "models/extras/customlink.md"
- Dynamic Groups: "models/extras/dynamicgroup.md"
- Export Templates: "models/extras/exporttemplate.md"
- Git Repositories: "models/extras/gitrepository.md"
- Health Check: "additional-features/healthcheck.md"
- Jobs: "additional-features/jobs.md"
- Job Buttons: "models/extras/jobbutton.md"
- Job Hooks: "models/extras/jobhook.md"
- Job Scheduling and Approvals: "additional-features/job-scheduling-and-approvals.md"
- NAPALM: "additional-features/napalm.md"
- Notes: "models/extras/note.md"
- Prometheus Metrics: "additional-features/prometheus-metrics.md"
- Relationships: "models/extras/relationship.md"
- Statuses: "models/extras/status.md"
- Tags: "models/extras/tag.md"
- Template Filters: "additional-features/template-filters.md"
- Webhooks: "models/extras/webhook.md"
- REST API:
- Overview: "rest-api/overview.md"
- Filtering: "rest-api/filtering.md"
- Authentication: "rest-api/authentication.md"
- GraphQL API:
- Overview: "additional-features/graphql.md"
- Installing and Using Plugins: "plugins/index.md"
- App Developer Guide:
- Developing Apps: "plugins/development.md"
- Porting NetBox Plugins to Nautobot: "plugins/porting-from-netbox.md"
- Code Reference:
- nautobot.apps: "code-reference/nautobot/apps/__init__.md"
- nautobot.apps.admin: "code-reference/nautobot/apps/admin.md"
- nautobot.apps.api: "code-reference/nautobot/apps/api.md"
- nautobot.apps.choices: "code-reference/nautobot/apps/choices.md"
- nautobot.apps.datasources: "code-reference/nautobot/apps/datasources.md"
- nautobot.apps.filters: "code-reference/nautobot/apps/filters.md"
- nautobot.apps.forms: "code-reference/nautobot/apps/forms.md"
- nautobot.apps.models: "code-reference/nautobot/apps/models.md"
- nautobot.apps.secrets: "code-reference/nautobot/apps/secrets.md"
- nautobot.apps.tables: "code-reference/nautobot/apps/tables.md"
- nautobot.apps.testing: "code-reference/nautobot/apps/testing.md"
- nautobot.apps.ui: "code-reference/nautobot/apps/ui.md"
- nautobot.apps.urls: "code-reference/nautobot/apps/urls.md"
- nautobot.apps.views: "code-reference/nautobot/apps/views.md"
- Core Developer Guide:
- Introduction: "development/index.md"
- Getting Started: "development/getting-started.md"
- Advanced Docker Compose Usage: "development/docker-compose-advanced-use-cases.md"
- Best Practices: "development/best-practices.md"
- Style Guide: "development/style-guide.md"
- Extending Models: "development/extending-models.md"
- Generic Views: "development/generic-views.md"
- Testing: "development/testing.md"
- Application Registry: "development/application-registry.md"
- Page Templates: "development/templates.md"
- Navigation Menu: "development/navigation-menu.md"
- Home Page Panels: "development/homepage.md"
- User Preferences: "development/user-preferences.md"
- Release Checklist: "development/release-checklist.md"
- Release Notes:
- Overview: "release-notes/index.md"
- Version 1.5: "release-notes/version-1.5.md"
- Version 1.4: "release-notes/version-1.4.md"
- Version 1.3: "release-notes/version-1.3.md"
- Version 1.2: "release-notes/version-1.2.md"
- Version 1.1: "release-notes/version-1.1.md"
- Version 1.0: "release-notes/version-1.0.md"
- Nautobot Apps:
- Overview: "apps/index.md"
- Network to Code App Docs:
- Nautobot ChatOps: "https://docs.nautobot.com/projects/chatops/en/latest/"
- Nautobot Circuit Maintenance: "https://docs.nautobot.com/projects/circuit-maintenance/en/latest/"
- Nautobot Device LifeCycle Management: "https://docs.nautobot.com/projects/device-lifecycle/en/latest/"
- Nautobot Device Onboarding: "https://docs.nautobot.com/projects/device-onboarding/en/latest/"
- Nautobot Firewall Models: "https://nautobot-plugin-firewall-models.readthedocs.io/en/latest/"
- Nautobot Golden Configuration: "https://docs.nautobot.com/projects/golden-config/"
- Nautobot Plugin Nornir: "https://docs.nautobot.com/projects/plugin-nornir/en/latest/"
- Nautobot Single Source of Truth: "https://docs.nautobot.com/projects/ssot/en/latest/"
- Community Apps: "apps/nautobot-apps.md"
- Nautobot Docs Home ↗︎: "https://docs.nautobot.com/"