-
Notifications
You must be signed in to change notification settings - Fork 169
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reworks the README to make it a bit more catchy, also adds our new Logo!!
- Loading branch information
Showing
3 changed files
with
70 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,72 @@ | ||
# Grafana Tanka | ||
<p align="center"> | ||
<img | ||
width="400" | ||
src="https://raw.githubusercontent.com/grafana/tanka/master/docs/img/logo.svg" | ||
alt="Grafana Tanka Logo" | ||
/> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://cloud.drone.io/grafana/tanka"> | ||
<img src="https://img.shields.io/drone/build/grafana/tanka?style=flat-square"> | ||
</a> | ||
<a href="https://github.com/grafana/tanka/releases"> | ||
<img src="https://img.shields.io/github/release/grafana/tanka?style=flat-square" /> | ||
</a> | ||
<img src="https://img.shields.io/github/contributors/grafana/tanka?style=flat-square" /> | ||
<a href="https://grafana.slack.com"> | ||
<img src="https://img.shields.io/badge/Slack-GrafanaLabs-orange?logo=slack&style=flat-square" /> | ||
</a> | ||
</p> | ||
|
||
![Tanka Banner](docs/img/banner.png) | ||
<p align="center"> | ||
<a href="https://tanka.dev">Website</a> | ||
· | ||
<a href="https://tanka.dev/install">Installation</a> | ||
· | ||
<a href="https://tanka.dev/tutorial/overview">Tutorial</a> | ||
</p> | ||
|
||
[![Build Status](https://cloud.drone.io/api/badges/grafana/tanka/status.svg)](https://cloud.drone.io/grafana/tanka) | ||
![Golang](https://img.shields.io/badge/language-Go-blue) | ||
![GitHub contributors](https://img.shields.io/github/contributors/grafana/tanka) | ||
![GitHub release](https://img.shields.io/github/release/grafana/tanka) | ||
![License](https://img.shields.io/github/license/grafana/tanka) | ||
# Grafana Tanka | ||
|
||
Tanka is a composable configuration utility for | ||
[Kubernetes](https://kubernetes.io/). It leverages the | ||
[Jsonnet](https://jsonnet.org) language to realize flexible, reusable and | ||
concise configuration. | ||
<img | ||
src="https://raw.githubusercontent.com/grafana/tanka/logo/master/img/example.png" | ||
width="50%" | ||
align="right" | ||
/> | ||
|
||
## Highlights | ||
**The clean, concise and super flexible alternative to YAML for your | ||
[Kubernetes](https://k8s.io) cluster** | ||
|
||
- **:wrench: Flexible**: The | ||
[Jsonnet data templating language](https://jsonnet.org) gives us much smarter | ||
ways to express our Kubernetes configuration than YAML does. | ||
- **:books: Reusable**: Code can be refactored into libraries, they can be | ||
imported wherever you like and even shared on GitHub! | ||
- **:boom: Clean**: The | ||
[Jsonnet language](https://jsonnet.org) expresses your apps more obviously than YAML ever did | ||
- **:books: Reusable**: Build libraries, import them anytime and even share them on GitHub! | ||
- **:pushpin: Concise**: Using the Kubernetes library and abstraction, you will | ||
never see boilerplate again! | ||
- **:dart: Work with confidence**: `tk diff` allows to check all changes before | ||
they will be applied and `tk apply` makes sure you always select the correct | ||
cluster. Stop guessing and make sure it's all good. | ||
- **:rocket: Used in production**: While still a very young project, Tanka is | ||
used internally at Grafana Labs for all of their Kubernetes configuration needs. | ||
- **:heart: Fully open source**: This is an open-source project. It is free as | ||
in beer and as in speech and this will never change. | ||
- **:dart: Confidence**: Stop guessing and use `tk diff` to see what exactly will happen | ||
- **:rocket: Production ready**: Tanka deploys [Grafana Cloud](https://grafana.com/cloud) and many more production setups | ||
|
||
## Getting started | ||
<br /> | ||
<p align="center"> | ||
<a href="https://tanka.dev/tutorial/overview"><strong>Let's kill some YAML together ▶</strong></a> | ||
</p> | ||
|
||
## :rocket: Getting started | ||
|
||
To get started, [install Tanka](https://tanka.dev/install) first, and then | ||
[follow the tutorial](https://tanka.dev/tutorial/overview). This should get you | ||
on track quickly. | ||
|
||
## Additional resources | ||
## :book: Additional resources | ||
|
||
- https://jsonnet.org/, the official Jsonnet documentation provides lots of | ||
examples on how to use the language. | ||
- https://github.com/grafana/jsonnet-libs: Grafana Labs' Jsonnet libraries are a | ||
rich set of configuration examples compatible with Tanka. | ||
|
||
## License | ||
## :pencil: License | ||
|
||
Tanka is an open-source project :heart:. It is free as | ||
in beer and as in speech and this will never change. | ||
|
||
Licensed Apache 2.0, see [LICENSE](LICENSE). | ||
Licensed under Apache 2.0, see [LICENSE](LICENSE). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.