Updated instructions to use tanka with this repo (#3)

Signed-off-by: Friedrich Gonzalez <[email protected]>

Author: friedrichg

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## master / unreleased
 
+* [CHANGE] Updated readme to use this repo with tanka
+
 ## 1.11.0 / 2021-12-30
 
 * [CHANGE] Store gateway: set `-blocks-storage.bucket-store.index-cache.memcached.max-get-multi-concurrency`,

README.md

@@ -2,6 +2,13 @@
 
 This repo has the jsonnet for deploying Cortex and the related monitoring in Kubernetes.
 
+---
+**NOTE**
+
+If you are more familiar with helm you should use the [helm chart](https://cortexproject.github.io/cortex-helm-chart/) for cortex
+
+---
+
 To generate the YAMLs for deploying Cortex:
 
 1. Make sure you have tanka and jb installed:
@@ -10,25 +17,19 @@ To generate the YAMLs for deploying Cortex:
 
     ```console
     $ # make sure to be outside of GOPATH or a go.mod project
-    $ GO111MODULE=on go get github.com/grafana/tanka/cmd/tk
-    $ GO111MODULE=on go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
+    $ GO111MODULE=on go install github.com/grafana/tanka/cmd/tk@v0.21.0
+    $ GO111MODULE=on go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@v0.4.0
     ```
 
-1. Initialise the Tanka, and install the Cortex and Kubernetes Jsonnet libraries.
+1. Initialise the Tanka repo, install the Cortex and Kubernetes Jsonnet libraries.
 
     ```console
     $ mkdir <name> && cd <name>
-    $ tk init --k8s=false
-    $ # The k8s-alpha library supports Kubernetes versions 1.14+
-    $ jb install github.com/jsonnet-libs/k8s-alpha/1.18
-    $ cat <<EOF > lib/k.libsonnet
-      (import "github.com/jsonnet-libs/k8s-alpha/1.18/main.libsonnet")
-      + (import "github.com/jsonnet-libs/k8s-alpha/1.18/extensions/kausal-shim.libsonnet")
-      EOF
-    $ jb install github.com/grafana/cortex-jsonnet/cortex@main
+    $ tk init --k8s=1.21 # this includes github.com/jsonnet-libs/k8s-libsonnet/1.21@main
+    $ jb install github.com/cortexproject/cortex-jsonnet/cortex@main
     ```
 
-1. Use the example monitoring.jsonnet.example:
+1. Use the example cortex-manifests.jsonnet.example:
 
     ```console
     $ cp vendor/cortex/cortex-manifests.jsonnet.example environments/default/main.jsonnet
@@ -58,13 +59,11 @@ To generate the YAMLs for deploying Cortex:
 To generate the Grafana dashboards and Prometheus alerts for Cortex:
 
 ```console
-$ GO111MODULE=on go get github.com/monitoring-mixins/mixtool/cmd/mixtool
-$ GO111MODULE=on go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
-$ git clone https://github.com/grafana/cortex-jsonnet
+$ GO111MODULE=on go install github.com/monitoring-mixins/mixtool/cmd/mixtool@2ff523ea63d1cdeee2a10e01d1d48d20adcc7030
+$ GO111MODULE=on go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@v0.4.0
+$ git clone https://github.com/cortexproject/cortex-jsonnet
 $ cd cortex-jsonnet
 $ make build-mixin
 ```
 
 This will leave all the alerts and dashboards in cortex-mixin/cortex-mixin.zip (or cortex-mixin/out).
-
-If you get an error like `cannot use cli.StringSliceFlag literal (type cli.StringSliceFlag) as type cli.Flag in slice literal` when installing [mixtool](https://github.com/monitoring-mixins/mixtool/issues/27), make sure you set `GO111MODULE=on` before `go get`.