Skip to content

Commit e6e8c7a

Browse files
authored
feat(blueprint): Ray Blueprint (#871)
1 parent 7924791 commit e6e8c7a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+38898
-2
lines changed

.gitignore

+167
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,170 @@ site
4444

4545
# Checks
4646
.tfsec
47+
48+
# Created by https://www.toptal.com/developers/gitignore/api/python
49+
# Edit at https://www.toptal.com/developers/gitignore?templates=python
50+
51+
### Python ###
52+
# Byte-compiled / optimized / DLL files
53+
__pycache__/
54+
*.py[cod]
55+
*$py.class
56+
57+
# C extensions
58+
*.so
59+
60+
# Distribution / packaging
61+
.Python
62+
build/
63+
develop-eggs/
64+
dist/
65+
downloads/
66+
eggs/
67+
.eggs/
68+
lib/
69+
lib64/
70+
parts/
71+
sdist/
72+
var/
73+
wheels/
74+
share/python-wheels/
75+
*.egg-info/
76+
.installed.cfg
77+
*.egg
78+
MANIFEST
79+
80+
# PyInstaller
81+
# Usually these files are written by a python script from a template
82+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
83+
*.manifest
84+
*.spec
85+
86+
# Installer logs
87+
pip-log.txt
88+
pip-delete-this-directory.txt
89+
90+
# Unit test / coverage reports
91+
htmlcov/
92+
.tox/
93+
.nox/
94+
.coverage
95+
.coverage.*
96+
.cache
97+
nosetests.xml
98+
coverage.xml
99+
*.cover
100+
*.py,cover
101+
.hypothesis/
102+
.pytest_cache/
103+
cover/
104+
105+
# Translations
106+
*.mo
107+
*.pot
108+
109+
# Django stuff:
110+
*.log
111+
local_settings.py
112+
db.sqlite3
113+
db.sqlite3-journal
114+
115+
# Flask stuff:
116+
instance/
117+
.webassets-cache
118+
119+
# Scrapy stuff:
120+
.scrapy
121+
122+
# Sphinx documentation
123+
docs/_build/
124+
125+
# PyBuilder
126+
.pybuilder/
127+
target/
128+
129+
# Jupyter Notebook
130+
.ipynb_checkpoints
131+
132+
# IPython
133+
profile_default/
134+
ipython_config.py
135+
136+
# pyenv
137+
# For a library or package, you might want to ignore these files since the code is
138+
# intended to run in multiple environments; otherwise, check them in:
139+
**/.python-version
140+
141+
# pipenv
142+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
143+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
144+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
145+
# install all needed dependencies.
146+
#Pipfile.lock
147+
148+
# poetry
149+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
150+
# This is especially recommended for binary packages to ensure reproducibility, and is more
151+
# commonly ignored for libraries.
152+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
153+
#poetry.lock
154+
155+
# pdm
156+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
157+
#pdm.lock
158+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
159+
# in version control.
160+
# https://pdm.fming.dev/#use-with-ide
161+
.pdm.toml
162+
163+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
164+
__pypackages__/
165+
166+
# Celery stuff
167+
celerybeat-schedule
168+
celerybeat.pid
169+
170+
# SageMath parsed files
171+
*.sage.py
172+
173+
# Environments
174+
.env
175+
.venv
176+
env/
177+
venv/
178+
ENV/
179+
env.bak/
180+
venv.bak/
181+
182+
# Spyder project settings
183+
.spyderproject
184+
.spyproject
185+
186+
# Rope project settings
187+
.ropeproject
188+
189+
# mkdocs documentation
190+
/site
191+
192+
# mypy
193+
.mypy_cache/
194+
.dmypy.json
195+
dmypy.json
196+
197+
# Pyre type checker
198+
.pyre/
199+
200+
# pytype static type analyzer
201+
.pytype/
202+
203+
# Cython debug symbols
204+
cython_debug/
205+
206+
# PyCharm
207+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
208+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
209+
# and can be added to the global gitignore or merged into this file. For a more nuclear
210+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
211+
#.idea/
212+
213+
# End of https://www.toptal.com/developers/gitignore/api/python

docs/add-ons/kuberay-operator.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# KubeRay Operator
2+
3+
[KubeRay](https://github.com/ray-project/kuberay) is an open source toolkit to run [Ray](https://www.ray.io/) applications on Kubernetes. For details on its design, please refer to the KubeRay [documentation](https://ray-project.github.io/kuberay/).
4+
5+
> 🛑 This add-on should be considered as experimental and should only be used for proof of concept.
6+
7+
8+
## Usage
9+
10+
KubeRay operator can be deployed by enabling the add-on via the following.
11+
12+
### Basic Example
13+
14+
```hcl
15+
enable_kuberay_operator = true
16+
```
17+
18+
### Advanced Example
19+
20+
Advanced example of KubeRay operator add-on is not currently supported as the upstream project does not publish a [Helm chart yet]. Please 👍 this [issue](https://github.com/ray-project/kuberay/issues/475).
21+
22+
### GitOps Configuration
23+
24+
GitOps is not currently supported due to lack of a published Helm chart upstream. Please 👍 this [issue](https://github.com/ray-project/kuberay/issues/475).

0 commit comments

Comments
 (0)