diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md index f91f364..f4cbac2 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,17 @@ #### Table of contents -- [Setup](#setup) -- [API](#api) - - [Docker](#docker---products-endpoint) - - [Redis](#redis---reviews-endpoint) - - [Run](#run-the-api) -- [App](#app) - - [Run](#run-the-app) - - [Build](#build-the-app) - - [Notes](#app-notes) +- [Kuma Demo](#kuma-demo) + - [Table of contents](#table-of-contents) + - [Setup](#setup) + - [API](#api) + - [Docker - Products endpoint](#docker---products-endpoint) + - [Redis - Reviews endpoint](#redis---reviews-endpoint) + - [Run the API](#run-the-api) + - [App](#app) + - [Run the app](#run-the-app) + - [Build the app](#build-the-app) + - [App notes](#app-notes) ## Setup diff --git a/deploy/README.md b/deploy/README.md index 2441776..61d38a1 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -1,11 +1,11 @@ # Kubernetes Deployment Guide -## Setup Your Environment +## Setup Environment -### 1. Start a Kubernetes cluster with version 1.15 or higher and at least 4GB of memory +### 1. Start a Kubernetes cluster with at least 4GB of memory. We've tested Kuma on Kubernetes v1.13.0 - v1.16.x, so use anything older than v1.13.0 with caution. In this demo, we'll be using v1.15.4. ``` -$ minikube start --kubernetes-version v1.15.4 +$ minikube start --cpus 2 --memory 4096 --kubernetes-version v1.15.4 😄 minikube v1.4.0 on Darwin 10.14.6 🔥 Creating virtualbox VM (CPUs=2, Memory=4096MB, Disk=20000MB) ... 🐳 Preparing Kubernetes v1.15.4 on Docker 18.09.9 ... @@ -49,17 +49,7 @@ redis-master-6d4cf995c5-nsghm 1/1 Running 0 13m In the following steps, we will be using the pod name of the `kuma-demo-app-*************` pod. Please replace any `${KUMA_DEMO_APP_POD_NAME}` variables with your pod name. -### 4. Deploy the logstash service. - -``` -$ kubectl apply -f kuma-demo-log.yaml -namespace/logging created -service/logstash created -configmap/logstash-config created -deployment.apps/logstash created -``` - -### 5. Port-forward the sample application to access the front-end UI at http://localhost:8080 +### 4. Port-forward the sample application to access the front-end UI at http://localhost:8080 
$ kubectl port-forward ${KUMA_DEMO_APP_POD_NAME} -n kuma-demo 8080 3001
 Forwarding from 127.0.0.1:8080 -> 8080
@@ -72,7 +62,8 @@ Now you can access the marketplace application through your web browser at http:
 
 The items on the front page are pulled from the Elasticsearch service. While the reviews for each item sit within the Redis service. You can query for individual items and look at their reviews.
 
-### 6. Download the latest version of Kuma
+
+### 5. Download the latest version of Kuma
 
 ```
 $ wget https://kong.bintray.com/kuma/kuma-0.2.2-darwin-amd64.tar.gz
@@ -93,7 +84,7 @@ kuma-0.2.2-darwin-amd64.tar.g 100%[=============================================
 2019-10-13 05:54:08 (2.09 MB/s) - ‘kuma-0.2.2-darwin-amd64.tar.gz’ saved [42892462/42892462]
 ```
 
-### 7. Unbundle the files to get the following components:
+### 6. Unbundle the files to get the following components:
 
 ```
 $ tar xvzf kuma-0.2.2-darwin-amd64.tar.gz
@@ -110,14 +101,14 @@ x ./README
 x ./LICENSE
 ```
 
-### 8. Go into the ./bin directory where the kuma components will be:
+### 7. Go into the ./bin directory where the kuma components will be:
 
 ```
 $ cd bin && ls
 envoy   kuma-cp   kuma-dp   kuma-tcp-echo kumactl
 ```
 
-### 9. Install the control plane using `kumactl`
+### 8. Install the control plane using `kumactl`
 
 ```
 $ ./kumactl install control-plane | kubectl apply -f -
@@ -156,7 +147,7 @@ kuma-injector-9c96cddc8-745r7         1/1     Running   0          70s
 
 In the following steps, we will be using the pod name of the `kuma-control-plane-*************` pod. Please replace any `${KUMA_CP_POD_NAME}` with your pod name.
 
-### 10. Delete the existing kuma-demo pods so they restart:
+### 9. Delete the existing kuma-demo pods so they restart:
 
 ```
 $ kubectl delete pods --all -n kuma-demo
@@ -175,7 +166,7 @@ kuma-demo-app-8fc49ddbf-k5z5q   3/3     Running   0          2m25s
 redis-master-6d4cf995c5-jxjjm   2/2     Running   0          2m25s
 ```
 
-### 11. Port-forward the sample application again to access the front-end UI at http://localhost:8080
+### 10. Port-forward the sample application again to access the front-end UI at http://localhost:8080
 
 
$ kubectl port-forward ${KUMA_DEMO_APP_POD_NAME} -n kuma-demo 8080 3001
 Forwarding from 127.0.0.1:8080 -> 8080
@@ -186,7 +177,7 @@ Forwarding from [::1]:3001 -> 3001
 
 Now you can access the marketplace application through your web browser at http://localhost:8080 with Envoy handling all the traffic between the services. Happy shopping!
 
-### 12. Now we will port forward the kuma-control-plane so we can access it with `kumactl`
+### 11.  Now we will port forward the kuma-control-plane so we can access it with `kumactl`
 
 
$ kubectl -n kuma-system port-forward ${KUMA_CP_POD_NAME} 5681
 Forwarding from 127.0.0.1:5681 -> 5681
@@ -195,7 +186,7 @@ Forwarding from [::1]:5681 -> 5681
 
 Please refer to step 7 to copy the correct `${KUMA_CP_POD_NAME}`.
 
-### 13. Now configure `kumactl` to point towards the control plane address
+### 12.  Now configure `kumactl` to point towards the control plane address
 
 ```
 $ ./kumactl config control-planes add --name=minikube --address=http://localhost:5681
@@ -203,7 +194,7 @@ added Control Plane "minikube"
 switched active Control Plane to "minikube"
 ```
 
-### 14. You can use `kumactl` to look at the dataplanes in the mesh. You should see three dataplanes that correlates with our pods in Kubernetes:
+### 13. You can use `kumactl` to look at the dataplanes in the mesh. You should see three dataplanes that correlates with our pods in Kubernetes:
 
 ```
 $ ./kumactl inspect dataplanes
@@ -213,7 +204,7 @@ default   redis-master-6d4cf995c5-jxjjm   app=redis pod-template-hash=6d4cf995c5
 default   kuma-demo-app-8fc49ddbf-k5z5q   app=kuma-demo-api pod-template-hash=8fc49ddbf service=kuma-demo-api.kuma-demo.svc:3001                    Online   9m8s                 9m7s               3               0
 ```
 
-### 15. You can also use `kumactl` to look at the mesh. As shown below, our default mesh does not have mTLS enabled.
+### 14. You can also use `kumactl` to look at the mesh. As shown below, our default mesh does not have mTLS enabled.
 
 ```
 $ ./kumactl get meshes
@@ -221,10 +212,10 @@ NAME      mTLS   DP ACCESS LOGS
 default   off    off
 ```
 
-### 16. Let's enable mTLS.
+### 15.  Let's enable mTLS.
 
 ```
-$ cat <