ella-core/mkdocs.yml at main · Robin-Rhee/ella-core · GitHub

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
site_name: Ella Core Documentation
site_description: A 5G mobile core network for private deployments - easy to operate, reliable, and secure.
site_url: https://docs.ellanetworks.com/
docs_dir: docs
theme:
  name: material
  logo: images/logo.svg
  favicon: images/logo.svg
  palette:
    primary: custom
  font:
    text: Source Code Pro
  features:
    - navigation.sections
    - navigation.footer
    - navigation.indexes
    - content.code.copy
  icon:
    repo: fontawesome/brands/github
  custom_dir: docs/overrides
extra_css:
  - stylesheets/extra.css
  - https://cdn.jsdelivr.net/npm/asciinema-player@3/dist/bundle/asciinema-player.min.css
extra_javascript:
  - https://cdn.jsdelivr.net/npm/asciinema-player@3/dist/bundle/asciinema-player.min.js
  - javascripts/asciinema.js
repo_url: https://github.com/ellanetworks/core
repo_name: ellanetworks/core
copyright: Copyright &copy; 2026 Ella Networks
extra:
  generator: false
  social:
  - icon: fontawesome/solid/globe
    link: https://www.ellanetworks.com
    name: Ella Networks website
  - icon: fontawesome/brands/youtube
    link: https://www.youtube.com/@ellanetworks
    name: Ella Networks on YouTube
  - icon: fontawesome/brands/linkedin
    link: https://www.linkedin.com/company/ellanetworks
    name: Ella Networks on LinkedIn
  - icon: fontawesome/brands/github
    link: https://www.github.com/ellanetworks/core
    name: Ella Networks on GitHub
markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true
nav:
  - Home: index.md
  - Tutorials:
    - tutorials/index.md
    - "Getting Started: Simulated 5G Network": tutorials/getting_started_simulation.md
    - "Getting Started: 5G Network with Radio Hardware": tutorials/getting_started_hardware.md
  - How-to Guides:
    - how_to/index.md
    - Install: how_to/install.md
    - Deploy a High Availability Cluster: how_to/deploy_ha_cluster.md
    - Co-host with OCUDU: how_to/co_host_with_ocudu.md
    - Use VLANs: how_to/vlan.md
    - Use native XDP with veth: how_to/native_xdp_veth.md
    - Integrate with a Radio: how_to/integrate_with_radio.md
    - Backup and Restore: how_to/backup_and_restore.md
    - Scale Up a High Availability Cluster: how_to/scale_up_ha_cluster.md
    - Perform a Rolling Upgrade: how_to/rolling_upgrade.md
    - Tune Network Performance: how_to/performance_tuning.md
    - Advertise subscriber routes with BGP: how_to/bgp.md
    - Manage Your Network with AI Agents: how_to/ai_agents.md
  - Reference:
    - reference/index.md
    - API:
      - reference/api/index.md
      - Authentication: reference/api/auth.md
      - Backup: reference/api/backup.md
      - Cluster: reference/api/cluster.md
      - Initialization: reference/api/initialize.md
      - Audit Logs: reference/api/audit_logs.md
      - Metrics: reference/api/metrics.md
      - Networking: reference/api/networking.md
      - Operator: reference/api/operator.md
      - Policies: reference/api/policies.md
      - Pprof: reference/api/pprof.md
      - Profiles: reference/api/profiles.md
      - Radios: reference/api/radios.md
      - Restore: reference/api/restore.md
      - Slices: reference/api/slices.md
      - Status: reference/api/status.md
      - Subscribers: reference/api/subscribers.md
      - Users: reference/api/users.md
      - Usage: reference/api/usage.md
      - Flow Reports: reference/api/flow_reports.md
      - Support Bundle: reference/api/support_bundle.md
    - Configuration File: reference/config_file.md
    - Production Hardening: reference/production_hardening.md
    - Observability: reference/observability.md
    - Connectivity: reference/connectivity.md
    - Performance: reference/performance.md
    - System Requirements: reference/system_reqs.md
    - Supported 5G Equipment: reference/supported_5g_equipment.md
  - Explanation:
    - explanation/index.md
    - Architecture: explanation/architecture.md
    - High Availability: explanation/high_availability.md
    - Platform Security: explanation/platform_security.md
    - Subscriber Security: explanation/subscriber_security.md
    - User Plane Packet processing with eBPF: explanation/user_plane_packet_processing_with_ebpf.md
    - Advertising and receiving routes via BGP: explanation/bgp.md
    - Obtaining a PLMN ID for a Private Network: explanation/obtaining_plmn_id.md
    - Managing SIM Cards: explanation/managing_sim_cards.md
plugins:
  - search
  - glightbox
  - redirects:
      redirect_maps:
        'tutorials/getting_started.md': 'tutorials/getting_started_simulation.md'
        'tutorials/end_to_end_network.md': 'tutorials/getting_started_simulation.md'
  - social:
      cards_layout_options:
        background_color: "#26374a"
  - llmstxt:
      markdown_description: A 5G mobile core network for private deployments - easy to operate, reliable, and secure.
      full_output: llms-full.txt
      sections:
        Home:
          - index.md
        Tutorials:
          - tutorials/*.md
        How-to Guides:
          - how_to/*.md
        Reference:
          - reference/*.md
          - reference/api/*.md
        Explanation:
          - explanation/*.md