Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googlecloudplatform/apigee-anthos-service-mesh-demo

This demo extends the existing GCP Boutique Shop Microservices demo to show how to use Apigee for exposing internal gRPC services (inside the mesh) as RESTful API to external consumers (outside the mesh).
https://github.com/googlecloudplatform/apigee-anthos-service-mesh-demo

anthos-service-mesh api api-management apigee service-management service-mesh

Last synced: about 1 month ago
JSON representation

This demo extends the existing GCP Boutique Shop Microservices demo to show how to use Apigee for exposing internal gRPC services (inside the mesh) as RESTful API to external consumers (outside the mesh).

Awesome Lists containing this project

README 

        
# API Management + Microservices Demo



This demo extends the existing GCP Boutique Shop [Microservices demo](https://github.com/GoogleCloudPlatform/microservices-demo) to show

how to use Apigee for exposing internal gRPC services (inside the mesh) as RESTful APIs to external consumers (outside the mesh).



When exposing APIs to external consumers, there are key challenges that arise due to the nature of external consumption.

Here are a few of them from the point of view of both the API producer, and the API consumer.



### API Producer challenges

* How do you expose a cohesive and consistent RESTful API surface (from disparate underlying services)?

  * Consistent & RESTful URL paths

  * Consistent & RESTful HTTP status codes

  * Consistent & RESTful error message formats

  * Consistent & RESTful request & response payloads

  * Consistent & RESTful authentication mechanisms

* How do you measure engagement and get key usage / business insights for the APIs being exposed?

* How do you monetize the APIs being exposed?



### API Consumer challenges

* How do you discover APIs available?

* How do you learn to use the APIs available?

* How do you sign-up (get credentials) to use the APIs available?



While this demo does not address every single use-case listed above, it does show the core components and concepts needed to use Apigee in this context.



## Demo Architecture



The demo assumes you are deploying all components in GCP, and that you are using Apigee X in combination with GKE + Anthos Service Mesh.





Apigee & ASM Demo Architecture




## Prerequisites

1. [Provision Apigee X](https://cloud.google.com/apigee/docs/api-platform/get-started/provisioning-intro)

2. Configure [external access](https://cloud.google.com/apigee/docs/api-platform/get-started/configure-routing#external-access) for API traffic to your Apigee X instance

3. Make sure the following tools are available in your terminal's $PATH (Cloud Shell has these preconfigured)

    * [gcloud SDK](https://cloud.google.com/sdk/docs/install)

    * kubectl

    * wget

    * unzip

    * curl

    * jq



## (QuickStart) Demo CloudShell setup tutorial



Use the following GCP CloudShell tutorial, and follow the instructions.



[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://ssh.cloud.google.com/cloudshell/open?cloudshell_git_repo=https://github.com/GoogleCloudPlatform/apigee-anthos-service-mesh-demo&cloudshell_git_branch=main&cloudshell_workspace=.&cloudshell_tutorial=docs/cloudshell-tutorial.md)



## Demo instructions



1. Clone this repo, and switch the main directory



```bash

git clone https://github.com/GoogleCloudPlatform/apigee-anthos-service-mesh-demo.git

cd apigee-anthos-service-mesh-demo

```



2. Edit the `env.sh` and configure the ENV vars



* `PROJECT` the project where you want to create the GKE cluster with ASM

* `NETWORK` the network you have peered with Apigee and where you want the GKE cluster to be created

* `SUBNETWORK` the subnetwork where the GKE cluster should be created

* `LOCATION` the location for the GKE cluster

* `CLUSTER_NAME` the name for the GKE demo cluster

* `UI_GATEWAY_NAMESPACE` the kubernetes namespace for the UI ingress gateway

* `API_GATEWAY_NAMESPACE` the kubernetes namespace for the API ingress gateway

* `APIGEE_HOST` the externally reachable hostname of the Apigee environment group that contains APIGEE_ENV

* `APIGEE_ENV` the Apigee environment where the demo resources should be created



Now source the `env.sh` file



```bash

source ./env.sh

```



3. Run script to create a GKE cluster



```bash

./create-gke-cluster.sh

```



4. Run script to deploy ASM and the Online Boutique Shop demo



```bash

./deploy-asm.sh

```



The script will provide the URL of the deployed application in the console. Open the URL in a new browser tab to access the application.



5. Run script to create a private API ingress (for Apigee to hit) & gRPC transcoding service



```bash

./deploy-gateway.sh

```



6. Deploy Apigee API proxies, target server, products, apps

```bash

./deploy-apigee.sh

```



7. (Optional) deploy monetization artifacts



*Note:* This step requires your organization to have the monetization addon enabled. See the [Apigee docs](https://cloud.google.com/apigee/docs/api-platform/monetization/enable) for instructions on how to enable monetization on your paid or eval organization.



```bash

./deploy-mint.sh

```



## Testing the Apigee RESTful API proxies



The script that deploys the Apigee API proxies prints a few sample cURL commands that you can use to test.



Those sample cURL commands already have the necessary API key for each of the API calls.



```bash

curl https://{APIGEE_HOST}/v1/productservices/products?apikey=API_KEY_FROM_APIGEE_DEVELOPER_APP

curl https://{APIGEE_HOST}/v1/currencyservices/currencies?apikey=API_KEY_FROM_APIGEE_DEVELOPER_APP

```



## Troubleshooting



1. Apigee is not able to reach the API private ingress



   You can use a GCE VM within the same VPC Network and try using cURL to test for connectivity.



   First, get the IP address of the API ingress load balancer



   ```bash

   export ILB_IP=$(kubectl get services api-ingressgateway -n $API_GATEWAY_NAMESPACE -o jsonpath='{.status.loadBalancer.ingress[0].ip}')

   echo "ILB_IP=${ILB_IP}"

   ```



   Then, from within the GCE VM, run the following curl command to get product catalog data



   ```bash

   curl http://$ILB_IP/products

   ```



   If this works, but Apigee is still not able to reach this endpoint, verify that the Apigee Target Server has the right IP address.



## Cleanup



For each of the "deploy" scripts, there is an equivalent "cleanup" script you can run.

If you want to clean the entire setup, first source your `env.sh` script, and then run the scripts in the following order



```bash

./cleanup-mint.sh # if applicable

./cleanup-apigee.sh

./cleanup-gateway.sh

./cleanup-asm.sh

```



Then, finally you can remove the GKE cluster with



```bash

./delete-gke-cluster.sh

```



## Not Google Product Clause



This is not an officially supported Google product, nor is it part of an

official Google product.



## Support



If you need support or assistance using the tool, you can try inquiring on [Google Cloud Community

forum dedicated to Apigee](https://www.googlecloudcommunity.com/gc/Apigee/bd-p/cloud-apigee). There is no service-level guarantee for

responses to inquiries regarding this tool.



## License



This material is [Copyright 2022 Google LLC](./NOTICE)

and is licensed under the [Apache 2.0 License](LICENSE).