Skip to content

Commit

Permalink
chore: CNCF donation
Browse files Browse the repository at this point in the history
  • Loading branch information
subnetmarco committed Jul 12, 2020
1 parent 9c69ace commit 6cef263
Show file tree
Hide file tree
Showing 7 changed files with 90 additions and 20 deletions.
52 changes: 52 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Kuma Governance

This document defines governance policies for the Kuma project.

## Maintainers

Kuma Maintainers have write access to the Kuma Demo GitHub repository https://github.com/kumahq/kuma-demo.
They can merge their own patches or patches from others. The current maintainers can be found in [CODEOWNERS](./CODEOWNERS).

This privilege is granted with some expectation of responsibility: maintainers are people who care about the Kuma project and want to help it grow and improve. A maintainer is not just someone who can make changes, but someone who has demonstrated his or her ability to collaborate with the team, get the most knowledgeable people to review code, contribute high-quality code, and follow through to fix issues (in code or tests).

A maintainer is a contributor to the Kuma project's success and a citizen helping the project succeed.

## Becoming a Maintainer

To become a maintainer you need to demonstrate the following:

* commitment to the project
* participate in discussions, contributions, code reviews for 3 months or more,
* perform code reviews for 10 non-trivial pull requests,
* contribute 10 non-trivial pull requests and have them merged into master,
* ability to write good code,
* ability to collaborate with the team,
* understanding of how the team works (policies, processes for testing and code review, etc),
* understanding of the project's code base and coding style.

A new maintainer must be proposed by an existing maintainer by opening an issue (with title `Maintainer Nomination`) to the Kuma Github repository (https://github.com/kumahq/kuma) containing the following information:

* nominee's first and last name,
* nominee's email address and GitHub user name,
* an explanation of why the nominee should be a committer,
* a list of links to non-trivial pull requests (top 10) authored by the nominee.

Two other maintainers need to second the nomination. If no one objects in 5 working days (U.S.), the nomination is accepted. If anyone objects or wants more information, the maintainers discuss and usually come to a consensus (within the 5 working days). If issues can't be resolved, there's a simple majority vote among current maintainers.

## Changes in Maintainership

Maintainers can be removed by a 2/3 majority vote by maintainers.

## GitHub Project Administration

Maintainers will be added to the GitHub @Kong/kuma-maintainers team, and made a GitHub maintainer of that team.
They will be given write permission to the Kuma Demo GitHub repository https://github.com/kumahq/kuma-demo.

## Changes in Governance

All changes in Governance require a 2/3 majority vote by maintainers.

## Other Changes

Unless specified above, all other changes to the project require a 2/3 majority vote by maintainers.
Additionally, any maintainer may request that any change require a 2/3 majority vote by maintainers.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

[![][kuma-logo]][kuma-url]

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/Kong/kuma-demo/blob/master/LICENSE)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/kumahq/kuma-demo/blob/master/LICENSE)
[![Twitter](https://img.shields.io/twitter/follow/thekonginc.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=thekonginc)

Kuma is a universal open source control-plane for Service Mesh and Microservices that can run and be operated natively across both Kubernetes and VM environments, in order to be easily adopted by every team in the organization.

This repository houses the demo application used to illustrate Kuma's extensive features. To find the source of Kuma, please check out Kuma's [repository](https://github.com/Kong/kuma).
This repository houses the demo application used to illustrate Kuma's extensive features. To find the source of Kuma, please check out Kuma's [repository](https://github.com/kumahq/kuma).

## Table of contents
- [Kuma Demo Application](#kuma-demo-application)
Expand Down Expand Up @@ -105,6 +105,24 @@ All this information will be saved in PostgreSQL **EXCEPT** the reviews. Reviews

The Redis database is used to store all the items' reviews. The list of reviews for each item can be found in this [JSON file](api/db/items.json).

## License

```
Copyright 2020 the Kuma Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

[kuma-url]: https://kuma.io/
[kuma-logo]: https://kuma-public-assets.s3.amazonaws.com/kuma-logo-v2.png
[diagram]: https://github.com/Kong/kuma-website/blob/master/docs/.vuepress/public/images/diagrams/diagram-kuma-demo-basic.jpg?raw=true
[diagram]: https://github.com/kumahq/kuma-website/blob/master/docs/.vuepress/public/images/diagrams/diagram-kuma-demo-basic.jpg?raw=true
10 changes: 5 additions & 5 deletions kind/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ default redis-master-78ff699f7-4v579.kuma-demo app=redis pod-templat
Kuma GUI is available at printf http://localhost:5683/ ⬅️
Kuma DEMO is available at http://localhost:8080/ ⬅️

For more about Integrations and Metrics see https://github.com/Kong/kuma-demo/tree/master/kubernetes#integrations
For more about Integrations and Metrics see https://github.com/kumahq/kuma-demo/tree/master/kubernetes#integrations

To see Kuma in action, follow the Policies guidelines https://github.com/Kong/kuma-demo/tree/master/kubernetes#policies
To see Kuma in action, follow the Policies guidelines https://github.com/kumahq/kuma-demo/tree/master/kubernetes#policies

🛑 Before using kubectl, please run the following in your shell:

Expand All @@ -98,17 +98,17 @@ export KUBECONFIG=/Users/nickolaev/.kube/kind-kuma-config
Type 'quit' to exit.
```

As the message states, the Demo site can be found at [http://localhost:8080](http://locahost:8080) and the Kuma GUI at [http://localhost:5683](http://locahost:5683). You can also use `kubectl` and `${HOME}/bin/kumactl` to explore the deployment and configuration following the [integration](https://github.com/Kong/kuma-demo/tree/master/kubernetes#integrations) and [policies](https://github.com/Kong/kuma-demo/tree/master/kubernetes#policies) guides.
As the message states, the Demo site can be found at [http://localhost:8080](http://locahost:8080) and the Kuma GUI at [http://localhost:5683](http://locahost:5683). You can also use `kubectl` and `${HOME}/bin/kumactl` to explore the deployment and configuration following the [integration](https://github.com/kumahq/kuma-demo/tree/master/kubernetes#integrations) and [policies](https://github.com/kumahq/kuma-demo/tree/master/kubernetes#policies) guides.

After you're done poking around you should type `quit` to exit the demo and cleanup the created cluster:

```shell script
Kuma GUI is available at printf http://localhost:5683/ ⬅️
Kuma DEMO is available at http://localhost:8080/ ⬅️

For more about Integrations and Metrics see https://github.com/Kong/kuma-demo/tree/master/kubernetes#integrations
For more about Integrations and Metrics see https://github.com/kumahq/kuma-demo/tree/master/kubernetes#integrations

To see Kuma in action, follow the Policies guidelines https://github.com/Kong/kuma-demo/tree/master/kubernetes#policies
To see Kuma in action, follow the Policies guidelines https://github.com/kumahq/kuma-demo/tree/master/kubernetes#policies

🛑 Before using kubectl, please run the following in your shell:

Expand Down
4 changes: 2 additions & 2 deletions kind/kind.sh
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,9 @@ echo
printf "Kuma GUI is available at \033[0;33mhttp://localhost:5683/\033[0m ⬅️\n"
printf "Kuma DEMO is available at \033[0;33mhttp://localhost:8080/\033[0m ⬅️\n"
echo
printf "For more about Integrations and Metrics see \033[0;33mhttps://github.com/Kong/kuma-demo/tree/master/kubernetes#integrations\033[0m\n"
printf "For more about Integrations and Metrics see \033[0;33mhttps://github.com/kumahq/kuma-demo/tree/master/kubernetes#integrations\033[0m\n"
echo
printf "To see Kuma in action, follow the Policies guidelines \033[0;33mhttps://github.com/Kong/kuma-demo/tree/master/kubernetes#policies\033[0m\n"
printf "To see Kuma in action, follow the Policies guidelines \033[0;33mhttps://github.com/kumahq/kuma-demo/tree/master/kubernetes#policies\033[0m\n"
echo
echo "🛑 Before using kubectl, please run the following in your shell:"
echo
Expand Down
12 changes: 6 additions & 6 deletions kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ When running on Kubernetes, Kuma will store all of its state and configuration o

### Kind
The top-level folder `kind` contains a convenient script [kind.sh](../kind/kind.sh), which will automatically deploy a simple Kubernetes cluster on top of docker using [KIND](https://kind.sigs.k8s.io/docs/user/quick-start/).
It will also deploy [Kuma](kuma.io) and install the [Kuma Demo](https://github.com/Kong/kuma-demo) application. Refer to the [README.md](../kind/README.md) in that folder
It will also deploy [Kuma](kuma.io) and install the [Kuma Demo](https://github.com/kumahq/kuma-demo) application. Refer to the [README.md](../kind/README.md) in that folder
in order to get more info what are the pre-requisites (just Docker and `kubectl`) to use the script. Choosing this option, you can skip directly to [Integrations](#integrations) and [Policies](#policies),
to further explore Kuma.

Expand Down Expand Up @@ -117,7 +117,7 @@ The [all-in-one YAML file](/kubernetes/kuma-demo-aio.yaml) deploys our applicati
3. The third pod is an PostgreSQL service that stores all the items in our marketplace.
4. The fourth pod is a Redis service that stores reviews for each item.

![app-diagram](https://github.com/Kong/kuma-website/blob/master/docs/.vuepress/public/images/diagrams/diagram-kuma-demo-basic.jpg?raw=true)
![app-diagram](https://github.com/kumahq/kuma-website/blob/master/docs/.vuepress/public/images/diagrams/diagram-kuma-demo-basic.jpg?raw=true)

To access the front-end UI on [http://localhost:8080](http://localhost:8080), port-forward your `frontend` service like so:
```bash
Expand All @@ -126,7 +126,7 @@ Forwarding from 127.0.0.1:8080 -> 8080
Forwarding from [::1]:8080 -> 8080
```

![frontend-gui](https://raw.githubusercontent.com/Kong/kuma-website/master/docs/.vuepress/public/images/demo/kuma-demo-app-gui.png)
![frontend-gui](https://raw.githubusercontent.com/kumahq/kuma-website/master/docs/.vuepress/public/images/demo/kuma-demo-app-gui.png)

This marketplace application is currently running **WITHOUT** Kuma. So all traffic is going directly between the services, and not routed through any dataplanes. In the next step, we will download Kuma and quickly deploy the mesh alongside an existing application.

Expand Down Expand Up @@ -345,9 +345,9 @@ There are 4 dataplanes which correlates with each component of our application

### GUI

Kuma ships with an internal GUI that will help you visualize the mesh and its policies in an intuitive format. The GUI is also open-source so you can find the source code in the [kuma-gui repository](https://github.com/Kong/kuma-gui). It can be found on port :5683 on the control-plane machine, which we just port-forwarded above. Navigate to [http://localhost:5683/](http://localhost:5683/) to use Kuma's GUI.
Kuma ships with an internal GUI that will help you visualize the mesh and its policies in an intuitive format. The GUI is also open-source so you can find the source code in the [kuma-gui repository](https://github.com/kumahq/kuma-gui). It can be found on port :5683 on the control-plane machine, which we just port-forwarded above. Navigate to [http://localhost:5683/](http://localhost:5683/) to use Kuma's GUI.

![kuma-gui](https://raw.githubusercontent.com/Kong/kuma-website/master/docs/.vuepress/public/images/demo/kuma-gui-welcome-0.4.0.png)
![kuma-gui](https://raw.githubusercontent.com/kumahq/kuma-website/master/docs/.vuepress/public/images/demo/kuma-gui-welcome-0.4.0.png)

<!-- Back to top for web browser usability -->
<br/>
Expand Down Expand Up @@ -541,7 +541,7 @@ Forwarding from [::1]:3000 -> 3000

Visit the [Grafana dashboard](http://localhost:3000/) to query the metrics that Prometheus is scraping from Kuma mesh. If you are prompted to login, just use `admin:admin` as the username and password.

![grafana-dashboard](https://github.com/Kong/kuma-website/blob/master/docs/.vuepress/public/images/demo/mesh-grafana-dashboard.png?raw=true)
![grafana-dashboard](https://github.com/kumahq/kuma-website/blob/master/docs/.vuepress/public/images/demo/mesh-grafana-dashboard.png?raw=true)

<!-- Back to top for web browser usability -->
<br/>
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Kong/kuma-demo.git"
"url": "git+https://github.com/kumahq/kuma-demo.git"
},
"keywords": [
"service-mesh",
Expand All @@ -21,7 +21,7 @@
],
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/Kong/kuma-demo/issues"
"url": "https://github.com/kumahq/kuma-demo/issues"
},
"homepage": "https://github.com/Kong/kuma-demo#readme"
"homepage": "https://github.com/kumahq/kuma-demo#readme"
}
2 changes: 1 addition & 1 deletion vagrant/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ Once [Traffic Metric policies](#traffic-metrics) are added, you can visit the [P

Alongside Prometheus, we also have Grafana set up out-of-the-box. Visit the [Grafana dashboard](http://192.168.33.80:3000/) to query the metrics that Prometheus is scraping from Kuma mesh. If you are prompted to login, just use `admin:admin` as the username and password. For metrics to show up, you must add [Traffic Metric Policies](#traffic-metrics).

![grafana-dashboard](https://github.com/Kong/kuma-website/blob/master/docs/.vuepress/public/images/demo/mesh-grafana-dashboard.png?raw=true)
![grafana-dashboard](https://github.com/kumahq/kuma-website/blob/master/docs/.vuepress/public/images/demo/mesh-grafana-dashboard.png?raw=true)

## Policies

Expand Down

0 comments on commit 6cef263

Please sign in to comment.