Skip to content

Commit

Permalink
Initial development doc (#14)
Browse files Browse the repository at this point in the history
* Initial development doc

* README.doc: fix overview
  • Loading branch information
eguzki authored May 18, 2021
1 parent 16ea55e commit 7488d49
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# kuadrant-controller
# kuadrant-controller

[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

## Overview
Kuadrant is a re-architecture of API Management using Cloud Native concepts and separating the components to be less coupled, more reusable and leverage the underlying platform.

## Contributing
The [Development guide](doc/development.md) describes how to build the kuadrant controller and how to test your changes before submitting a patch or opening a PR.

## Licensing

This software is licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).

See the LICENSE and NOTICE files that should have been provided along with this software for details.
37 changes: 37 additions & 0 deletions doc/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Development Guide

## Technology stack required for development

* [operator-sdk] version v1.16.1
* [kind] version v0.9.0
* [git][git_tool]
* [go] version 1.15+
* [kubernetes] version v1.19+
* [kubectl] version v1.19+

## Local setup

```
$ make local-setup
```

List of tasks done by the command above:

* Create local cluster using kind
* Build kuadrant docker image
* Deploy **ingress provider** (currently [Istio](https://istio.io))
* Deploy Kuadrant control plane
* Deploy EchoAPI

### Cleaning up

```
$ make local-cleanup
```

[git_tool]:https://git-scm.com/downloads
[operator-sdk]:https://github.com/operator-framework/operator-sdk
[go]:https://golang.org/
[kind]:https://kind.sigs.k8s.io/
[kubernetes]:https://kubernetes.io/
[kubectl]:https://kubernetes.io/docs/tasks/tools/#kubectl

0 comments on commit 7488d49

Please sign in to comment.