Using kubectl to Create a LoadBalancer Ingress

Scenario

An Nginx workload is used as an example to describe how to create a LoadBalancer Ingress using kubectl.

• If no load balancer is available in the same VPC, CCE can automatically create a load balancer when you create an ingress. For details, see Creating an Ingress with an Automatically Created Load Balancer.
• If a load balancer is available in the same VPC, refer to Creating an Ingress with an Existing Load Balancer.

Prerequisites

• A workload is available in the cluster (because an Ingress enables network access for workloads). If no workload is available, deploy an Nginx workload by referring to Creating a Workload.
• A Service has been configured for the workload.
• Dedicated load balancers can route HTTP/HTTPS traffic at the application layer, and each of them has a private IP address bound.

Creating an Ingress with an Automatically Created Load Balancer

The following describes how to run the kubectl command to automatically create a load balancer when creating an Ingress.

1. Use kubectl to connect to the cluster. For details, see Connecting to a Cluster Using kubectl.
2. Create a YAML file named ingress-test.yaml. The file name can be customized.

   vi ingress-test.yaml

   Example of using a dedicated load balancer on a public network:

   apiVersion: networking.k8s.io/v1
   kind: Ingress
   metadata:
     name: ingress-test
     namespace: default
     annotations:
       kubernetes.io/elb.class: performance
       kubernetes.io/elb.port: '80'
       kubernetes.io/elb.autocreate: 
         '{
             "type": "public",
             "bandwidth_name": "cce-bandwidth-******",
             "bandwidth_chargemode": "bandwidth",
             "bandwidth_size": 5,
             "bandwidth_sharetype": "PER",
             "eip_type": "5_bgp",
             "elb_virsubnet_ids":["*****"],
             "available_zone": [
                 "ap-southeast-1a"
             ],
             "l7_flavor_name": "L7_flavor.elb.s1.small"
          }'
   spec:
     rules: 
     - host: ''
       http: 
         paths: 
         - path: '/'
           backend: 
             service:
               name: <your_service_name>  # Replace it with the name of your target Service.
               port: 
                 number: <your_service_port>  # Replace it with the port number of your target Service.
           property:
             ingress.beta.kubernetes.io/url-match-mode: STARTS_WITH
           pathType: ImplementationSpecific
     ingressClassName: cce

   Table 1 Key parameters

   Parameter	Mandatory	Type	Description
   kubernetes.io/elb.class	Yes	String	The value can be: performance: dedicated load balancer
   ingressClassName	Yes	String	cce: A LoadBalancer Ingress is used. This parameter is mandatory when an Ingress is created by calling the API.
   kubernetes.io/elb.port	No	Integer	This parameter indicates the external port registered with the address of the LoadBalancer Service. The value ranges from 1 to 65535. The default value is 80 for HTTP and 443 for HTTPS. NOTE: Some ports are high-risk ports and are blocked by default, for example, port 21.
   kubernetes.io/elb.subnet-id	No	String	ID of the subnet where the cluster is located. The value can contain 1 to 100 characters. For details, see What Are the Differences Between the VPC Subnet API and the OpenStack Neutron Subnet API?
   kubernetes.io/elb.enterpriseID	No	String	ID of the enterprise project for the load balancer. It is only applicable to enterprise accounts with enterprise projects enabled. After an enterprise project ID is selected, resources can be created in the ELB enterprise project. The value contains 1 to 100 characters. How to obtain: Log in to the EPS console, click the name of the target enterprise project. On the enterprise project details page, find the ID field and copy the ID.
   kubernetes.io/elb.autocreate	Yes	elb.autocreate object	Whether to automatically create a load balancer associated with an Ingress. For details about the field description, see Table 2. Example Automatically created dedicated load balancer with an EIP bound: '{"type":"inner","available_zone":["*****"],"elb_virsubnet_ids":["*****"],"l7_flavor_name":"L7_flavor.elb.pro.max","l4_flavor_name":"","vip_subnet_cidr_id":"*****"}' Automatically created dedicated load balancer with no EIP bound: {"type":"inner","name":"A-location-d-test"}
   kubernetes.io/elb.tags	No	String	Add resource tags to a load balancer. This parameter can be configured only when a load balancer is automatically created. A tag is in the format of "key=value". Use commas (,) to separate multiple tags.
   host	No	String	Domain name for accessing the Service. By default, this parameter is left blank, and the domain name needs to be fully matched. Ensure that the domain name has been registered and licensed. Once the domain name is specified, it must be used for access.
   path	Yes	String	User-defined route path. All external access requests must match host and path. NOTE: The access path added here must exist in the backend application. Otherwise, the forwarding fails. For example, the default access URL of the Nginx application is /usr/share/nginx/html. When adding /test to the ingress forwarding policy, ensure the access URL of your Nginx application contains /usr/share/nginx/html/test. Otherwise, error 404 will be returned.
   ingress.beta.kubernetes.io/url-match-mode	No	String	Route matching policy. Default: STARTS_WITH (prefix match) Options: EQUAL_TO: exact match STARTS_WITH: prefix match REGEX: regular expression match
   pathType	Yes	String	Path type. The options are as follows: ImplementationSpecific: The matching method depends on Ingress Controller. The matching method defined by ingress.beta.kubernetes.io/url-match-mode is used in CCE. Exact: exact matching of the URL, which is case-sensitive. Prefix: prefix matching, which is case-sensitive. With this method, the URL path is separated into multiple elements by slashes (/) and the elements are matched one by one. If each element in the URL matches the path, the subpaths of the URL can be routed normally. NOTE: During prefix matching, each element must be exactly matched. If the last element of the URL is the substring of the last element in the request path, no matching is performed. For example, /foo/bar matches /foo/bar/baz but does not match /foo/barbaz. When elements are separated by slashes (/), if the URL or request path ends with a slash (/), the slash (/) at the end is ignored. For example, /foo/bar matches /foo/bar/. See examples of Ingress path matching.

   Table 2 elb.autocreate data structure

   Parameter	Mandatory	Type	Description
   name	No	String	Name of the automatically created load balancer. The value can contain 1 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. Default: cce-lb+service.UID
   type	No	String	Network type of the load balancer. public: public network load balancer inner: private network load balancer Default: inner
   bandwidth_name	Yes for public network load balancers	String	Bandwidth name. The default value is cce-bandwidth-******. The value can contain 1 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
   bandwidth_chargemode	Yes for public network load balancers	String	Bandwidth billing option. bandwidth: billed by bandwidth traffic: billed by traffic Default: bandwidth
   bandwidth_size	Yes for public network load balancers	Integer	Bandwidth size. The default value is 1 to 2,000 Mbit/s. Configure this parameter based on the bandwidth range allowed in your region. The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The minimum increment is 1 Mbit/s if the allowed bandwidth does not exceed 300 Mbit/s. The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1,000 Mbit/s. The minimum increment is 500 Mbit/s if the allowed bandwidth exceeds 1,000 Mbit/s.
   bandwidth_sharetype	Yes for public network load balancers	String	Bandwidth sharing mode. PER: dedicated bandwidth
   eip_type	Yes for public network load balancers	String	EIP type. 5_telcom: China Telecom 5_union: China Unicom 5_bgp: dynamic BGP 5_sbgp: static BGP
   vip_subnet_cidr_id	No	String	Specifies the subnet where a load balancer is located. The subnet must belong to the VPC where the cluster resides. If this parameter is not specified, the ELB load balancer and the cluster are in the same subnet.
   vip_address	No	String	Specifies the private IP address of the load balancer. Only IPv4 addresses are supported. IPv6 addresses are not supported. The IP address must be in the CIDR block of the load balancer. If this parameter is not specified, an IP address will be automatically assigned from the CIDR block of the load balancer.
   available_zone	Yes	Array of strings	AZ where the load balancer is located. You can obtain all supported AZs by querying the AZ list. This parameter is only available for dedicated load balancers.
   l4_flavor_name	Yes	String	Flavor name of the Layer-4 load balancer. You can obtain all supported types by calling the API for querying the flavor list. This parameter is only available for dedicated load balancers.
   l7_flavor_name	No	String	Flavor name of the Layer-7 load balancer. You can obtain all supported types by calling the API for querying the flavor list. This parameter is available only for dedicated load balancers. The value of this parameter must be the same as that of l4_flavor_name, that is, both are elastic specifications or fixed specifications.
   elb_virsubnet_ids	No	Array of strings	The network ID of the subnet where the load balancer is located. This subnet is used to allocate IP addresses for accessing the backend server. If this parameter is not specified, the subnet specified by vip_subnet_cidr_id will be used by default. Load balancers occupy different number of subnet IP addresses based on their specifications. Do not use the subnet CIDR blocks of other resources (such as clusters and nodes) as the load balancer CIDR block. This parameter is only available for dedicated load balancers. Example: "elb_virsubnet_ids": [ "14567f27-8ae4-42b8-ae47-9f847a4690dd" ] How to obtain Log in to the VPC console. In the navigation pane, choose Subnets. Filter the target subnet by the cluster's VPC name, click the subnet name, and copy the Network ID on the Summary tab.

3. Create an Ingress.

   kubectl create -f ingress-test.yaml

   If information similar to the following is displayed, the Ingress has been created.

   ingress/ingress-test created

   kubectl get ingress

   If information similar to the following is displayed, the Ingress has been created, and the workload is accessible.

   NAME             HOSTS     ADDRESS          PORTS   AGE
   ingress-test     *         121.**.**.**     80      10s

4. Enter http://121.**.**.**:80 in the address box of the browser to access the workload.

   121.**.**.** indicates the IP address of the unified load balancer.

Creating an Ingress with an Existing Load Balancer

CCE allows you to connect to an existing load balancer when creating an Ingress.

• Dedicated load balancers can route HTTP/HTTPS traffic at the application layer, and each of them has a private IP address bound.

apiVersion: networking.k8s.io/v1
kind: Ingress 
metadata: 
  name: ingress-test
  annotations: 
    kubernetes.io/elb.id: <your_elb_id>  # Replace it with the ID of your existing load balancer.
    kubernetes.io/elb.ip: <your_elb_ip>  # Replace it with the IP of your existing load balancer.
    kubernetes.io/elb.class: performance  # Load balancer type
    kubernetes.io/elb.port: '80'
spec:
  rules: 
  - host: ''
    http: 
      paths: 
      - path: '/'
        backend: 
          service:
            name: <your_service_name>  # Replace it with the name of your target Service.
            port: 
              number: 8080             # Replace 8080 with the port number of your target Service.
        property:
          ingress.beta.kubernetes.io/url-match-mode: STARTS_WITH
        pathType: ImplementationSpecific
  ingressClassName: cce