From 55afb6464215da86f9980b946fbd3daedd731f65 Mon Sep 17 00:00:00 2001 From: sgayangi Date: Mon, 11 Nov 2024 11:52:46 +0530 Subject: [PATCH] Update links to open new tabs when clicked --- .../get-started/employee-service-backend.yaml | 6 +- en/docs/control-plane/apim-deploy.md | 42 ++++---- .../apk-as-gateway-in-apim-qsg.md | 3 +- .../start-apk-cp-to-dp-k8s.md | 2 +- .../control-plane/start-apk-dp-to-cp-k8s.md | 8 +- .../cors/enable-cors-via-rest-api.md | 2 +- .../mirror-request-via-rest-api.md | 4 +- .../redirect-request-via-rest-api.md | 4 +- .../manage-resiliency-circuit-breaker.md | 6 +- .../manage-resiliency-retry-policy.md | 4 +- .../manage-resiliency-timeout.md | 4 +- .../manage-security-via-rest-api.md | 4 +- ...new-rate-limiting-policies-via-rest-api.md | 32 +++---- .../api-definition-endpoint.md | 8 +- .../api-properties/api-properties.md | 8 +- .../quick-start-guide-as-gateway.md | 4 +- .../get-started/quick-start-guide-with-cp.md | 96 ++++++++++++++----- en/docs/get-started/quick-start-guide.md | 24 ++--- en/docs/includes/create-apk-conf-api.md | 2 +- en/docs/includes/start-apk-cp.md | 7 +- 20 files changed, 158 insertions(+), 112 deletions(-) diff --git a/en/docs/assets/files/get-started/employee-service-backend.yaml b/en/docs/assets/files/get-started/employee-service-backend.yaml index 7fe5c0eac..7dd2ec951 100644 --- a/en/docs/assets/files/get-started/employee-service-backend.yaml +++ b/en/docs/assets/files/get-started/employee-service-backend.yaml @@ -5,8 +5,8 @@ metadata: spec: type: ClusterIP ports: - - port: 80 - targetPort: 80 + - port: 8080 + targetPort: 8080 selector: app: employee-app --- @@ -28,4 +28,4 @@ spec: - name: employee-service-container image: sega1234/json-server-service:latest ports: - - containerPort: 80 + - containerPort: 8080 diff --git a/en/docs/control-plane/apim-deploy.md b/en/docs/control-plane/apim-deploy.md index 3aa96b65c..5c9047d3a 100644 --- a/en/docs/control-plane/apim-deploy.md +++ b/en/docs/control-plane/apim-deploy.md @@ -9,29 +9,29 @@ API Manager can be configured in both ways. These are additional configuration to values.yaml file to provide control plane related configs to API Manager. - ``` toml - configurations: - gatewayType: "APK" +``` +configurations: + gatewayType: "APK" - publisher: - enablePortalConfigurationOnlyMode: true +publisher: + enablePortalConfigurationOnlyMode: true - gateway: - # -- APIM Gateway environments - environments: - - name: "Default" - type: "hybrid" - provider: "wso2" - gatewayType: "APK" - displayInApiConsole: true - description: "This is a hybrid gateway that handles both production and sandbox token traffic." - showAsTokenEndpointUrl: true - serviceName: "wso2am-gateway-service" - servicePort: 9443 - wsHostname: "websocket.wso2.com" - httpHostname: "carbon.super.gw.wso2.com:9095" - websubHostname: "websub.wso2.com" - ``` +gateway: +# -- APIM Gateway environments + environments: + - name: "Default" + type: "hybrid" + provider: "wso2" + gatewayType: "APK" + displayInApiConsole: true + description: "This is a hybrid gateway that handles both production and sandbox token traffic." + showAsTokenEndpointUrl: true + serviceName: "wso2am-gateway-service" + servicePort: 9443 + wsHostname: "websocket.wso2.com" + httpHostname: "carbon.super.gw.wso2.com:9095" + websubHostname: "websub.wso2.com" +``` ### APK as a gateway to API Manager diff --git a/en/docs/control-plane/apk-as-gateway-in-apim/apk-as-gateway-in-apim-qsg.md b/en/docs/control-plane/apk-as-gateway-in-apim/apk-as-gateway-in-apim-qsg.md index 96abdf7df..bdecc4cbc 100644 --- a/en/docs/control-plane/apk-as-gateway-in-apim/apk-as-gateway-in-apim-qsg.md +++ b/en/docs/control-plane/apk-as-gateway-in-apim/apk-as-gateway-in-apim-qsg.md @@ -49,7 +49,8 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. helm install /wso2am-cp --version -f ``` -4. Install NGINX Ingress Controller. Please refer to the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/#local-development-clusters) documentation for more information. +4. Install NGINX Ingress Controller. Please refer to the NGINX Ingress Controller documentation for more information. + !!! Note Please refer to the [Advance Configuration for APIM](../apim-deploy.md) for more information. diff --git a/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-k8s.md b/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-k8s.md index 31a4068e7..e00aaa8bf 100644 --- a/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-k8s.md +++ b/en/docs/control-plane/apk-as-gateway-in-apim/start-apk-cp-to-dp-k8s.md @@ -43,7 +43,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. helm install /wso2am-cp --version -f ``` -4. Install NGINX Ingress Controller. Please refer to the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/#local-development-clusters) documentation for more information. +4. Install NGINX Ingress Controller. Please refer to the NGINX Ingress Controller documentation for more information. !!! Note Please refer to the [Advance Configuration for APIM](../../../control-plane/apim-deploy/) for more information. diff --git a/en/docs/control-plane/start-apk-dp-to-cp-k8s.md b/en/docs/control-plane/start-apk-dp-to-cp-k8s.md index 69c3b2e28..4c2678f4c 100644 --- a/en/docs/control-plane/start-apk-dp-to-cp-k8s.md +++ b/en/docs/control-plane/start-apk-dp-to-cp-k8s.md @@ -43,10 +43,10 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. helm install /wso2am-cp --version -f ``` -4. Install NGINX Ingress Controller. Please refer to the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/#local-development-clusters) documentation for more information. +4. Install NGINX Ingress Controller. Please refer to the NGINX Ingress Controller documentation for more information. !!! Note - Please refer to the [Advance Configuration for APIM](../../../control-plane/apim-deploy/) for more information. + Please refer to the Advanced Configuration for APIM for more information. #### Setup WSO2 APK Dataplane 1.2.0 @@ -99,7 +99,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. ``` !!! Note - Please refer to the [Advance Configuration for APK](../../../control-plane/apk-deploy) for more information. + Please refer to the Advanced Configuration for APIM for more information. #### Setup WSO2 APIM-APK Agent 1.2.0 @@ -128,7 +128,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. ``` !!! Note - Please refer to the [Advance Configuration for agent](../../../control-plane/apim-apk-agent-deploy) for more information. + Please refer to the Advanced Configuration for Agent for more information. #### Verify the deployment diff --git a/en/docs/create-api/create-and-attach-api-policies/cors/enable-cors-via-rest-api.md b/en/docs/create-api/create-and-attach-api-policies/cors/enable-cors-via-rest-api.md index 3d8685278..f7061e1a2 100644 --- a/en/docs/create-api/create-and-attach-api-policies/cors/enable-cors-via-rest-api.md +++ b/en/docs/create-api/create-and-attach-api-policies/cors/enable-cors-via-rest-api.md @@ -122,7 +122,7 @@ type: "REST" defaultVersion: true endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - target: "/employee" verb: "GET" diff --git a/en/docs/create-api/create-and-attach-api-policies/mirror-request-filters/mirror-request-via-rest-api.md b/en/docs/create-api/create-and-attach-api-policies/mirror-request-filters/mirror-request-via-rest-api.md index ecb61697c..1923d588f 100644 --- a/en/docs/create-api/create-and-attach-api-policies/mirror-request-filters/mirror-request-via-rest-api.md +++ b/en/docs/create-api/create-and-attach-api-policies/mirror-request-filters/mirror-request-via-rest-api.md @@ -12,7 +12,7 @@ A sample request mirror configuration is given below. For this guide, it's best to use a webhook.site URL for both the production and request mirroring endpoints to view the duplicate requests. Replace the `WEBHOOK_URL` with a relevant webhook url from the site `https://webhook.site`. Ensure that you keep this webpage open to view the incoming requests. ``` - - target: "/employee" + - target: "/employees" verb: "GET" secured: false scopes: [] @@ -40,7 +40,7 @@ endpointConfigurations: production: endpoint: `WEBHOOK_URL` operations: -- target: "/employee" +- target: "/employees" verb: "GET" secured: false scopes: [] diff --git a/en/docs/create-api/create-and-attach-api-policies/redirect-request-filters/redirect-request-via-rest-api.md b/en/docs/create-api/create-and-attach-api-policies/redirect-request-filters/redirect-request-via-rest-api.md index 2e089ba95..047193e3e 100644 --- a/en/docs/create-api/create-and-attach-api-policies/redirect-request-filters/redirect-request-via-rest-api.md +++ b/en/docs/create-api/create-and-attach-api-policies/redirect-request-filters/redirect-request-via-rest-api.md @@ -11,7 +11,7 @@ Here, you can follow the steps in [Create an API](../../../get-started/quick-sta A sample request redirection configuration is given below. ``` -- target: "/employee" +- target: "/employees" verb: "GET" secured: false scopes: [] @@ -39,7 +39,7 @@ endpointConfigurations: production: endpoint: https://httpbin.org/anything operations: -- target: "/employee" +- target: "/employees" verb: "GET" secured: false scopes: [] diff --git a/en/docs/create-api/manage-service-endpoint/manage-resiliency-circuit-breaker.md b/en/docs/create-api/manage-service-endpoint/manage-resiliency-circuit-breaker.md index 3998fb3e1..84cc23c66 100644 --- a/en/docs/create-api/manage-service-endpoint/manage-resiliency-circuit-breaker.md +++ b/en/docs/create-api/manage-service-endpoint/manage-resiliency-circuit-breaker.md @@ -48,7 +48,7 @@ When deploying APIs add the configurations to the `apk-conf` file as shown in th ``` endpointConfigurations: production: - endpoint: "http://backend-service.ns:443" + endpoint: "http://employee-service:8080" resiliency: circuitBreaker: maxConnectionPools: 1000 @@ -67,7 +67,7 @@ type: "REST" defaultVersion: true endpointConfigurations: production: - endpoint: "http://backend-service.ns:443" + endpoint: "http://employee-service:8080" resiliency: circuitBreaker: maxConnectionPools: 1000 @@ -76,7 +76,7 @@ endpointConfigurations: maxRequests: 75 maxRetries: 3 operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] diff --git a/en/docs/create-api/manage-service-endpoint/manage-resiliency-retry-policy.md b/en/docs/create-api/manage-service-endpoint/manage-resiliency-retry-policy.md index 876d62be1..37d439d5a 100644 --- a/en/docs/create-api/manage-service-endpoint/manage-resiliency-retry-policy.md +++ b/en/docs/create-api/manage-service-endpoint/manage-resiliency-retry-policy.md @@ -56,7 +56,7 @@ type: "REST" defaultVersion: true endpointConfigurations: production: - endpoint: "http://backend-service.ns:443" + endpoint: "http://employee-service:8080" resiliency: retryPolicy: count: 3 @@ -66,7 +66,7 @@ endpointConfigurations: - 501 - 502 operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] diff --git a/en/docs/create-api/manage-service-endpoint/manage-resiliency-timeout.md b/en/docs/create-api/manage-service-endpoint/manage-resiliency-timeout.md index b67764521..8f3956617 100644 --- a/en/docs/create-api/manage-service-endpoint/manage-resiliency-timeout.md +++ b/en/docs/create-api/manage-service-endpoint/manage-resiliency-timeout.md @@ -50,13 +50,13 @@ type: "REST" defaultVersion: true endpointConfigurations: production: - endpoint: "http://backend-service.ns:443" + endpoint: "http://employee-service:8080" resiliency: timeout: downstreamRequestIdleTimeout: 45 upstreamResponseTimeout: 10 operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] diff --git a/en/docs/create-api/manage-service-endpoint/manage-security-via-rest-api.md b/en/docs/create-api/manage-service-endpoint/manage-security-via-rest-api.md index 3e3534b8e..5364de0b7 100644 --- a/en/docs/create-api/manage-service-endpoint/manage-security-via-rest-api.md +++ b/en/docs/create-api/manage-service-endpoint/manage-security-via-rest-api.md @@ -72,7 +72,7 @@ type: "REST" defaultVersion: true endpointConfigurations: production: - endpoint: "https://httpbin.org" + endpoint: "http://employee-service:8080" endpointSecurity: enabled: true securityType: @@ -80,7 +80,7 @@ endpointConfigurations: userNameKey: "username" passwordKey: "password" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] diff --git a/en/docs/create-api/rate-limiting/add-new-rate-limiting-policies-via-rest-api.md b/en/docs/create-api/rate-limiting/add-new-rate-limiting-policies-via-rest-api.md index 557d7b276..d5c526012 100644 --- a/en/docs/create-api/rate-limiting/add-new-rate-limiting-policies-via-rest-api.md +++ b/en/docs/create-api/rate-limiting/add-new-rate-limiting-policies-via-rest-api.md @@ -29,9 +29,9 @@ rateLimit: defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -63,9 +63,9 @@ rateLimit: defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -128,9 +128,9 @@ Sample content before the modification is shown below. defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -171,9 +171,9 @@ Sample content after the modification is shown below. unit: "Minute" endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -244,9 +244,9 @@ Use the values provided in the table below in the body of your request. unit: "Minute" endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -292,9 +292,9 @@ Sample content before the modification is shown below. defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -332,9 +332,9 @@ Sample content after the modification is shown below. defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -405,9 +405,9 @@ Use the values provided in the table below in the body of your request. defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] diff --git a/en/docs/develop-and-deploy-api/api-definition-endpoint/api-definition-endpoint.md b/en/docs/develop-and-deploy-api/api-definition-endpoint/api-definition-endpoint.md index 8611a280c..f910fa25c 100644 --- a/en/docs/develop-and-deploy-api/api-definition-endpoint/api-definition-endpoint.md +++ b/en/docs/develop-and-deploy-api/api-definition-endpoint/api-definition-endpoint.md @@ -16,9 +16,9 @@ Sample content before the modification is shown below. defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -69,9 +69,9 @@ Here, we have added a property named `definitionPath` with the new value `/docs` defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] diff --git a/en/docs/develop-and-deploy-api/api-properties/api-properties.md b/en/docs/develop-and-deploy-api/api-properties/api-properties.md index 7d63239f8..0847364cc 100644 --- a/en/docs/develop-and-deploy-api/api-properties/api-properties.md +++ b/en/docs/develop-and-deploy-api/api-properties/api-properties.md @@ -17,9 +17,9 @@ Sample content before the modification is shown below. defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] @@ -50,9 +50,9 @@ Here, we have added a property named `enableStore` with the value `true`. defaultVersion: false endpointConfigurations: production: - endpoint: "https://run.mocky.io/v3/1327c339-354b-4080-8296-f6268365e67b" + endpoint: "http://employee-service:8080" operations: - - target: "/employee" + - target: "/employees" verb: "GET" secured: true scopes: [] diff --git a/en/docs/get-started/quick-start-guide-as-gateway.md b/en/docs/get-started/quick-start-guide-as-gateway.md index 0b1a33790..307afd028 100644 --- a/en/docs/get-started/quick-start-guide-as-gateway.md +++ b/en/docs/get-started/quick-start-guide-as-gateway.md @@ -60,10 +60,10 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. helm install /wso2am-cp --version -f ``` -4. Install NGINX Ingress Controller. Please refer to the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/#local-development-clusters) documentation for more information. +4. Install NGINX Ingress Controller. Please refer to the NGINX Ingress Controller documentation for more information. !!! Note - Please refer to the [Advance Configuration for APIM](../apim-deploy.md) for more information. + Please refer to the Advanced Configuration for APIM for more information. ### Setup WSO2 APK Dataplane 1.2.0 diff --git a/en/docs/get-started/quick-start-guide-with-cp.md b/en/docs/get-started/quick-start-guide-with-cp.md index efa46637d..1e897e222 100644 --- a/en/docs/get-started/quick-start-guide-with-cp.md +++ b/en/docs/get-started/quick-start-guide-with-cp.md @@ -3,17 +3,17 @@ This section provides a step-by-step guide to creating, deploying, and invoking an API using the WSO2 API Platform for Kubernetes integrated with the Control Plane. It also covers how to create an API from the data plane using CR and APIs. !!!NOTE - To set up the APK as an enterprise version, please follow the steps specified in both the [Install APK Enterprise](../setup/enterprise-apk-install) and [Install APIM APK Agent Enterprise](../setup/enterprise-apim-apk-agent-install.md) sections. + To set up the APK as an enterprise version, please follow the steps specified in both the Install APK Enterprise and Install APIM APK Agent Enterprise. !!!NOTE - If you follow this approach, **you cannot create APIs from Portal UI**. If you need that approach, go to [Portal-Driven Design First](../quick-start-guide-as-gateway) section. + If you follow this approach, **you cannot create APIs from Portal UI**. If you need that approach, go to Portal-Driven Design First section. ## Before you begin... -Install the [prerequisites](../../setup/prerequisites) that are required to run the WSO2 API Platform for Kubernetes. +Install the prerequisites that are required to run the WSO2 API Platform for Kubernetes. !!!NOTE - If you already have an installation of the APK in your cluster, please remove the installation by following the steps specified in the [Uninstall APK](../setup/uninstall.md) section. + If you already have an installation of the APK in your cluster, please remove the installation by following the steps specified in the Uninstall APK section. ## Step 1 - Setup WSO2 API Platform For Kubernetes With Control Plane @@ -21,7 +21,9 @@ Install the [prerequisites](../../setup/prerequisites) that are required to run ## Step 2 - Create and Deploy the API From Dataplane -1. Save and download the sample [EmployeeServiceDefinition.json](../assets/files/get-started/EmployeeServiceDefinition.json) file. This is the OAS definition of the API that we are going to deploy in APK. +1. Save and download the sample +EmployeeServiceDefinition.json file. This is the OAS definition of the API that we are going to deploy in APK. 2. Add a hostname mapping to the ```/etc/hosts``` file as follows. | IP | Domain name | @@ -73,22 +75,22 @@ Apart from the above API definition file, we also need an `apk-conf` file that d production: endpoint: "http://employee-service:8080" operations: + - target: "/employees" + verb: "GET" + secured: true + scopes: [] - target: "/employee" - verb: "GET" - secured: true - scopes: [] - - target: "/employee" - verb: "POST" - secured: true - scopes: [] + verb: "POST" + secured: true + scopes: [] - target: "/employee/{employeeId}" - verb: "PUT" - secured: true - scopes: [] + verb: "PUT" + secured: true + scopes: [] - target: "/employee/{employeeId}" - verb: "DELETE" - secured: true - scopes: [] + verb: "DELETE" + secured: true + scopes: [] ``` === "Request Format" @@ -100,10 +102,39 @@ Apart from the above API definition file, we also need an `apk-conf` file that d ``` -2. You will get the apk-conf file content as the response. Save this content into a file named `EmployeeService.apk-conf`. +2. You will get the apk-conf file content as the response. Save this content into a file named `EmployeeService.apk-conf`. You can edit these values as necessary. Let's change the basepath from the autogenerated value to "/employees-info". Your apk-conf file should now appear as follows. + +``` +--- +name: "EmployeeServiceAPI" +basePath: "/employees-info" +version: "3.14" +type: "REST" +defaultVersion: false +endpointConfigurations: + production: + endpoint: "http://employee-service:8080" +operations: +- target: "/employees" + verb: "GET" + secured: true + scopes: [] +- target: "/employee" + verb: "POST" + secured: true + scopes: [] +- target: "/employee/{employeeId}" + verb: "PUT" + secured: true + scopes: [] +- target: "/employee/{employeeId}" + verb: "DELETE" + secured: true + scopes: [] +``` !!! Important - We recommend installing the [APK Config Language Support Visual Studio Code (VS Code) extension]({{base_path}}/en/latest/api-management-overview/apk-conf-lang-support/) to edit the APK Configuration file. + We recommend installing the APK Config Language Support Visual Studio Code (VS Code) extension to edit the APK Configuration file. ### Deploy the API in APK DataPlane @@ -117,7 +148,7 @@ You now have the API Definition (`EmployeeServiceDefinition.json`) and the apk-c | apkConfiguration | `EmployeeService.apk-conf` file | :material-check: | | definitionFile | `EmployeeServiceDefinition.json` file | :material-check: | -2. Set the access token in the Authorization header as a bearer token. This is the access token received by following the steps under the ["Generate an access token to invoke APIs"](#generate-an-access-token-to-invoke-apis) section above. +2. Set the access token in the Authorization header as a bearer token. This is the access token received by following the steps under the Generate an access token to invoke APIs section above. 3. You can generate K8s resources as a zip file from config-deployer service using below command. @@ -151,10 +182,10 @@ You now have the API Definition (`EmployeeServiceDefinition.json`) and the apk-c The endpoint "http://employee-service:8080" provided in the above files points to a backend deployed on a kubernetes service. Prior to invoking the API, you will need to have this backend up. -We have provided the file containing this sample backend [here](../assets/files/get-started/employee-service-backend.yaml). Download it and create the backend service using the following command. +We have provided the file containing this sample backend [here](https://raw.githubusercontent.com/wso2/apk/main/developer/tryout/samples/qsg-sample-backend.yaml). You can create the backend service using the following command. ``` -kubectl apply -f ./employee-service-backend.yaml -n apk +kubectl apply -f https://raw.githubusercontent.com/wso2/apk/main/developer/tryout/samples/qsg-sample-backend.yaml -n apk ``` Wait for this pod to spin up. You can check its status using the following command. @@ -213,8 +244,25 @@ kubectl get pods -n apk 1. Use the following command to invoke the API using the access token generated in the previous step. ```bash - curl -X GET "https://carbon.super.gw.wso2.com:9095/RW1wbG95ZWVTZXJ2aWNlQVBJMy4xNA/3.14/employee" -H "Authorization: Bearer " -k + curl -X GET "https://carbon.super.gw.wso2.com:9095/employees-info/3.14/employees" -H "Authorization: Bearer " -k ``` You will now be able to see a successful response with the details of the Employees from the mock backend that we used for this guide. + \ No newline at end of file diff --git a/en/docs/get-started/quick-start-guide.md b/en/docs/get-started/quick-start-guide.md index b3d59fd1d..64cf37a2d 100644 --- a/en/docs/get-started/quick-start-guide.md +++ b/en/docs/get-started/quick-start-guide.md @@ -224,21 +224,21 @@ You now have the API Definition (`EmployeeServiceDefinition.json`) and the apk-c endpoint: "http://employee-service:8080" operations: - target: "/employees" - verb: "GET" - secured: true - scopes: [] + verb: "GET" + secured: true + scopes: [] - target: "/employee" - verb: "POST" - secured: true - scopes: [] + verb: "POST" + secured: true + scopes: [] - target: "/employee/{employeeId}" - verb: "PUT" - secured: true - scopes: [] + verb: "PUT" + secured: true + scopes: [] - target: "/employee/{employeeId}" - verb: "DELETE" - secured: true - scopes: [] + verb: "DELETE" + secured: true + scopes: [] ``` === "Request Format" ``` diff --git a/en/docs/includes/create-apk-conf-api.md b/en/docs/includes/create-apk-conf-api.md index 388bbcf7a..038b585d1 100644 --- a/en/docs/includes/create-apk-conf-api.md +++ b/en/docs/includes/create-apk-conf-api.md @@ -61,7 +61,7 @@ endpointConfigurations: production: endpoint: "http://employee-service:8080" operations: -- target: "/employee" +- target: "/employees" verb: "GET" secured: true scopes: [] diff --git a/en/docs/includes/start-apk-cp.md b/en/docs/includes/start-apk-cp.md index 008c97d35..3d2b72549 100644 --- a/en/docs/includes/start-apk-cp.md +++ b/en/docs/includes/start-apk-cp.md @@ -7,7 +7,6 @@ Follow the instructions below to deploy APK in the Kubernetes cluster. kubectl create ns apk ``` - ### Setup WSO2 API Manager Control Plane 4.4.0 Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. @@ -35,8 +34,7 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. helm install /wso2am-cp --version -f ``` -4. Install NGINX Ingress Controller using the following command. Please refer to the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/#local-development-clusters) documentation for more information. - +4. Install NGINX Ingress Controller. Please refer to the NGINX Ingress Controller documentation for more information. ### Setup WSO2 APK Dataplane 1.2.0 @@ -89,13 +87,12 @@ Setup WSO2 API Manager 4.4.0 in K8s cluster using Helm Charts. helm install /apim-apk-agent --version -f ``` - ### Verify the deployment Now you can verify the deployment by executing the following command. You will see the status of the pods of APK dataplane and APIM Control plane as follows once completed. === "Command" ``` - kubectl get pods + kubectl get pods -n apk ``` [![Pod Status](../assets/img/get-started/cp-podstatus.png)](../assets/img/get-started/cp-podstatus.png) \ No newline at end of file