splunk-connect-for-syslog/mkdocs.yml at main · splunk/splunk-connect-for-syslog · 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
site_name: Splunk Connect for Syslog
plugins:
  - search
  - include_dir_to_nav
extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-ZQQ3Q8N2WQ

markdown_extensions:
  - toc:
      permalink: True
  - smarty
  - fenced_code
  - sane_lists
  - codehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.blocks.tab:
      alternate_style: true
  - admonition


theme:
  name: "material"
  palette:
    primary: "black"
    accent: "orange"
  favicon: "images/logo.png"
  logo: "images/logo.png"

nav:
  - Home: "index.md"
  - Architecture and Load Balancers:
      - Read First: "architecture/index.md"
      - Configuration Tool: "architecture/configuration-tool.md"
      - Scaling Solutions:
          - Performance Tests: "architecture/performance-tests.md"
          - Fine-Tuning: "architecture/fine-tuning.md"
      - Load Balancers:
          - Overview: "architecture/lb/index.md"
          - Nginx: "architecture/lb/nginx.md"
          - F5: "architecture/lb/f5.md"
  - Getting Started:
      - Read First: "gettingstarted/index.md"
      - Quickstart Guide: "gettingstarted/quickstart_guide.md"
      - Splunk Setup: "gettingstarted/getting-started-splunk-setup.md"
      - Runtime Configuration: "gettingstarted/getting-started-runtime-configuration.md"
      - Select Runtime:
        - Podman + systemd: "gettingstarted/podman-systemd-general.md"
        - Docker CE + systemd: "gettingstarted/docker-systemd-general.md"
        - MicroK8s + Linux: "gettingstarted/k8s-microk8s.md"
        - Docker Compose: "gettingstarted/docker-compose.md"
        - Docker Desktop + Compose (MacOS): "gettingstarted/docker-compose-MacOS.md"
        - Bring your own Envionment: "gettingstarted/byoe-rhel8.md"
        - Docker&Podman offline installation: "gettingstarted/docker-podman-offline.md"
        - Ansible:
          - Docker Swarm: "gettingstarted/ansible-docker-swarm.md"
          - Podman/Docker: "gettingstarted/ansible-docker-podman.md"
          - mk8s: "gettingstarted/ansible-mk8s.md"
        - Cloud (Experimental):
          - EKS (Experimental): "gettingstarted/eks.md"
  - Sources:
      - Read First: "sources/index.md"
      - Message Formats: "sources/base"
      - Simple Source: "sources/simple.md"
      - Known Vendors: "sources/vendor"
  - Create a parser:
      - Read First: "creating_parsers/index.md"
      - Filter Messages: "creating_parsers/filter_message.md"
      - Parse Messages: "creating_parsers/parse_message.md"
      - Unit Tests: "creating_parsers/unit_tests.md"
  - Configuration: "configuration.md"
  - Destinations: "destinations.md"
  - SC4S Lite:
      - Intro: "lite.md"
      - Pluggable modules: "pluggable_modules.md"
  - Enterprise: enterprise.md
  - Edge Processor: "edge_processor.md"
  - Troubleshooting:
      - SC4S Startup and Validation: "troubleshooting/troubleshoot_SC4S_server.md"
      - SC4S Logging and Troubleshooting Resources: "troubleshooting/troubleshoot_resources.md"
      - PCAP Replay: "troubleshooting/syslog_pcap_sender.md"
      - Splunk Health Checks for SC4S: "troubleshooting/splunk_healthcheck.md"
  - Dashboard: "dashboard.md"
  - Experiments: "experiments.md"
  - Upgrading SC4S: "upgrade.md"
  - SC4S FAQ: "faq.md"