-
-
Notifications
You must be signed in to change notification settings - Fork 89
/
mkdocs.yaml
151 lines (149 loc) · 5.89 KB
/
mkdocs.yaml
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
---
site_name: Peering Manager
site_url: https://peering-manager.readthedocs.io/
repo_url: https://github.com/peering-manager/peering-manager
edit_uri: ""
theme:
name: material
logo: media/peering-manager.svg
favicon: media/peering-manager.svg
icon:
repo: fontawesome/brands/github
features:
- content.code.copy
- navigation.indexes
- navigation.footer
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-4
name: Switch to Dark Mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-7
name: Switch to Light Mode
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/peering-manager/peering-manager
- icon: fontawesome/brands/slack
link: https://netdev.chat/
markdown_extensions:
- admonition
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- footnotes
nav:
- Introduction: "introduction.md"
- Installation & Upgrade:
- "setup/index.md"
- 1. PostgreSQL: "setup/1-postgresql.md"
- 2. Redis: "setup/2-redis.md"
- 3. Peering Manager: "setup/3-peering-manager.md"
- 4. Web Server:
- a. Apache 2: "setup/4a-apache2.md"
- b. nginx: "setup/4b-nginx.md"
- 5. External Authentication:
- a. LDAP: "setup/5a-ldap.md"
- b. OIDC: "setup/5b-oidc.md"
- c. SAML2: "setup/5c-saml.md"
- uWSGI: "setup/uwsgi.md"
- Upgrading: "setup/upgrading.md"
- Container Installation: "setup/container.md"
- Ansible Installation: "setup/ansible.md"
- Configuration:
- "configuration/index.md"
- Required Parameters: "configuration/required-parameters.md"
- System: "configuration/system.md"
- Security: "configuration/security.md"
- Date & Time: "configuration/date-time.md"
- Tools: "configuration/tools.md"
- Miscellaneous: "configuration/miscellaneous.md"
- Development: "configuration/development.md"
- Administration:
- Housekeeping: "administration/housekeeping.md"
- Replication: "administration/replication.md"
- User Interface: "user-interface.md"
- Integration:
- REST API: "integrations/rest-api.md"
- Webhooks: "integrations/webhooks.md"
- PeeringDB: "integrations/peeringdb.md"
- IX-API: "integrations/ix-api.md"
- Internet Routing Registries: "integrations/irr-prefixes.md"
- NetBox: "integrations/netbox.md"
- NAPALM: "integrations/napalm.md"
- Prometheus Metrics: "integrations/prometheus-metrics.md"
- Synchronised Data: "integrations/synchronised-data.md"
- Templating:
- "templating/index.md"
- Jinja Filters: "templating/filters.md"
- Exposed Variables: "templating/variables.md"
- Templating Tutorial: "templating/tutorial/index.md"
- Examples:
- Arista EOS: "templating/examples/arista-eos.md"
- Cisco IOS XR: "templating/examples/cisco-iosxr.md"
- Cisco IOS XR as used by AS196610: "templating/examples/cisco-iosxr-as196610.md"
- Cisco IOS-XR from tutorial: "templating/examples/tutorial-cisco-iosxr.md"
- Cisco IOS from tutorial: "templating/examples/tutorial-cisco-ios.md"
- Juniper Junos OS: "templating/examples/juniper-junos.md"
- Peering Request E-Mail: "templating/examples/peering-request-email.md"
- New Network E-mail: "templating/examples/new-network-email.md"
- References:
- Conditions: "reference/conditions.md"
- Filtering: "reference/filtering.md"
- Data Model:
- Core:
- Data Source: "models/core/datasource.md"
- Data File: "models/core/datafile.md"
- Devices:
- Configuration: "models/devices/configuration.md"
- Platform: "models/devices/platform.md"
- Router: "models/devices/router.md"
- Peering:
- Autonomous System: "models/peering/autonomoussystem.md"
- BGP Group: "models/peering/bgpgroup.md"
- Community: "models/peering/community.md"
- Direct Peering Session: "models/peering/directpeeringsession.md"
- Internet Exchange: "models/peering/internetexchange.md"
- Internet Exchange Peering Session: "models/peering/internetexchangepeeringsession.md"
- Routing Policy: "models/peering/routingpolicy.md"
- Connection: "models/net/connection.md"
- Relationship: "models/bgp/relationship.md"
- Messaging:
- Contact: "models/messaging/contact.md"
- Contact Role: "models/messaging/contactrole.md"
- Contact Assignment: "models/messaging/contactassignment.md"
- E-mail: "models/messaging/email.md"
- Extras:
- Config Context: "models/extras/configcontext.md"
- Config Context Assigment: "models/extras/configcontextassignment.md"
- Export Template: "models/extras/exporttemplate.md"
- IX-API: "models/extras/ixapi.md"
- Tag: "models/extras/tag.md"
- Webhook: "models/extras/webhook.md"
- Token: "models/users/token.md"
- Development:
- Getting Started: "development/getting-started.md"
- Style Guide: "development/style-guide.md"
- Release Engineering: "development/release-engineering.md"
- Release Notes:
- "release-notes/index.md"
- Version 1.8: "release-notes/version-1.8.md"
- Version 1.7: "release-notes/version-1.7.md"
- Version 1.6: "release-notes/version-1.6.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"