Skip to content

Commit

Permalink
Merge pull request #1718 from Mariangela/master-MH2
Browse files Browse the repository at this point in the history
fixes #1717 and typos
  • Loading branch information
RAVEENSR committed Aug 15, 2020
2 parents 7cb1f42 + ab34dc9 commit 3bc8a15
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 20 deletions.
@@ -1,16 +1,14 @@

# Enabling PrivateJet Mode to Deploy APIs

In an age where more and more applications are adopting the microservice architecture, it is obvious that container-orchestration systems such as Kubernetes have gained popularity due to the attractive functionalities they offer to simplify a number of complex management tasks.
Automating computer application deployment, scaling, and management are a few of such functionalities to name. WSO2 API Manager provides cloud-native API management, where a user is able to expose microservices as managed APIs in cloud environment such as Kubernetes.
This could be done with the support of WSO2-Kubernetes API Operator.

![Architecture](https://github.com/wso2/k8s-api-operator/blob/master/docs/HowToGuide/working-with-deployment-modes.md#private-jet-mode)
![Architecture](https://raw.githubusercontent.com/wso2/k8s-api-operator/master/docs/images/privatejet-mode.png)

Microservices will be exposed as managed APIs in cloud clusters in the PrivetJet mode. Here, each microservice wll have a dedicated [WSO2 API Microgateway](https://wso2.com/api-management/api-microgateway/). This will provide maximum security and guaranteed resource allocation for API execution. As depicted in the above diagram, When the APIs published via API-Manager in cloud environments,
deployment, scaling, and management tasks will handle by the WSO2 -Kubernetes API Operator itself.
Microservices will be exposed as managed APIs in cloud clusters in the PrivetJet mode. Here, each microservice will have a dedicated [WSO2 API Microgateway](https://wso2.com/api-management/api-microgateway/). This will provide maximum security and guaranteed resource allocation for API execution. As depicted in the above diagram, when the APIs published via API-Manager in cloud environments, deployment, scaling, and management tasks will handle by the WSO2 -Kubernetes API Operator itself.

## Enabling PrivateJet mode
## Enabling PrivateJet mode

Follow the steps below to enable PrivateJet mode to deploy APIs as managed APIs in cloud clusters. (Ex: Kubernetes)

Expand Down Expand Up @@ -119,7 +117,7 @@ Follow the steps below to enable PrivateJet mode to deploy APIs as managed APIs

v. Obtaining the master URL

In order to establish the connection with the cluster need to obtain the Master URL. this be done by executing following command.
Execute the following command to obtain the Master URL for the purpose of establishing a connection with the cluster.

kubectl cluster-info

Expand Down
Expand Up @@ -2,14 +2,16 @@

As microservices are increasingly being deployed on Kubernetes, the need to expose these microservices as well documented, easy to consume, managed APIs is becoming important to develop great applications. The API operator for Kubernetes makes APIs a first-class citizen in the Kubernetes ecosystem. Similar to deploying microservices, you can now use this operator to deploy APIs for individual microservices or compose several microservices into individual APIs. With this users will be able to expose their microservice as managed API in Kubernetes environment without any additional work.

![With and without K8s API Operator]({{base_path}}/assets/img/learn/kubernetes-operators/with-and-withou-k8s-api-operator.png)
[![With and without K8s API Operator]({{base_path}}/assets/img/learn/kubernetes-operators/with-and-withou-k8s-api-operator.png)]({{base_path}}/assets/img/learn/kubernetes-operators/with-and-withou-k8s-api-operator.png)

## Quick Start Guide
Follow the quick start [here](https://github.com/wso2/k8s-api-operator/blob/v1.1.0/README.md).

## Kubernetes API Operator Doc space
Follow the Kubernetes API Operator documentation space [here](https://github.com/wso2/k8s-api-operator/tree/v1.1.0/docs)
[Quick Start Guide v1.1.0](https://github.com/wso2/k8s-api-operator/blob/v1.1.0/README.md).

## Kubernetes API Operator doc space

[Kubernetes API Operator documentation space](https://github.com/wso2/k8s-api-operator/tree/v1.1.0/docs)

## Install K8s API Operator using Operator HUB
## Install K8s API Operator using OperatorHub.io

Follow the installation instructions in [operator hub](https://operatorhub.io/operator/api-operator).
For information, see the installation instructions in the [OperatorHub.io](https://operatorhub.io/operator/api-operator).
12 changes: 7 additions & 5 deletions en/docs/learn/kubernetes-operators/k8s-wso2am-operator.md
Expand Up @@ -3,11 +3,13 @@
With WSO2 API Manager Operator, it makes easy to deploy WSO2 API Manager in Kubernetes through a simple command. Also it supports deploying recommended deployment patterns in Kubernetes. Introducing a new Custom Resource Definition called APIManager to efficiently and easily deploy patterns, and custom patterns in Kubernetes.
![WSO2 API Manager Operator CRDs workflow]({{base_path}}/assets/img/learn/kubernetes-operators/wso2am-operator-crds-workflow.png)

## Quick Start Guide
Follow the quick start [here](https://github.com/wso2/k8s-wso2am-operator/tree/v1.0.0#quick-start-guide).
## Quick start guide

## WSO2 API Manager Operator Doc space
Follow the WSO2 API Manager Operator documentation space [here](https://github.com/wso2/k8s-wso2am-operator/tree/v1.0.0/docs)
[WSO2 API Manager Operator v1.0.0 Quick Start guide](https://github.com/wso2/k8s-wso2am-operator/tree/v1.0.0#quick-start-guide).

## WSO2 API Manager Operator doc space
[WSO2 API Manager Operator v1.0.0 documentation space](https://github.com/wso2/k8s-wso2am-operator/tree/v1.0.0/docs)

## Install K8s WSO2 API Manager Operator
Follow the installation instructions in [operator hub](https://operatorhub.io/operator/wso2am-operator).

For information, see the installation instructions in [OperatorHub.io](https://operatorhub.io/operator/wso2am-operator).
6 changes: 3 additions & 3 deletions en/mkdocs.yml
Expand Up @@ -43,7 +43,7 @@ theme:
tabs: true
language: 'en'
#Breaks build if there's a warning
strict: false
strict: true
# Navigation
nav:
- Welcome to WSO2 API Manager Documentation: index.md
Expand Down Expand Up @@ -293,8 +293,8 @@ nav:
- Configuring Different Endpoint Types: learn/api-controller/advanced-topics/configuring-different-endpoint-types.md
- Kubernetes Operators:
- K8s API Operator:
- K8s API Operator Overview: learn/kubernetes-operators/k8s-api-operator.md
- Enabling PrivateJet Mode to Deploy APIs: learn/kubernetes-operators/K8s API Operator/enabling-privatejet-mode-to-deploy-apis.md
- K8s API Operator Overview: learn/kubernetes-operators/k8s-api-operator/k8s-api-operator.md
- Enabling PrivateJet Mode to Deploy APIs: learn/kubernetes-operators/k8s-api-operator/enabling-privatejet-mode-to-deploy-apis.md
- K8s WSO2 API Manager Operator: learn/kubernetes-operators/k8s-wso2am-operator.md
- Tutorials:
- Create and Publish a GraphQL API: learn/tutorials/create-and-publish-a-graphql-api.md
Expand Down

0 comments on commit 3bc8a15

Please sign in to comment.