Merge pull request #92 from 3scale-labs/tutorials

Authorino tutorials

README.md

@@ -38,9 +38,11 @@ The [architecture](docs/architecture.md) section of the docs covers the details
 2. Have your upstream API [ready](docs/architecture.md#protecting-upstream-apis-with-envoy-and-authorino) to be protected
 3. [Write](docs/architecture.md#the-authorino-service-custom-resource-definition-crd) and apply a `config.authorino.3scale.net`/`Service` custom resource declaring the desired state of the protection of your API
 
-## Sample use cases
+## Examples and Tutorials
 
-The [Examples](examples) page lists several use cases and demonstrates how to implement those as Authorino custom resources.
+The [Examples](examples) page lists several use cases and demonstrates how to implement those as Authorino custom resources. Each example use case presents a feature of Authorino and is independent from the other.
+
+The Authorino [Tutorials](docs/tutorials.md) provide guided examples for deploying and protecting an API with Authorino and the Envoy proxy, where each tutorial combines multiple features of Authorino into one cohesive use case, resembling real life use cases.
 
 ## Terminology
 

docs/deploy.md

@@ -47,7 +47,7 @@ Option A is meant for trying out Authorino locally. It gives you a bundle of a [
 
 Included resources:<br/>
 - **Talker API**<br/>
-    Just a simple rack application that echoes back in a JSON whatever is gets in the request. You can control the response by passing the custom HTTP headers X-Echo-Status and X-Echo-Message (both optional).
+    Just a simple rack application that echoes back in a JSON whatever it gets in the request. You can control the response by passing the custom HTTP headers X-Echo-Status and X-Echo-Message (both optional).
 - **Authorino**<br/>
     The Cloud-native AuthN/AuthZ enforcer that looks for `config.authorino.3scale.net/Service` custom resources in the Kubernetes server to add protection to your APIs.
 - **Envoy proxy**<br/>

docs/tutorials.md

@@ -0,0 +1,27 @@
+# Authorino Tutorials
+
+### [Showcase](tutorials/showcase)
+8 consecutive sample use cases to protect an API with Authorino and the Envoy proxy, deployed on a local Kubernetes cluster.
+
+**Authorino features covered in the tutorial:**
+- Kubernetes auth
+- API key auth
+- OpenID Connect JWT validation
+- User-Managed Access (UMA)-based attribute data
+- JSON authorization policies
+- Open Policy Agent (OPA) inline Rego policies
+
+**Requirements:**
+- Docker
+- Authorino repo cloned locally
+
+### [OpenShift demo](tutorials/openshift-demo)
+A simple and straightforward demo of Authorino deployed to an OpenShift cluster running in the cloud.
+
+**Authorino features covered in the tutorial:**
+- Kubernetes auth
+- API key auth
+- JSON authorization policies
+
+**Requirements:**
+- An OpenShift cluster running

docs/tutorials/openshift-demo/.gitignore

@@ -0,0 +1 @@
+*.yaml