-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
02112e7
commit a110705
Showing
1 changed file
with
9 additions
and
32 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,39 +1,16 @@ | ||
![qbec](site/static/images/qbec-logo-black.svg) | ||
# envoy-jsonnet | ||
|
||
[![Github build status](https://github.com/splunk/qbec/workflows/build/badge.svg)](https://github.com/splunk/qbec/actions) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/splunk/qbec)](https://goreportcard.com/report/github.com/splunk/qbec) | ||
[![codecov](https://codecov.io/gh/splunk/qbec/branch/main/graph/badge.svg)](https://codecov.io/gh/splunk/qbec) | ||
[![GolangCI](https://golangci.com/badges/github.com/splunk/qbec.svg)](https://golangci.com/r/github.com/splunk/qbec) | ||
This repo publishes jsonnet bindings for [envoyproxy](https://envoyproxy.io/) config. | ||
|
||
## Regenerate | ||
|
||
[![Build Stats](https://buildstats.info/github/chart/splunk/qbec?branch=main)](https://buildstats.info/github/chart/splunk/qbec?branch=main) | ||
|
||
|
||
Qbec (pronounced like the [Canadian province](https://en.wikipedia.org/wiki/Quebec)) is a CLI tool that | ||
allows you to create Kubernetes objects on multiple Kubernetes clusters or namespaces configured correctly for | ||
the target environment in question. | ||
|
||
It is based on [jsonnet](https://jsonnet.org) and is similar to other tools in the same space like | ||
[kubecfg](https://github.com/ksonnet/kubecfg) and [ksonnet](https://ksonnet.io/). | ||
|
||
For more info, [read the docs](https://qbec.io/) | ||
|
||
### Installing | ||
```bash | ||
make gen | ||
``` | ||
|
||
Use a prebuilt binary [from the releases page](https://github.com/splunk/qbec/releases) for your operating system. | ||
## Setup | ||
|
||
On MacOS, you can install qbec using homebrew: | ||
Install [protoc](https://grpc.io/docs/protoc-installation/) and [protobuf-jsonnet](https://github.com/splunk/protobuf-jsonnet/). | ||
|
||
``` | ||
$ brew tap splunk/tap | ||
$ brew install qbec | ||
``` | ||
Library docs are published [here](https://harsimranmaan.github.io/envoy-jsonnet/). | ||
|
||
### Building from source | ||
|
||
```shell | ||
git clone [email protected]:splunk/qbec | ||
cd qbec | ||
make install # installs lint tools etc. | ||
make | ||
``` |