Cluster Gateway

    You need to prepare a user with the role, for example, admin. For more information, see Create Workspaces, Projects, Users and Roles.

    1. Log in to the KubeSphere web console as . Click Platform in the upper-left corner and select Cluster Management.

    2. Go to Gateway Settings under Cluster Settings from the navigation pane, select the Cluster Gateway tab, and click Enable Gateway.

    3. In the displayed dialog box, select an access mode for the gateway from the following two options:

      • NodePort: Access Services with corresponding node ports through the gateway. The NodePort access mode provides the following configurations:
        • Tracing: Turn on the Tracing toggle to enable the Tracing feature on KubeSphere. Once it is enabled, check whether an annotation (for example, nginx.ingress.kubernetes.io/service-upstream: true) is added for your route when the route is inaccessible. If not, add an annotation to your route.
        • Configuration Options: Add key-value pairs to the cluster gateway.
      • To use the Tracing feature, turn on Application Governance when you create composed applications.
      • For more information about how to use configuration options, see .

    4. Click OK to create the cluster gateway.

    5. The cluster gateway created is displayed and the basic information of the gateway is also shown on the page.

      Note

      A gateway named kubesphere-router-kubesphere-system is also created, which serves as a global gateway for all projects in your cluster.

      • View Details: Go to the details page of the cluster gateway.
      • Disable: Disable the cluster gateway.
    7. After a cluster gateway is created, see Routes for more information about how to create a route.
    1. Under the Cluster Gateway tab, click Manage on the right of a cluster gateway and select View Details to open its details page.
    2. On the details page, click Edit to edit configurations of the cluster gateway or click More to select an operation.
    3. Click the Monitoring tab to view the monitoring metrics of the cluster gateway.
    4. Click the Configuration Options tab to view configuration options of the cluster gateway.
    5. Click the Gateway Logs tab to view logs of the cluster gateway.
    6. Click the Resource Status tab to view workload status of the cluster gateway. Click or Cluster Gateway - 图2 to scale up or scale down the number of replicas.
    7. Click the Metadata tab to view annotations of the cluster gateway.

    On the Gateway Settings page, click the Project Gateway tab to view project gateways.

    Click on the right of a project gateway to select an operation from the drop-down menu:

    • Edit: Edit configurations of the project gateway.

    Note

    If a project gateway exists prior to the creation of a cluster gateway, the project gateway address may switch between the address of the cluster gateway and that of the project gateway. It is recommended that you should use either the cluster gateway or project gateway.