Skip to content

Commit 2bd32e6

Browse files
committed
adds readme
1 parent 0cdb00e commit 2bd32e6

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

helm/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Cortex Helm Charts
2+
==================
3+
4+
This directory contains the Helm Charts required to install Cortex.
5+
6+
## Structure
7+
8+
Helm charts are organized into three main directories:
9+
- `bundles`: Contain the Helm charts for each supported scheduling domain, such as `cortex-manila`, `cortex-nova`. They are the highest level of abstraction and part of the Cortex release.
10+
- `lib`: Contain shared library and common Helm charts, such as `cortex-core`, `cortex-postgres` used in the bundles.
11+
- `dev`: Contain development-specific Helm charts. These are not bundles into releases but are used for local development and testing.
12+
13+
```
14+
.
15+
└── helm
16+
17+
├── bundles
18+
│ ├── cortex-nova
19+
│ │ ├── Chart.yaml
20+
│ │ │ ├── lib/cortex-core
21+
│ │ │ ├── lib/cortex-postgres
22+
│ │ │ └── ...
23+
│ │ └── < Scheduling domain specific configuration, alerts, dashboards, etc. >
24+
│ ├── cortex-manila
25+
│ │ └── ...
26+
│ └── ...
27+
├── lib
28+
│ ├── cortex-core
29+
│ ├── cortex-postgres
30+
│ └── ...
31+
└── dev
32+
├── cortex-prometheus-operator
33+
└── ...
34+
```

0 commit comments

Comments
 (0)