Merge pull request #723 from Sherlock113/cnsource

Add project gateway en source file for cn
This commit is contained in:
pengfei 2020-12-09 19:18:53 +08:00 committed by GitHub
commit ebac1ab2ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,10 +1,72 @@
---
title: "Project Gateway"
keywords: 'KubeSphere, kubernetes, docker, helm, jenkins, istio, prometheus'
description: 'Project Gateway'
keywords: 'KubeSphere, Kubernetes, project, gateway, NodePort, LoadBalancer'
description: 'How to set a project gateway in KubeSphere.'
linkTitle: "Project Gateway"
weight: 13500
---
TBD
A gateway in a KubeSphere project is an [NGINX Ingress controller](https://www.nginx.com/products/nginx/kubernetes-ingress-controller). KubeSphere has a builtin configuration for HTTP load balancing, called [Routes](../../project-user-guide/application-workloads/ingress/). A Route defines rules for external connections to Services within a cluster. Users who need to provide external access to their Services create a Route resource that defines rules, including the URI path, backing service name, and other information.
In KubeSphere 3.0, a project gateway works independently for itself. In other words, every project has its own Ingress controller. In the next release, KubeSphere will provide a cluster-scope gateway in addition to the project-scope gateway, allowing all projects to share the same gateway.
This tutorial demonstrates how to set a gateway in KubeSphere for the external access to Services and Routes.
## Prerequisites
You need to create a workspace, a project and an account (`project-admin`). The account must be invited to the project with the role of `admin` at the project level. For more information, see [Create Workspace, Project, Account and Role](../../../docs/quick-start/create-workspace-and-project).
## Set a Gateway
1. Log in the KubeSphere web console as `project-admin` and go to your project. In **Project Settings** from the navigation bar, select **Advanced Settings** and click **Set Gateway**.
![set-project-gateway](/images/docs/project-administration/project-gateway/set-project-gateway.jpg)
2. In the pop-up window, you can select two access modes for the gateway.
![access-method](/images/docs/project-administration/project-gateway/access-method.png)
**NodePort**: You can access Services with corresponding node ports through the gateway.
**LoadBalancer**: You can access Services with a single IP address through the gateway.
3. You can also enable **Application Governance** on the **Set Gateway** page. You need to enable **Application Governance** so that you can use the Tracing feature and use [different grayscale release strategies](../../project-user-guide/grayscale-release/overview/). Once it is enabled, check whether an annotation (e.g. `nginx.ingress.kubernetes.io/service-upstream: true`) is added for your route (Ingress) if the route is inaccessible.
4. After you select an access method, click **Save**.
## NodePort
If you select **NodePort**, KubeSphere will set a port for http and https requests respectively. You can access your Service at `EIP:NodePort` or `Hostname:NodePort`.
![nodeport](/images/docs/project-administration/project-gateway/nodeport.jpg)
For example, to access your Service with an elastic IP address (EIP), visit:
- `http://EIP:32734`
- `https://EIP:32471`
When you create a [Route](../../project-user-guide/application-workloads/ingress/) (Ingress), you can customize a host name to access your Service. For example, to access your Service with the host name set in your Route, visit:
- `http://demo.kubesphere.io:32734`
- `https://demo.kubesphere.io:32471`
{{< notice note >}}
- You may need to open ports in your security groups and configure relevant port forwarding rules depending on your environment.
- If you access your Service using the host name, make sure the domain name you set can be resolved to the IP address.
- **NodePort** is not recommended for a production environment. You can use **LoadBalancer** instead.
{{</ notice >}}
## LoadBalancer
You must configure a load balancer in advance before you select **LoadBalancer**. The IP address of the load balancer will be bound to the gateway to provide access to internal Services and Routes.
![lb](/images/docs/project-administration/project-gateway/lb.png)
{{< notice note >}}
Cloud providers often support load balancer plugins. If you install KubeSphere on major Kubernetes engines on their platforms, you may notice a load balancer is already available in the environment for you to use. If you install KubeSphere in a bare metal environment, you can use [Porter](https://github.com/kubesphere/porter) for load balancing.
{{</ notice >}}