Use the saectl tool to manage the network access Service for an application

Prerequisites

Before you begin, ensure that you have:

• Installed the saectl tool with your AccessKey ID, AccessKey secret, and application deployment region configured. See Install and configure the saectl tool

How it works

When you create a service, SAE maps a CLB instance to a Kubernetes Service of type LoadBalancer. The annotation sae.aliyun.com/loadbalancer-address-type controls whether the CLB instance is on the public network (internet) or private network (intranet). SAE either creates a new CLB instance automatically or attaches an existing one—depending on whether you specify sae.aliyun.com/loadbalancer-id in the YAML.

Most configuration items are locked at creation time and cannot be changed later. Review the K8s YAML configuration items table before writing your YAML file.

Create a service

1. Create a file named svc.yaml with the following content. Adjust the annotations and port definitions for your application.

   apiVersion: v1
   kind: Service
   metadata:
     annotations:
       # Network type: internet for public network, intranet for private network. Required. Cannot be changed after creation.
       sae.aliyun.com/loadbalancer-address-type: internet
       # CLB instance ID. Omit this annotation to let SAE create a new CLB instance automatically.
       sae.aliyun.com/loadbalancer-id: ${clb-id}
       # HTTPS certificate IDs, keyed by port name. Required only when a port uses HTTPS.
       sae.aliyun.com/loadbalancer-cert-ids: '{"port-443": "certId-1"}'
     # Service name format: ${network-type}-${application-name}
     name: internet-test-app
   spec:
     ports:
     - name: port-80      # Fixed format: port-${external-port}
       port: 80
       protocol: HTTP
       targetPort: 80
     - name: port-443
       port: 443
       protocol: HTTPS
       targetPort: 443
     selector:
       sae.aliyun.com/app-name: test-app    # Application name
     type: LoadBalancer

2. In the directory where svc.yaml is located, run:

   saectl apply -f svc.yaml

View the service list

saectl get service -l sae.aliyun.com/app-name=<deployment-name> -n <namespace>

Replace <deployment-name> with your application name and <namespace> with your namespace ID. Omit -l to list CLB instances for all applications in scope. Omit -n to use the default namespace.

View service details

Use get to retrieve the full service configuration in YAML or JSON format. Use describe to get a human-readable summary of the service configuration items.

saectl get service <service-name> -o {yaml | json} -n <namespace>

saectl describe service <service-name> -n <namespace>

Update a service

Use edit for quick, one-off changes directly in your terminal. Use apply when you manage configurations in version control or need to apply changes from a file.

Most configuration items cannot be changed after creation. See K8s YAML configuration items for the full list of immutable fields.

saectl apply -f svc.yaml

Delete a service

saectl delete service <service-name> -n <namespace>

K8s YAML configuration items

All CLB-based services use the Kubernetes Service resource type. The following table describes every configuration item, whether it is required at creation, and whether it can be modified later.

What's next

• Install and configure the saectl tool