introduce cortex-helm-chart wiki (grafana#208)

* introduce cortex-helm-chart wiki

Signed-off-by: ShuzZzle <[email protected]>

* remove unused file

Signed-off-by: ShuzZzle <[email protected]>

Author: nschad

Chart.yaml

@@ -6,8 +6,12 @@ home: https://cortexmetrics.io/
 icon: https://avatars2.githubusercontent.com/u/43045022?s=200&v=4
 kubeVersion: ^1.19.0-0
 maintainers:
-  - email: [email protected]
-    name: Cortex Maintainers
+  - email: [email protected]
+    name: Tom Hayward
+    url: https://github.com/kd7lxl
+  - email: [email protected]
+    name: Niclas Schad
+    url: https://github.com/ShuzZzle
 name: cortex
 sources:
   - https://github.com/cortexproject/cortex-helm-chart

README.md

@@ -12,7 +12,12 @@ Horizontally scalable, highly available, multi-tenant, long term Prometheus.
 
 | Name | Email | Url |
 | ---- | ------ | --- |
-| Cortex Maintainers | [email protected] |  |
+| Tom Hayward | [email protected] | https://github.com/kd7lxl |
+| Niclas Schad | [email protected] | https://github.com/ShuzZzle |
+
+## Documentation
+
+Checkout our documentation for the cortex-helm-chart [here](https://cortexproject.github.io/cortex-helm-chart/)
 
 ## Dependencies
 
@@ -75,102 +80,6 @@ Note that it might be necessary to use `--reset-values` since some default value
 
 Source code can be found [here](https://cortexmetrics.io/)
 
-## Usage
-### Rules and AlertManager configuration
-Cortex can be configured to use a sidecar container in the Ruler and AlertManager to dynamically discover rules and AlertManager config/templates that are declared as ConfigMaps to allow easy and extensible configuration that avoids having to store state in the Cortex system itself (via config service, etc).
-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.
-This feature is disabled by default. Here is a simple example:
-
-```yaml
-ruler:
-  sidecar:
-    enabled: true
-    searchNamespace: cortex-rules
-
-alertmanager:
-  sidecar:
-    enabled: true
-    searchNamespace: cortex-alertmanager
-```
-And here are the related configuration values in AlertManager and Ruler:
-```yaml
-config:
-  alertmanager:
-    data_dir: /data/
-    storage:
-      type : local
-      local:
-        path: /data
-  ruler:
-    rule_path: /data/rules
-    storage:
-      type : local
-      local:
-        directory: /tmp/rules
-```
-In AlertManager, the data_dir and local storage directory should be the same.
-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).
-Example ConfigMap containing a rule:
-```yaml
-kind: ConfigMap
-metadata:
-  annotations:
-    k8s-sidecar-target-directory: /tmp/rules/fake
-  labels:
-    # Label cortex_rules must exist unless overridden by ruler.sidecar.label
-    cortex_rules: "1"
-  name: rules-cortex-9f99md47tc
-  namespace: cortex-rules
-apiVersion: v1
-data:
-  fake.yaml: |-
-    groups:
-      - name: fake-system-metrics
-        rules:
-          - alert: HighCPUusage
-            expr: avg(100 - rate(node_cpu_seconds_total{instance=~"qag1ge1l.+",mode="idle"}[5m]) * 100) by (instance) > 100
-            for: 3m
-            labels:
-              severity: warning
-            annotations:
-              description: Metrics from {{ $labels.job }} on {{ $labels.instance }} show CPU > 90% for 3m.
-              title: Node {{ $labels.instance }} has high CPU usage
-
-```
-Example ConfigMap containing an alertmanager-config:
-```yaml
-apiVersion: v1
-kind: ConfigMap
-metadata:
-  annotations:
-    k8s-sidecar-target-directory: /data/fake
-  labels:
-    cortex_alertmanager: "1"
-  name: alertmanager-example-config
-data:
-  fake.yaml: |-
-    global:
-      resolve_timeout: 5m
-      http_config: {}
-      smtp_hello: localhost
-      smtp_require_tls: true
-    route:
-      receiver: team-X-mails
-      group_by:
-      - alertname
-      routes:
-      - receiver: "null"
-        match:
-          alertname: Watchdog
-      group_wait: 30s
-      group_interval: 5m
-      repeat_interval: 12h
-    receivers:
-    - name: 'team-X-mails'
-      email_configs:
-      - to: '[email protected]'
-```
-
 ## Requirements
 
 Kubernetes: `^1.19.0-0`

README.md.gotmpl

@@ -11,6 +11,10 @@
 
 {{ template "chart.maintainersSection" . }}
 
+## Documentation
+
+Checkout our documentation for the cortex-helm-chart [here](https://cortexproject.github.io/cortex-helm-chart/)
+
 ## Dependencies
 
 ### Key-Value store
@@ -73,102 +77,6 @@ Note that it might be necessary to use `--reset-values` since some default value
 
 Source code can be found [here](https://cortexmetrics.io/)
 
-## Usage
-### Rules and AlertManager configuration
-Cortex can be configured to use a sidecar container in the Ruler and AlertManager to dynamically discover rules and AlertManager config/templates that are declared as ConfigMaps to allow easy and extensible configuration that avoids having to store state in the Cortex system itself (via config service, etc).
-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.
-This feature is disabled by default. Here is a simple example:
-
-```yaml
-ruler:
-  sidecar:
-    enabled: true
-    searchNamespace: cortex-rules
-
-alertmanager:
-  sidecar:
-    enabled: true
-    searchNamespace: cortex-alertmanager
-```
-And here are the related configuration values in AlertManager and Ruler:
-```yaml
-config:
-  alertmanager:
-    data_dir: /data/
-    storage:
-      type : local
-      local:
-        path: /data
-  ruler:
-    rule_path: /data/rules
-    storage:
-      type : local
-      local:
-        directory: /tmp/rules
-```
-In AlertManager, the data_dir and local storage directory should be the same.
-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).
-Example ConfigMap containing a rule:
-```yaml
-kind: ConfigMap
-metadata:
-  annotations:
-    k8s-sidecar-target-directory: /tmp/rules/fake
-  labels:
-    # Label cortex_rules must exist unless overridden by ruler.sidecar.label
-    cortex_rules: "1"
-  name: rules-cortex-9f99md47tc
-  namespace: cortex-rules
-apiVersion: v1
-data:
-  fake.yaml: |-
-    groups:
-      - name: fake-system-metrics
-        rules:
-          - alert: HighCPUusage
-            expr: avg(100 - rate(node_cpu_seconds_total{instance=~"qag1ge1l.+",mode="idle"}[5m]) * 100) by (instance) > 100
-            for: 3m
-            labels:
-              severity: warning
-            annotations:
-              description: Metrics from {{"{{ $labels.job }}"}} on {{"{{ $labels.instance }}"}} show CPU > 90% for 3m.
-              title: Node {{"{{ $labels.instance }}"}} has high CPU usage
-
-```
-Example ConfigMap containing an alertmanager-config:
-```yaml
-apiVersion: v1
-kind: ConfigMap
-metadata:
-  annotations:
-    k8s-sidecar-target-directory: /data/fake
-  labels:
-    cortex_alertmanager: "1"
-  name: alertmanager-example-config
-data:
-  fake.yaml: |-
-    global:
-      resolve_timeout: 5m
-      http_config: {}
-      smtp_hello: localhost
-      smtp_require_tls: true
-    route:
-      receiver: team-X-mails
-      group_by:
-      - alertname
-      routes:
-      - receiver: "null"
-        match:
-          alertname: Watchdog
-      group_wait: 30s
-      group_interval: 5m
-      repeat_interval: 12h
-    receivers:
-    - name: 'team-X-mails'
-      email_configs:
-      - to: '[email protected]'
-```
-
 {{ template "chart.requirementsSection" . }}
 
 

docs/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

docs/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

docs/Gemfile

@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+# gem "jekyll", "~> 4.2.0"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages","~> 219", group: :jekyll_plugins
+gem "just-the-docs"
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+