Merge pull request #1513 from Obmondo/docfix-install
This commit is contained in:
14
README.md
14
README.md
@@ -97,7 +97,7 @@ The following versions are supported and work as we test against these versions
|
|||||||
| [`release-0.7`](https://github.com/prometheus-operator/kube-prometheus/tree/release-0.7) | ✗ | ✔ | ✔ | ✗ | ✗ |
|
| [`release-0.7`](https://github.com/prometheus-operator/kube-prometheus/tree/release-0.7) | ✗ | ✔ | ✔ | ✗ | ✗ |
|
||||||
| [`release-0.8`](https://github.com/prometheus-operator/kube-prometheus/tree/release-0.8) | ✗ | ✗ | ✔ | ✔ | ✗ |
|
| [`release-0.8`](https://github.com/prometheus-operator/kube-prometheus/tree/release-0.8) | ✗ | ✗ | ✔ | ✔ | ✗ |
|
||||||
| [`release-0.9`](https://github.com/prometheus-operator/kube-prometheus/tree/release-0.9) | ✗ | ✗ | ✗ | ✔ | ✔ |
|
| [`release-0.9`](https://github.com/prometheus-operator/kube-prometheus/tree/release-0.9) | ✗ | ✗ | ✗ | ✔ | ✔ |
|
||||||
| [`HEAD`](https://github.com/prometheus-operator/kube-prometheus/tree/main) | ✗ | ✗ | ✗ | ✔ | ✔ |
|
| [`main`](https://github.com/prometheus-operator/kube-prometheus/tree/main) | ✗ | ✗ | ✗ | ✔ | ✔ |
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
@@ -172,15 +172,15 @@ Install this library in your own project with [jsonnet-bundler](https://github.c
|
|||||||
$ mkdir my-kube-prometheus; cd my-kube-prometheus
|
$ mkdir my-kube-prometheus; cd my-kube-prometheus
|
||||||
$ jb init # Creates the initial/empty `jsonnetfile.json`
|
$ jb init # Creates the initial/empty `jsonnetfile.json`
|
||||||
# Install the kube-prometheus dependency
|
# Install the kube-prometheus dependency
|
||||||
$ jb install github.com/prometheus-operator/kube-prometheus/jsonnet/kube-prometheus@release-0.9 # Creates `vendor/` & `jsonnetfile.lock.json`, and fills in `jsonnetfile.json`
|
$ jb install github.com/prometheus-operator/kube-prometheus/jsonnet/kube-prometheus@main # Creates `vendor/` & `jsonnetfile.lock.json`, and fills in `jsonnetfile.json`
|
||||||
|
|
||||||
$ wget https://raw.githubusercontent.com/prometheus-operator/kube-prometheus/release-0.9/example.jsonnet -O example.jsonnet
|
$ wget https://raw.githubusercontent.com/prometheus-operator/kube-prometheus/main/example.jsonnet -O example.jsonnet
|
||||||
$ wget https://raw.githubusercontent.com/prometheus-operator/kube-prometheus/release-0.9/build.sh -O build.sh
|
$ wget https://raw.githubusercontent.com/prometheus-operator/kube-prometheus/main/build.sh -O build.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
> `jb` can be installed with `go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb`
|
> `jb` can be installed with `go install -a github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest`
|
||||||
|
|
||||||
> An e.g. of how to install a given version of this library: `jb install github.com/prometheus-operator/kube-prometheus/jsonnet/kube-prometheus@release-0.9`
|
> An e.g. of how to install a given version of this library: `jb install github.com/prometheus-operator/kube-prometheus/jsonnet/kube-prometheus@main`
|
||||||
|
|
||||||
In order to update the kube-prometheus dependency, simply use the jsonnet-bundler update functionality:
|
In order to update the kube-prometheus dependency, simply use the jsonnet-bundler update functionality:
|
||||||
|
|
||||||
@@ -192,7 +192,7 @@ $ jb update
|
|||||||
|
|
||||||
e.g. of how to compile the manifests: `./build.sh example.jsonnet`
|
e.g. of how to compile the manifests: `./build.sh example.jsonnet`
|
||||||
|
|
||||||
> before compiling, install `gojsontoyaml` tool with `go get github.com/brancz/gojsontoyaml` and `jsonnet` with `go get github.com/google/go-jsonnet/cmd/jsonnet`
|
> before compiling, install `gojsontoyaml` tool with `go install github.com/brancz/gojsontoyaml@latest` and `jsonnet` with `go install github.com/google/go-jsonnet/cmd/jsonnet@latest`
|
||||||
|
|
||||||
Here's [example.jsonnet](example.jsonnet):
|
Here's [example.jsonnet](example.jsonnet):
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user