1. Release Notes
    1. Release Notes - 2.0.2Latest
    1. Release Notes - 2.0.1
    1. Release Notes - 2.0.0
  1. Introduction
    1. Introduction
    1. Features
    1. Architecture
    1. Advantages
    1. Glossary
  1. Installation
    1. Intruction
      1. Intro
      2. Port Requirements
    1. Install on Linux
      1. All-in-One Installation
      2. Multi-Node Installation
      3. Installing HA Master and Etcd Cluster
      4. Storage Configuration Instruction
    1. Install on Kubernetes
      1. Prerequisites
      2. Online Installation
      3. Offline Installation
    1. Related Tools
      1. Integrating Harbor Registry
    1. Cluster Operation
      1. Adding New Nodes
      2. High Risk Operation
      3. Uninstalling KubeSphere
  1. Quick Start
    1. Getting Started with Multitenancy
    1. Exposing your APP using Ingress
    1. Deploying a MySQL Application
    1. Deploying a Wordpress Website
    1. Job to compute π to 2000 places
    1. Deploying Grafana using APP Template
    1. Creating Horizontal Pod Autoscaler
    1. S2i: Publish your app without Dockerfile
    1. Canary Release of Microservice APP
    1. CI/CD based on Spring Boot Project
    1. Building a Pipeline in a Graphical Panel
    1. CI/CD based on GitLab and Harbor
    1. Ingress-Nginx for Grayscale Release
  1. Cluster Admin Guide
    1. Multi-tenant Management
      1. Overview of Multi-tenant Management
      2. Overview of Role Management
    1. Platform Management
      1. Account Management
      2. Platform Roles Management
    1. Infrastructure
      1. Service Components
      2. Nodes
      3. Storage Classes
    1. Monitoring Center
      1. Physical Resources
      2. Application Resources
    1. Application Repository
    1. Jenkins System Settings
  1. User Guide
    1. Application Template
    1. Workloads
      1. Deployments
      2. StatefulSets
      3. DaemonSets
      4. Jobs
      5. CronJobs
    1. Storage
      1. Volumes
    1. Network & Services
      1. Services
      2. Routes
    1. Configuration Center
      1. Secret
      2. ConfigMap
      3. Image Registry
    1. Project Settings
      1. Basic Information
      2. Member Roles
      3. Project Members
      4. Internet Access
    1. DevOps Project
      1. DevOps Project Management
      2. DevOps Project Management
      3. DevOps Project Management
      4. DevOps Project Management
      5. DevOps Project Management
  1. Development Guide
    1. Preparing the Development Environment
    1. Development Workflow
  1. API Documentation
    1. API Guide
    1. How to invoke KubeSphere API
KubeSphere®️ 2020 All Rights Reserved.


A Service is an abstraction which defines a logical set of Pods and a policy by which to access them - sometimes called a micro-service. As an example, consider an image-processing backend which is running with 3 replicas. Those replicas are fungible - frontends do not care which backend they use. While the actual Pods that compose the backend set may change, the frontend clients should not need to be aware of that or keep track of the list of backends themselves.

Create a Service

Sign in with project-regular, enter into one project (e.g. demo-namespace), then select Network & Services → Services.

Create a Service

Step 1: Fill in the Basic Information

1.1. Click Create Service button, then fill in the basic information in the pop-up window. There are two ways to create a Service, i.e. fill in the creation table and edit mode. The following mainly introduces each step within creation table. If you prefer edit mode, you can click on the edit mode button, it supports the yaml and json formats. Edit mode makes it easy for users who are used to command operations.

Edit mode

1.2. On the basic information page, enter the name of the Service, you can also fill in the description as required.

  • Name: A concise and clear name for this Service, which is convenient for users to browse and search.
  • Alias: Helps you better distinguish resources and supports Chinese.
  • Description: A brief introduction to Service.

Click Next when you're done.

Basic information

Step 2: Service Settings

2.1. Select the type of service you need to create, each service type is suitable for different scenarios:

  • Virtual IP: Exposes the service on a cluster-internal IP. Choosing this value makes the service only reachable from within the cluster.
  • Headless (Selector): For headless services that define selectors, the endpoints controller creates Endpoints records in the API, and modifies the DNS configuration to return A records (addresses) that point directly to the Pods backing the Service.
  • Headless (ExternalName): Services of type ExternalName map a service to a DNS name, not to a typical selector. It maps the service to the contents of the externalName field (e.g. foo.bar.example.com), by returning a CNAME record with its value.

2.2. If you choose Virtual IP or Headless (Selector), then you will need to fill in the following table:

  • Selector: Choose the backend workload via label selector (key-values) or specify directly,
  • Ports: using TCP by default, the first port is service port, and the target port is the workload port.
  • Session Affinity

    • None: The default value, If you create “headless” services by specifying "None" for the cluster IP, it allows developers to reduce coupling to the Kubernetes system by allowing them freedom to do discovery their own way.
    • ClientIP: Access requests from the same IP address will always be forwarded to the same backend Pod.

2.3. If you choose Headless (externalname), which means it will map a service to a DNS name, not to a typical selector.

Step 3: Label Settings

The labels are one or more key-value pairs that are associated with a resource, such as a Pod. We usually identify, organize, or find resource objects through labels, e.g. label selector.

Label Settings

Step 4: Internet Access

If you choose Virtual IP as the service type, then you need to choose one of the access

  • None: Exposes the service on a cluster-internal IP. Choosing this value makes the service only reachable from within the cluster.
  • NodePort: Exposes the service on each Node’s IP at a static port (the NodePort). A ClusterIP service, to which the NodePort service will route, is automatically created. You’ll be able to contact the NodePort service, from outside the cluster, by requesting <NodeIP>:<NodePort>.
  • LoadBalancer: Exposes the service externally using a cloud provider’s load balancer. NodePort and ClusterIP services, to which the external load balancer will route, are automatically created.

Note: It requires to install the cloud provider plugin if using the Load Balancer that is connected to the cloud provider. The QingCloud Controller Manager Plugin is still in the development stage and will be coming soon. You will be able to use Load Balancer to expose the service to external network after it gets ready.

Internet Access

Once created successfully, you can view the details of the service in the list.