forked from ray-project/kuberay
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
106 lines (99 loc) · 2.74 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
# Project Information
site_name: KubeRay Docs
site_url: https://ray-project.github.io/kuberay
# Repository
repo_name: ray-project/kuberay
repo_url: https://github.com/ray-project/kuberay
edit_uri: ""
# Configuration
theme:
name: material
language: en
features:
- navigation.tabs
icon:
repo: fontawesome/brands/github
# Navigation
nav:
- Home:
- Welcome: index.md
- Getting Started:
- Installation:
- YAML: deploy/installation.md
- Helm: deploy/helm.md
- Helm (Cluster): deploy/helm-cluster.md
- Docker Images: deploy/docker.md
- Components:
- KubeRay Operator: components/operator.md
- KubeRay API Server: components/apiserver.md
- KubeRay CLI: components/cli.md
- Features:
- RayService: guidance/rayservice.md
- RayJob: guidance/rayjob.md
- Ray GCS Fault Tolerance: guidance/gcs-ft.md
- Autoscaling: guidance/autoscaler.md
- Networking:
- Ingress: guidance/ingress.md
- TLS: guidance/tls.md
- Monitoring and Observability:
- Observability: guidance/observability.md
- Prometheus and Grafana: guidance/prometheus-grafana.md
- Security:
- IAM Roles (AWS EKS): guidance/aws-eks-iam.md
- Pod Security: guidance/pod-security.md
- Integrations:
- KubeRay with MCAD: guidance/kuberay-with-MCAD.md
- KubeRay with Volcano: guidance/volcano-integration.md
- Kubeflow Integration: guidance/kubeflow-integration.md
- Best Practices:
- Executing Commands: guidance/pod-command.md
- Worker Reconnection: best-practice/worker-head-reconnection.md
- Troubleshooting: troubleshooting.md
- Design:
- Core API and Backend Service: design/protobuf-grpc-service.md
- Development:
- Developer Guide: development/development.md
- Release Process:
- Overview: development/release.md
- Generating the Changelog: release/changelog.md
- Releasing the Helm Chart: release/helm-chart.md
# Customization
extra:
version:
provider: mike
plugins:
- tags
- search
# Markdown Extension
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
# Python Markdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde