Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1.0.0] wso2 APK-docs updated administration and about-apk #672

Open
wants to merge 6 commits into
base: 1.0.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions en/docs/about-apk/about-this-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

The APK release notes provide an overview of the latest updates, improvements, and bug fixes in the WSO2 APK platform. These release notes are a valuable resource for developers and organizations using the platform, as they can help them stay up-to-date on the latest features and fixes. With each release, WSO2 aims to improve the performance, reliability, and usability of the APK platform, while also introducing new functionality and addressing any issues reported by users. The release notes typically include a summary of the changes made, along with any important information about compatibility, installation, and configuration. By keeping up with the APK release notes, users can ensure that they are taking full advantage of the platform's capabilities and staying ahead of any potential issues.

## Fixed issues
For all the fixed issues in WSO2 APK 1.2.0, go to [APK](https://github.com/wso2/apk/issues?q=is%3Aissue+is%3Aclosed+closed%3A2024-04-10..2024-10-29).

## Known issues
For all the known issues in WSO2 APK 1.2.0, go to APK.

## Release Notes

For more information on each of the APK releases, go to [Releases](https://github.com/wso2/apk/releases) on the APK product repository in GitHub.
Expand Down
12 changes: 8 additions & 4 deletions en/docs/about-apk/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,24 @@ APK is an open-source platform for providing complete API Management capabilitie

To support cloud native Kubernetes environments, the platform’s deployment consists of data plane components.

**The Data Plane** is responsible for handling the runtime design, processing API requests, and applying API management quality of services. It’s designed to handle high volume, real-time data processing and includes functions for routing, rate limiting, and security. The APK runtime consists of three main sub-components:
**The Data Plane** is responsible for handling the runtime design, processing API requests, and applying API management quality of services.It’s designed to handle high volume, real-time data processing and includes functions for routing, rate limiting, and security. The APK runtime consists of three main sub-components:
- The Runtime Manager is responsible for configuring the runtime aspects of APIs, discovering Kubernetes services, and converting them into APIs.
- The Management Client communicates with the management server (control plane) to push and pull updates and maintain connectivity between the data plane and the control plane.
- The API Gateway has two main components. The Router intercepts incoming API traffic and applies quality of service such as authentication, authorization, and rate limiting. Meanwhile, the Enforcer enforces API management capabilities, such as security, rate limiting, analytics, validation, etc.
- Redis and Envoy Rate Limiter components are deployed to manage and throttle traffic within the dataplane. These components effectively address the requirements for traffic management and enable fine-grained control of API traffic. By using these components, organizations can ensure that their APIs are protected from overuse, while also providing an optimized user experience.

The dataplane components are primarily used by individuals who invoke APIs and make use of their functionality. When a user invokes an API, it first enters the router component, which serves as the main entry point. The router identifies resources and matched APIs and then connects with the enforcer to authenticate the API request. Rate limit policies and other API-level policies are then applied to the request.
The dataplane components are primarily used by individuals who invoke APIs and make use of their functionality.
When a user invokes an API, it first enters the router component, which serves as the main entry point. The router identifies resources and matched APIs and then connects with the enforcer to authenticate the API request. Rate limit policies and other API-level policies are then applied to the request.
Once the gateway processing is complete, the request is passed to the backend service, and similarly, API policies can be executed in the response path as well. Since the dataplane is responsible for handling the majority of the load when users consume APIs, it is essential to plan carefully to ensure proper scaling of the deployment with load.


# Deployment Architecture
The APK product offers a highly flexible deployment architecture that is suitable for modern cloud native deployments. There are various deployment options available to users, including a multi-cluster deployment model, where each region has its own cluster running the APK dataplane, and these dataplanes are connected to a central control plane through a global network. This ensures high availability and disaster recovery scenarios, preventing an outage in one region from impacting the availability of the entire system.
- The APK product offers a highly flexible deployment architecture that is suitable for modern cloud native deployments.
- There are various deployment options available to users, including a multi-cluster deployment model, where each region has its own cluster running the APK dataplane, and these dataplanes are connected to a central control plane through a global network.
- This ensures high availability and disaster recovery scenarios, preventing an outage in one region from impacting the availability of the entire system.

To support these deployment models, APK utilizes Kubernetes features such as node selectors, affinity, and anti-affinity rules, to schedule pods in the appropriate region. This approach provides organizations with the flexibility to deploy the APK platform across different data centers, clusters within the same data center, or different mega clouds, based on their requirements.
- To support these deployment models, APK utilizes Kubernetes features such as node selectors, affinity, and anti-affinity rules, to schedule pods in the appropriate region.
- This approach provides organizations with the flexibility to deploy the APK platform across different data centers, clusters within the same data center, or different mega clouds, based on their requirements.

Moreover, APK also provides a flexible solution for different departments or lines of business within an organization to have their own deployments. This can be achieved by using Kubernetes cluster or namespaces to create isolated environments for each department or line of business, with their API gateway instances and custom configurations. Each department can have its own set of resources, such as pods, services, and ingress controllers, that are managed independently of other clusters or namespaces. This approach allows for better control over resource allocation and access control, enabling each department or line of business to deploy and manage their APIs as per their preferences.

Expand Down
18 changes: 12 additions & 6 deletions en/docs/about-apk/what-is-apk.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# What is APK?

Cloud native API management is a way to manage and govern APIs in a more effective and efficient manner by leveraging the benefits of cloud computing. This involves using API management tools and practices that are natively integrated with cloud environments, such as Kubernetes. WSO2 APK is an API management platform that has been designed specifically for cloud environments. It is built on a microservices architecture that allows developers to build, deploy, and manage APIs with enhanced scalability and flexibility. With features like automatic failover and load balancing, our platform is highly available and can handle a large number of API requests without performance degradation. Additionally, WSO2 APK supports continuous delivery and deployment, allowing you to quickly and easily push updates to your API services. Our platform supports the entire API lifecycle, from API design and development to developer portal, API gateway, and marketplace capabilities. Furthermore, we have added key architectural features that are specifically designed for Kubernetes environments, including automatic API discovery and the ability to operate within Kubernetes namespaces and clusters, all without compromising security.
* Cloud native API management is a way to manage and govern APIs in a more effective and efficient manner by leveraging the benefits of cloud computing.
* This involves using API management tools and practices that are natively integrated with cloud environments, such as Kubernetes. WSO2 APK is an API management platform that has been designed specifically for cloud environments.
* It is built on a microservices architecture that allows developers to build, deploy, and manage APIs with enhanced scalability and flexibility. With features like automatic failover and load balancing, our platform is highly available and can handle a large number of API requests without performance degradation. Additionally, WSO2 APK supports continuous delivery and deployment, allowing you to quickly and easily push updates to your API services.
* Our platform supports the entire API lifecycle, from API design and development to developer portal, API gateway, and marketplace capabilities. Furthermore, we have added key architectural features that are specifically designed for Kubernetes environments, including automatic API discovery and the ability to operate within Kubernetes namespaces and clusters, all without compromising security.

Following are some of the benefits of APK:
- WSO2 APK is built as a cloud native solution, making it more scalable and better suited for cloud-based environments.
- With the ability to deploy on any Kubernetes-based infrastructure, WSO2 APK provides more flexibility and portability.
- The platform is designed to work seamlessly with DevOps tools and processes, enabling teams to rapidly develop and deploy APIs.
- APK platform is a 100% open source solution released under Apache 2.0 license which allows users to use it as they prefer.
* WSO2 APK is built as a cloud native solution, making it more scalable and better suited for cloud-based environments.

Moreover, WSO2 APK is built with a microservices architecture that enables developers to build, deploy, and manage APIs more efficiently and with greater flexibility. Additionally, because the various components (including the developer portal, admin service, and publisher) are implemented as separate microservices, the platform supports customization and scaling without affecting the system as a whole. This design makes it possible to add or remove functions and update individual components with ease.
* With the ability to deploy on any Kubernetes-based infrastructure, WSO2 APK provides more flexibility and portability.

* The platform is designed to work seamlessly with DevOps tools and processes, enabling teams to rapidly develop and deploy APIs.

* APK platform is a 100% open source solution released under Apache 2.0 license which allows users to use it as they prefer.

* Moreover, WSO2 APK is built with a microservices architecture that enables developers to build, deploy, and manage APIs more efficiently and with greater flexibility. Additionally, because the various components (including the developer portal, admin service, and publisher) are implemented as separate microservices, the platform supports customization and scaling without affecting the system as a whole. This design makes it possible to add or remove functions and update individual components with ease.


## Characteristics of APK
Expand Down
4 changes: 2 additions & 2 deletions en/docs/setup/Customize-Configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To customize configurations in the Helm deployment, you need to create and modif

=== "Command"
```
helm show values wso2apk/apk-helm --version 1.0.0 > values.yaml
helm show values wso2apk/apk-helm --version 1.2.0 > values.yaml
```

=== "Format"
Expand All @@ -24,7 +24,7 @@ To customize configurations in the Helm deployment, you need to create and modif

=== "Command"
```
helm install apk-test wso2apk/apk-helm --version 1.0.0 -f values.yaml
helm install apk-test wso2apk/apk-helm --version 1.2.0 -f values.yaml
```

=== "Format"
Expand Down