scenario-1

Scenario 1 - Expose a K8s service as an API

• This scenario describes how to expose a backend service which has been already deployed in the kubernetes cluster as a managed API in the Kubernetes cluster.
• First we will deploy a sample backend service (product service) in the Kubernetes cluster
• Then the backend service (exposed k8s service) will be exposed as a managed API in the Kubernetes cluster

Important:

Follow the main README and deploy the api-operator and configuration files. Make sure to set the analyticsEnabled to "true" and deploy analytics secret with credentials to analytics server and certificate, if you want to check analytics.

Deploying the sample backend service

• Navigate to scenarios/scenario-1 directory and deploy the sample backend service using the following command.

  >> apictl apply -f products_dep.yaml
  
  Output:
  service/products created
  deployment.apps/products-deployment created
  

• This will deploy products backend service on port 80 with the following resources

  • GET /products : list all the products available
  • GET /products/{productId} : list product specific details for the given product ID

• Execute the following command to check if the service is present in the Kubernetes cluster.

  >> apictl get services products
  
  Output:
  NAME       TYPE           CLUSTER-IP    EXTERNAL-IP       PORT(S)        AGE
  products   LoadBalancer   10.83.1.131   104.197.114.248   80:30475/TCP   27m
  

• To test if the product service is working, execute the following commands.

  Command 1:
  >> curl -X GET http://<EXTERNAL_IP>:80/products
  
  Output:
  {"products":[{"name":"Apples", "id":101, "price":"$1.49 / lb"}, {"name":"Macaroni & Cheese", "id":151, "price":"$7.69"}, {"name":"ABC Smart TV", "id":301, "price":"$399.99"}, {"name":"Motor Oil", "id":401, "price":"$22.88"}, {"name":"Floral Sleeveless Blouse", "id":501, "price":"$21.50"}]}
  

  Command 2:
  >> curl -X GET http://<EXTERNAL_IP>:80/products/101
  
  Output:
  {"name":"Apples", "id":101, "price":"$1.49 / lb", "reviewScore":"0", "stockAvailability":false}
  

Exposing the backend service as a managed API in the K8S cluster

Please note that you need to configure the k8s-api-operator in the Kubernetes cluster prior to trying out the scenarios.

• Basic swagger definition belongs to the "products" service is available in products_swagger.yaml.
  

  Base path of the API and backend endpoint of the API should be mentioned in the swagger file with the "x-wso2-basePath" and "x-wso2-production-endpoints" extensions respectively.
  

  x-wso2-basePath: /store/v1.0.0
  

  In this swagger definition, the backend service of the "products" service has been mentioned as follows. It can be either globally or resource level. In the scenarios, we have defined it in resource level.

  x-wso2-production-endpoints:
    urls:
      - http://products
  

• Create API
  

  >> apictl add api -n online-store --from-file=products_swagger.yaml --override
  
  Output:
  creating configmap with swagger definition
  configmap/online-store-swagger created
  creating API definition
  api.wso2.com/online-store created
  

  Note: --override flag is used to you want to rebuild the API image even if it exists in the configured docker repository.

• Get available API
  

  >> apictl get apis
  
  Output:
  NAME          AGE
  online-store   55m
  

• Get service details to invoke the API
  

  >> apictl get services
  
  Output:
  NAME                 TYPE           CLUSTER-IP     EXTERNAL-IP       PORT(S)                         AGE
  online-store        LoadBalancer   10.83.9.188    34.66.153.49      9095:32087/TCP,9090:32572/TCP   98m
  products            LoadBalancer   10.83.1.131    104.197.114.248   80:30475/TCP                    77m
  

  • You can see both the backend(products) service and the managed API service(online-store) is available.
  • Get the external IP of the managed API's service

• Invoking the API
  

  TOKEN=eyJ4NXQiOiJNell4TW1Ga09HWXdNV0kwWldObU5EY3hOR1l3WW1NNFpUQTNNV0kyTkRBelpHUXpOR00wWkdSbE5qSmtPREZrWkRSaU9URmtNV0ZoTXpVMlpHVmxOZyIsImtpZCI6Ik16WXhNbUZrT0dZd01XSTBaV05tTkRjeE5HWXdZbU00WlRBM01XSTJOREF6WkdRek5HTTBaR1JsTmpKa09ERmtaRFJpT1RGa01XRmhNelUyWkdWbE5nX1JTMjU2IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJhZG1pbkBjYXJib24uc3VwZXIiLCJhdWQiOiJKRmZuY0djbzRodGNYX0xkOEdIVzBBR1V1ME1hIiwibmJmIjoxNTk3MjExOTUzLCJhenAiOiJKRmZuY0djbzRodGNYX0xkOEdIVzBBR1V1ME1hIiwic2NvcGUiOiJhbV9hcHBsaWNhdGlvbl9zY29wZSBkZWZhdWx0IiwiaXNzIjoiaHR0cHM6XC9cL3dzbzJhcGltOjMyMDAxXC9vYXV0aDJcL3Rva2VuIiwiZXhwIjoxOTMwNTQ1Mjg2LCJpYXQiOjE1OTcyMTE5NTMsImp0aSI6IjMwNmI5NzAwLWYxZjctNDFkOC1hMTg2LTIwOGIxNmY4NjZiNiJ9.UIx-l_ocQmkmmP6y9hZiwd1Je4M3TH9B8cIFFNuWGHkajLTRdV3Rjrw9J_DqKcQhQUPZ4DukME41WgjDe5L6veo6Bj4dolJkrf2Xx_jHXUO_R4dRX-K39rtk5xgdz2kmAG118-A-tcjLk7uVOtaDKPWnX7VPVu1MUlk-Ssd-RomSwEdm_yKZ8z0Yc2VuhZa0efU0otMsNrk5L0qg8XFwkXXcLnImzc0nRXimmzf0ybAuf1GLJZyou3UUTHdTNVAIKZEFGMxw3elBkGcyRswzBRxm1BrIaU9Z8wzeEv4QZKrC5NpOpoNJPWx9IgmKdK2b3kIWJEFreT3qyoGSBrM49Q
  

  >> curl -X GET "https://<external IP of LB service>:9095/store/v1.0.0/products" -H "accept: application/json" -H "Authorization:Bearer $TOKEN" -k
  

  • Once you execute the above command, it will call to the managed API (online-store), which then call its endpoint("products" service) available in the cluster. If the request is success, you would be able to see the response as below.

    {"products":[{"name":"Apples", "id":101, "price":"$1.49 / lb"}, {"name":"Macaroni & Cheese", "id":151, "price":"$7.69"}, {"name":"ABC Smart TV", "id":301, "price":"$399.99"}, {"name":"Motor Oil", "id":401, "price":"$22.88"}, {"name":"Floral Sleeveless Blouse", "id":501, "price":"$21.50"}]}
    

• Delete the API
  

  >> apictl delete api online-store
  
  Output:
  api.wso2.com "online-store" deleted