Skip to content

Commit b0ac513

Browse files
malcolmholmesmalcolmholmes
authored
Merge pull request #289 from grafana/remove-ksonnet-references
Remove ksonnet references
2 parents 9083a44 + acf50ce commit b0ac513

File tree

6 files changed

+38
-61
lines changed

6 files changed

+38
-61
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ This repository contains various Jsonnet libraries we use at Grafana Labs:
88
* [`grafana-builder`](grafana-builder/): A library for building Grafana dashboards
99
with jsonnet, following the builder pattern.
1010

11-
* [`ksonnet-util`](ksonnet-util/): An overlay and set of utilities for [ksonnet](https://ksonnet.io/)
12-
that makes working with the library easier.
11+
* [`ksonnet-util`](ksonnet-util/): An overlay and set of utilities aiming at making
12+
working with Kubernetes easier.
1313

1414
* [`memcached-mixin`](memcached-mixin/): A set of reuseable and extensible dashboards
1515
for Memcached.
1616

17-
* [`oauth2-proxy`](oauth2-proxy/): A ksonnet configuration for deploying bitly's
17+
* [`oauth2-proxy`](oauth2-proxy/): A jsonnet configuration for deploying bitly's
1818
OAuth proxy to Kubernetes.
1919

2020
* [`prometheus-ksonnet`](prometheus-ksonnet/): A set of extensible configurations

‎consul-mixin/README.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@ Grafana dashboards and Prometheus alerts for operating Consul, in the form
66
of a monitoring mixin. They are easiest to use with the [prometheus-ksonnet](https://github.com/grafana/jsonnet-libs/tree/master/prometheus-ksonnet)
77
package.
88

9-
To install this mixin, use [ksonnet](https://ksonnet.io/):
9+
To use this mixin, install [Tanka](https://tanka.dev/) and [Jsonnet Bundler](https://tanka.dev/install#jsonnet-bundler).
1010

11-
```sh
12-
$ go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
13-
$ jb install github.com/grafana/jsonnet-libs/consul-mixin
11+
Then you can install the mixin with:
12+
13+
```
14+
jb install github.com/grafana/jsonnet-libs/consul-mixin
1415
```
1516

16-
Then to use, in your environment's `main.jsonnet` file:
17+
To use, in your Tanka environment's `main.jsonnet` file:
1718

18-
```js
19+
```jsonnet
1920
local prometheus = (import "prometheus-ksonnet/prometheus-ksonnet.libsonnet");
2021
local consul_mixin = (import "consul-mixin/mixin.libsonnet");
2122

‎consul/README.md‎

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,24 @@
1-
# Consul Ksonnet
1+
# Consul Jsonnet
22

33
A set of extensible configs for running Consul on Kubernetes.
44

5-
Usage:
6-
- Make sure you have the [ksonnet v0.8.0](https://github.com/ksonnet/ksonnet).
5+
To use this libary, install [Tanka](https://tanka.dev/) and [Jsonnet Bundler](https://tanka.dev/install#jsonnet-bundler).
76

8-
```
9-
$ brew install https://raw.githubusercontent.com/ksonnet/homebrew-tap/82ef24cb7b454d1857db40e38671426c18cd8820/ks.rb
10-
$ brew pin ks
11-
$ ks version
12-
ksonnet version: v0.8.0
13-
jsonnet version: v0.9.5
14-
client-go version: v1.6.8-beta.0+$Format:%h$
15-
```
16-
17-
- In your config repo, if you don't have a ksonnet application, make a new one (will copy credentials from current context):
7+
In your config repo, if you don't have a Tanka application, make a new one (will copy credentials from current context):
188

199
```
20-
$ ks init <application name>
10+
$ mkdir <application name>
2111
$ cd <application name>
12+
$ tk init
2213
```
2314

24-
- Vendor this package using [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler)
15+
Then you can install the library with:
2516

2617
```
27-
$ go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
28-
$ jb install https://github.com/grafana/jsonnet-libs/consul
18+
jb install github.com/grafana/jsonnet-libs/consul
2919
```
3020

31-
- Assuming you want to run in the default namespace ('environment' in ksonnet parlance), add the following to the file `environments/default/main.jsonnet`:
21+
- Assuming you want to run in the default namespace ('environment' in Tanka parlance), add the following to the file `environments/default/main.jsonnet`:
3222

3323
```
3424
local consul = import "consul/consul.libsonnet";
@@ -43,11 +33,11 @@ consul + {
4333
- Apply your config:
4434

4535
```
46-
$ ks apply default
36+
$ tk apply default
4737
```
4838
# Customising and Extending.
4939

50-
The choice of Ksonnet for configuring these jobs was intention; it allows users
40+
The choice of Tanka for configuring these jobs was intentional; it allows users
5141
to easily override setting in these configurations to suit their needs, without having
5242
to fork or modify this library. For instance, to override the resource requests
5343
and limits for the Consul container, you would:

‎memcached-mixin/README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ Grafana dashboard for operating Memcached, in the form
66
of a monitoring mixin. They are easiest to use with the [prometheus-ksonnet](https://github.com/grafana/jsonnet-libs/tree/master/prometheus-ksonnet)
77
package.
88

9-
To install this mixin, use [ksonnet](https://ksonnet.io/):
9+
To use this mixin, install [Tanka](https://tanka.dev/) and [Jsonnet Bundler](https://tanka.dev/install#jsonnet-bundler).
1010

11-
```sh
12-
$ go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
13-
$ jb install github.com/grafana/jsonnet-libs/memcached-mixin
11+
Then you can install the mixin with:
12+
13+
```
14+
jb install github.com/grafana/jsonnet-libs/memcached-mixin
1415
```
1516

16-
Then to use, in your environment's `main.jsonnet` file:
17+
To use, in your Tanka environment's `main.jsonnet` file:
1718

1819
```js
1920
local prometheus = (import "prometheus-ksonnet/prometheus-ksonnet.libsonnet");

‎memcached/README.md‎

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,24 @@
1-
# Memcached Ksonnet
1+
# Memcached Jsonnet
22

33
A set of extensible configs for running Memcached on Kubernetes.
44

5-
Usage:
6-
- Make sure you have the [ksonnet v0.8.0](https://github.com/ksonnet/ksonnet).
5+
To use this libary, install [Tanka](https://tanka.dev/) and [Jsonnet Bundler](https://tanka.dev/install#jsonnet-bundler).
76

8-
```
9-
$ brew install https://raw.githubusercontent.com/ksonnet/homebrew-tap/82ef24cb7b454d1857db40e38671426c18cd8820/ks.rb
10-
$ brew pin ks
11-
$ ks version
12-
ksonnet version: v0.8.0
13-
jsonnet version: v0.9.5
14-
client-go version: v1.6.8-beta.0+$Format:%h$
15-
```
16-
17-
- In your config repo, if you don't have a ksonnet application, make a new one (will copy credentials from current context):
7+
In your config repo, if you don't have a Tanka application, make a new one (will copy credentials from current context):
188

199
```
20-
$ ks init <application name>
10+
$ mkdir <application name>
2111
$ cd <application name>
12+
$ tk init
2213
```
2314

24-
- Vendor this package using [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler)
15+
Then you can install the library with:
2516

2617
```
27-
$ go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
28-
$ jb install https://github.com/grafana/jsonnet-libs/memcached
18+
jb install github.com/grafana/jsonnet-libs/memcached
2919
```
3020

31-
- Assuming you want to run in the default namespace ('environment' in ksonnet parlance), add the following to the file `environments/default/main.jsonnet`:
21+
Assuming you want to run in the default namespace ('environment' in Tanka parlance), add the following to the file `environments/default/main.jsonnet`:
3222

3323
```
3424
local memcached = import "memcached/memcached.libsonnet";
@@ -46,11 +36,11 @@ memcached + {
4636
- Apply your config:
4737

4838
```
49-
$ ks apply default
39+
$ tk apply default
5040
```
5141
# Customising and Extending.
5242

53-
The choice of Ksonnet for configuring these jobs was intention; it allows users
43+
The choice of Tanka for configuring these jobs was intentional; it allows users
5444
to easily override setting in these configurations to suit their needs, without having
5545
to fork or modify this library. For instance, to override the resource requests
5646
and limits for the Consul container, you would:

‎prometheus-ksonnet/README.md‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,7 @@ A set of extensible configs for running Prometheus on Kubernetes.
44

55
Usage:
66
- Make sure you have [Tanka](https://tanka.dev/install) and
7-
[jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler) installed:
8-
9-
```bash
10-
$ GO111MODULE=on go get github.com/grafana/tanka/cmd/tk
11-
$ GO111MODULE=on go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
12-
```
7+
[jsonnet-bundler](https://tanka.dev/install#jsonnet-bundler) installed:
138

149
- In your config repo, init Tanka and point it at your Kubernetes cluster:
1510

@@ -27,7 +22,7 @@ $ tk env set environments/default --server-from-context=$CONTEXT
2722
$ jb install github.com/grafana/jsonnet-libs/prometheus-ksonnet
2823
```
2924

30-
- Assuming you want to run in the default namespace ('environment' in ksonnet parlance), add the following to the file `environments/default/main.jsonnet`:
25+
- Assuming you want to run in the default namespace ('environment' in Tanka parlance), add the following to the file `environments/default/main.jsonnet`:
3126

3227
```jsonnet
3328
local prometheus = import "prometheus-ksonnet/prometheus-ksonnet.libsonnet";

0 commit comments

Comments
 (0)