distinguish between ambassador 1.x and 2.x in petstore example (#197)

kubeshop · Nov 25, 2021 · c9ccc91 · c9ccc91
1 parent 0023578
commit c9ccc91
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 3 deletions.
diff --git a/docs/ambassador.md b/docs/ambassador.md
@@ -1,6 +1,6 @@
 # Ambassador
 
-** Note**
+**Note**:
 Ambassador uses `CustomResourceDefinition`s with `apiVersion` = `apiextensions.k8s.io/v1beta1` which was removed in Kubernetes version 1.22+. Please ensure your Kubernetes version is compatible with the version of Ambassador you're using
 
 ```shell

diff --git a/docs/ambassador2.md b/docs/ambassador2.md
@@ -1,5 +1,4 @@
 # Ambassador 2.0
-**Warning**: Ambassador 2.0 is currently in Developer Preview and could change at any point, breaking the implementation here.
 
 ** Note**
 Ambassador2 uses `CustomResourceDefinition`s with `apiVersion` = `apiextensions.k8s.io/v1` which is compatible with Kubernetes version 1.22+. Please ensure your Kubernetes version is compatible with the version of Ambassador you're using.

diff --git a/examples/petstore/README.md b/examples/petstore/README.md
@@ -35,7 +35,47 @@ Apply Petstore manifest
 kubectl apply -f examples/petstore/manifest.yaml
 ```
 
-## Ambassador Mappings
+## Ambassador 1.x Mappings
+**Note**:
+Ambassador uses `CustomResourceDefinition`s with `apiVersion` = `apiextensions.k8s.io/v1beta1` which was removed in Kubernetes version 1.22+.
+
+Please ensure your Kubernetes version is compatible with the version of Ambassador you're using.
+
+### Setup
+```shell
+helm repo add datawire https://www.getambassador.io
+helm install ambassador datawire/ambassador --set enableAES=false
+
+kubectl wait --for condition=established --timeout=90s crd -lapp.kubernetes.io/name=ambassador
+
+kubectl wait --for condition=available --timeout=90s deploy -lapp.kubernetes.io/name=ambassador
+```
+
+### Generate mappings and curl service
+
+Root only
+```shell
+# This will allow you to resolve the swagger documentation in the browser at https://localhost:8080/
+go run main.go ambassador -i examples/petstore/petstore.yaml --path.base="/petstore" --path.trim_prefix="/petstore" --service.name "petstore" | kubectl apply -f -
+
+curl -Li 'http://localhost:8080/petstore/api/v3/pet/findByStatus?status=available'
+```
+
+CQRS Pattern
+```shell
+# This will allow you to resolve the swagger documentation in the browser at https://localhost:8080/
+go run main.go ambassador -i examples/petstore/petstore.yaml --path.base="/" --service.name "petstore" | kubectl apply -f -
+
+# This will create mappings for each route in the api
+go run main.go ambassador -i examples/petstore/petstore.yaml --path.base="/petstore/api/v3" --path.trim_prefix="/petstore" --service.name "petstore" --path.split=true | kubectl apply -f -
+
+curl -Li 'http://localhost:8080/petstore/api/v3/pet/findByStatus?status=available'
+```
+
+## Ambassador 2.x Mappings
+**Note**: Ambassador2 uses `CustomResourceDefinition`s with `apiVersion` = `apiextensions.k8s.io/v1` which is compatible with Kubernetes version 1.22+.
+
+Please ensure your Kubernetes version is compatible with the version of Ambassador you're using.
 ### Setup
 
 ```shell