-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
rename kusk references to kusk-gen in README (#209)
- Loading branch information
Kyle Hodgetts
authored
Apr 19, 2022
1 parent
4379d3f
commit 88bbff2
Showing
1 changed file
with
21 additions
and
21 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,41 +1,41 @@ | ||
| # Kusk - use OpenAPI to configure Kubernetes | ||
| # kusk-gen - use OpenAPI to configure Kubernetes | ||
|
|
||
| [](https://snyk.io/test/github/kubeshop/kusk) | ||
| [](https://snyk.io/test/github/kubeshop/kusk-gen) | ||
|
|
||
| ## What is Kusk? | ||
| ## What is kusk-gen? | ||
|
|
||
| Developers deploying their REST APIs in Kubernetes shouldn't have to worry about managing resources that do not directly | ||
| relate to their applications or services. | ||
|
|
||
| Kusk (_coachman in Swedish_) treats your OpenAPI/Swagger definition as a source of truth for generating | ||
| kusk-gen (_coachman in Swedish_) treats your OpenAPI/Swagger definition as a source of truth for generating | ||
| supplementary Kubernetes resources for your REST APIs in regard to mappings, security, traffic-control, monitoring, etc. | ||
|
|
||
| Read the [Introductory blog-post](https://medium.com/kubeshop-i/hello-kusk-openapi-for-kubernetes-19be94fc1e91) to get an overview. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ### Homebrew | ||
| `brew install kubeshop/kusk/kusk` | ||
| `brew install kubeshop/kusk/kusk-gen` | ||
|
|
||
| ### Latest release on Github | ||
| `go install github.com/kubeshop/kusk-gen@$VERSION` | ||
|
|
||
| If you don't want to build it yourself, the [Releases](https://github.com/kubeshop/kusk-gen/releases) page contains already built binaries for all supported platforms. | ||
|
|
||
| Download it and unpack *kusk* to the directory of you choice. | ||
| Download it and unpack *kusk-gen* to the directory of you choice. | ||
|
|
||
| ### From source | ||
| ```shell | ||
| git clone [email protected]:kubeshop/kusk.git && \ | ||
| cd kusk && \ | ||
| git clone [email protected]:kubeshop/kusk-gen.git && \ | ||
| cd kusk-gen && \ | ||
| go install | ||
| ``` | ||
|
|
||
| Read more at [Getting Started](https://kubeshop.github.io/kusk/getting-started/) | ||
| Read more at [Getting Started](https://kubeshop.github.io/kusk-gen/getting-started/) | ||
|
|
||
| ## Why Kusk? | ||
| ## Why kusk-gen? | ||
|
|
||
| Using OpenAPI as the source-for-truth for client, servers, testing, documentation, etc. is a common approach when | ||
| building microservice architectures with REST APis. Kusk extends this paradigm to also include Kubernetes configurations, | ||
|
|
@@ -46,27 +46,27 @@ allowing you to | |
|
|
||
| ## Features | ||
|
|
||
| - Kusk can inspect your cluster for the tools it supports and generate corresponding resources automatically. | ||
| - kusk-gen can inspect your cluster for the tools it supports and generate corresponding resources automatically. | ||
| - the Kusk [OpenAPI Extension](https://kubeshop.github.io/kusk/openapi-extension/) allows you to specify extended QoS and k8s related metadata which will be used | ||
| to configure your cluster accordingly. | ||
| - Kusk plays nicely with both manual and automated/GitOps/CD workflows. | ||
| - The underlying architecture makes it straight-forward to extend Kusk with new generators | ||
| - kusk-gen plays nicely with both manual and automated/GitOps/CD workflows. | ||
| - The underlying architecture makes it straight-forward to extend kusk-gen with new generators | ||
|
|
||
| Kusk currently supports (click for configuration options) | ||
| - [Ambassador 1.x](https://kubeshop.github.io/kusk/ambassador/) | ||
| - [Ambassador 2.0](https://kubeshop.github.io/kusk/ambassador2/) | ||
| kusk-gen currently supports (click for configuration options) | ||
| - [Ambassador 1.x](https://kubeshop.github.io/kusk-gen/ambassador/) | ||
| - [Ambassador 2.0](https://kubeshop.github.io/kusk-gen/ambassador2/) | ||
| - **Warning** This is a developer preview and should be treated as unstable | ||
| - [Linkerd](https://kubeshop.github.io/kusk/linkerd/) | ||
| - [Ingress-Nginx](https://kubeshop.github.io/kusk/ingress-nginx/) | ||
| - [Linkerd](https://kubeshop.github.io/kusk-gen/linkerd/) | ||
| - [Ingress-Nginx](https://kubeshop.github.io/kusk-gen/ingress-nginx/) | ||
| - This generator refers to the community ingress from [Kubernetes ingress-nginx](https://github.com/kubernetes/ingress-nginx/) | ||
| - [Traefik V2 (v2.x)](https://kubeshop.github.io/kusk/traefik/) | ||
| - [Traefik V2 (v2.x)](https://kubeshop.github.io/kusk-gen/traefik/) | ||
|
|
||
| Some of the upcoming tools we'd like to support are Kong and Contour. Please don't hesitate to | ||
| suggest others or contribute your own generator! | ||
|
|
||
| ## Documentation & Support | ||
|
|
||
| To learn more about Kusk check out the [complete documentation](https://kubeshop.github.io/kusk/) | ||
| To learn more about kusk-gen check out the [complete documentation](https://kubeshop.github.io/kusk-gen/) | ||
|
|
||
| Join our [Discord Server](https://discord.gg/uNuhy6GDyn) to ask questions, suggest ideas, etc. | ||
|
|
||
|
|
||