Skip to content

Commit aa1598e

Browse files
nschadkd7lxl
andauthored
update sidecar docs (#310)
* update sidecar docs Signed-off-by: ShuzZzle <[email protected]> * update sidecar docs Signed-off-by: ShuzZzle <[email protected]> * fix spelling Co-authored-by: Tom Hayward <[email protected]> Signed-off-by: nschad <[email protected]> Co-authored-by: Tom Hayward <[email protected]>
1 parent 9678174 commit aa1598e

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

docs/guides/configure_rules_via_sidecar.markdown

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ Cortex can be configured to use a sidecar container in the Ruler and AlertManage
1010
Put ConfigMaps into the specified namespace, and they are automatically detected and added as files to the Ruler and/or AlertManager containers, both of which are polling for changes on the filesystem and will make the new configurations go live dynamically.
1111
This feature is disabled by default. Here is a simple example:
1212

13-
*Please not that this is only supported with the local or filesystem backend. Otherwise cortex will overwrite what the operator puts in the folder with what is in s3/gcs/azure/swift. Cortex does not 2-way sync the files*
14-
13+
Please note that this is only supported with the **local** backend. Otherwise cortex will overwrite what the operator puts in the folder with what is in s3/gcs/azure/swift. Cortex does not 2-way sync the files. Also please be aware of the following:
14+
- local alertmanager config storage is read-only (cortex API is severely limited to read-only requests)
15+
- local alertmanager storage does not support state persistency (however your configurations are saved in etcd via kubernetes)
16+
- local ruler storage does not support RuleGroups
17+
- local ruler storage does not support namespaces
1518
```yaml
16-
backend: "filesystem"
19+
backend: "local"
1720
```
1821
1922
## Helm values config
@@ -34,16 +37,19 @@ And here are the related configuration values in AlertManager and Ruler:
3437
config:
3538
alertmanager:
3639
data_dir: /data/
37-
storage:
38-
type : local
39-
local:
40-
path: /data
40+
41+
alertmanager_storage:
42+
backend: "local"
43+
local:
44+
path: "/data"
45+
4146
ruler:
4247
rule_path: /data/rules
43-
storage:
44-
type : local
45-
local:
46-
directory: /tmp/rules
48+
49+
ruler_storage:
50+
backend: "local"
51+
local:
52+
directory: "/tmp/rules"
4753
```
4854
In AlertManager, the data_dir and local storage directory should be the same.
4955
In the Ruler, there needs to be two separate volumes. One is read-only and serves as the location shared with the sidecar that contains all of the rules that were derived from configmaps (/tmp/rules). The other is read-write and used by the Ruler itself for its own management of rules, etc (/data).

0 commit comments

Comments
 (0)