From 5213da51c9cdf3aed93a714cf5686c5e392956bf Mon Sep 17 00:00:00 2001 From: sgayangi Date: Fri, 8 Nov 2024 16:50:55 +0530 Subject: [PATCH] Update documentation format --- en/docs/get-started/quick-start-guide.md | 6 ++--- en/docs/includes/start-apk-cp.md | 2 +- en/docs/setup/prerequisites.md | 32 +++++++++++------------- 3 files changed, 19 insertions(+), 21 deletions(-) diff --git a/en/docs/get-started/quick-start-guide.md b/en/docs/get-started/quick-start-guide.md index 4076361eb..d2b21246e 100644 --- a/en/docs/get-started/quick-start-guide.md +++ b/en/docs/get-started/quick-start-guide.md @@ -118,7 +118,7 @@ Apart from the above API definition file, we also need an `apk-conf` file that d ``` --- name: "EmployeeServiceAPI" -basePath: "/employees" +basePath: "/employees-info" version: "3.14" type: "REST" defaultVersion: false @@ -215,7 +215,7 @@ You now have the API Definition (`EmployeeServiceDefinition.json`) and the apk-c --- id: "3940857a942e08686e58b511d43d046a7168281e" name: "EmployeeServiceAPI" - basePath: "/employees" + basePath: "/employees-info" version: "3.14" type: "REST" defaultVersion: false @@ -267,7 +267,7 @@ Now the API is ready to be invoked. Let’s get the list of employees by invokin === "Sample Request" ``` - curl -k --location 'https://default.gw.wso2.com:9095/employees/3.14/employees' \ + curl -k --location 'https://default.gw.wso2.com:9095/employees-info/3.14/employees' \ --header 'Host: default.gw.wso2.com' \ --header 'Authorization: bearer eyJhbGciOiJSUzI1NiIsICJ0eXAiOiJKV1QiLCAia2lkIjoiZ2F0ZXdheV9jZXJ0aWZpY2F0ZV9hbGlhcyJ9.eyJpc3MiOiJodHRwczovL2lkcC5hbS53c28yLmNvbS90b2tlbiIsICJzdWIiOiI0NWYxYzVjOC1hOTJlLTExZWQtYWZhMS0wMjQyYWMxMjAwMDIiLCAiZXhwIjoxNjg4MTMxNDQ0LCAibmJmIjoxNjg4MTI3ODQ0LCAiaWF0IjoxNjg4MTI3ODQ0LCAianRpIjoiMDFlZTE3NDEtMDA0Ni0xOGE2LWFhMjEtYmQwYTk4ZjYzNzkwIiwgImNsaWVudElkIjoiNDVmMWM1YzgtYTkyZS0xMWVkLWFmYTEtMDI0MmFjMTIwMDAyIiwgInNjb3BlIjoiZGVmYXVsdCJ9.RfKQq2fUZKZFAyjimvsPD3cOzaVWazabmq7b1iKYacqIdNjkvO9CQmu7qdtrVNDmdZ_gHhWLXiGhN4UTSCXv_n1ArDnxTLFBroRS8dxuFBZoD9Mpj10vYFSDDhUfFqjgMqtpr30TpDMfee1wkqB6K757ZSjgCDa0hAbv555GkLdZtRsSgR3xWcxPBsIozqAMFDCWoUCbgTQuA5OiEhhpVco2zv4XLq2sz--VRoBieO12C69KnGRmoLuPtvOayInvrnV96Tbt9fR0fLS2l1nvAdFzVou0SIf9rMZLnURLVQQYE64GR14m-cFRYdUI9vTsFHZBl5w-uCLdzMMofzZaLQ' ``` diff --git a/en/docs/includes/start-apk-cp.md b/en/docs/includes/start-apk-cp.md index db79879a6..008c97d35 100644 --- a/en/docs/includes/start-apk-cp.md +++ b/en/docs/includes/start-apk-cp.md @@ -35,7 +35,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 documentation for more information. +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. ### Setup WSO2 APK Dataplane 1.2.0 diff --git a/en/docs/setup/prerequisites.md b/en/docs/setup/prerequisites.md index 0397914ce..3d5ad3506 100644 --- a/en/docs/setup/prerequisites.md +++ b/en/docs/setup/prerequisites.md @@ -1,11 +1,8 @@ # Prerequisites -To successfully deploy WSO2 APK in your environment, you’ll need a Kubernetes cluster, a Kubernetes client (`kubectl`), and Helm for package management. Below, we outline the supported versions of each tool to ensure compatibility with APK. If you have not setup any of these tools, refer to the [sections](#1-set-up-a-kubernetes-cluster) provided below to set them up. - -### Kubernetes - -To deploy WSO2 APK, your environment must meet specific requirements across managed Kubernetes services, resource allocations, and supported Kubernetes distributions. Each section below outlines these requirements for a successful deployment. +To successfully deploy WSO2 APK in your environment, you’ll need a Kubernetes cluster, a Kubernetes client (`kubectl`), and Helm for package management. Additionally, your environment must meet specific requirements across managed Kubernetes services, resource allocations, and supported Kubernetes distributions. Each section below outlines these requirements for a successful deployment. +### Supported Versions #### Managed Kubernetes Services WSO2 APK supports several managed Kubernetes services. To ensure compatibility, verify that your service’s Kubernetes version falls within the specified range. @@ -27,7 +24,15 @@ WSO2 APK is compatible with a variety of Kubernetes distributions. Check the com | Kind | 1.26.3 - 1.30.3 | 0.24.0 | | OpenShift | 1.28 | 4.15 | -#### Resource Requirements +#### Helm + +Below is the version requirement for Helm to be compatible with WSO2 APK. + +| Package Manager | Version | +| --------------- | --------------- | +| Helm | 3.10.0 - 3.16.1 | + +### Resource Requirements We recommend the following minimum resource requirements for running WSO2 APK on a Kubernetes cluster. These requirements are based on whether you are deploying the APK Data Plane only or with the APIM Control Plane as well. @@ -47,23 +52,16 @@ We recommend the following minimum resource requirements for running WSO2 APK on | Memory | 8 GB | | Storage | 15 GB | -#### Helm - -Below is the version requirement for Helm to be compatible with WSO2 APK. - -| Package Manager | Version | -| --------------- | --------------- | -| Helm | 3.10.0 - 3.16.1 | - -## 1. Set up a Kubernetes Cluster +### Steps to Follow +#### 1. Set up a Kubernetes Cluster Refer to the Kubernetes documentation to set up a Kubernetes cluster. -## 2. Install the Kubernetes Client (`kubectl`) +#### 2. Install the Kubernetes Client (`kubectl`) Refer to the Kubernetes documentation to install the `kubectl` client. -## 3. Install Helm +#### 3. Install Helm Refer to the Helm documentation to install Helm.