kubevela/charts/vela-minimal/templates/defwithtemplate/gateway.yaml

# Code generated by KubeVela templates. DO NOT EDIT. Please edit the original cue file.
# Definition source cue file: vela-templates/definitions/internal/gateway.cue
apiVersion: core.oam.dev/v1beta1
kind: TraitDefinition
metadata:
  annotations:
    definition.oam.dev/description: Enable public web traffic for the component, the ingress API matches K8s v1.20+.
  name: gateway
  namespace: {{ include "systemDefinitionNamespace" . }}
spec:
  appliesToWorkloads:
    - deployments.apps
    - statefulsets.apps
  podDisruptive: false
  schematic:
    cue:
      template: |
        // trait template can have multiple outputs in one trait
        outputs: service: {
        	apiVersion: "v1"
        	kind:       "Service"
        	metadata: name: context.name
        	spec: {
        		selector: "app.oam.dev/component": context.name
        		ports: [
        			for k, v in parameter.http {
        				port:       v
        				targetPort: v
        			},
        		]
        	}
        }

        legacyAPI: context.clusterVersion.minor < 19
        outputs: ingress: {
        	if legacyAPI {
        		apiVersion: "networking.k8s.io/v1beta1"
        	}
        	if !legacyAPI {
        		apiVersion: "networking.k8s.io/v1"
        	}
        	kind: "Ingress"
        	metadata: {
        		name: context.name
        		annotations: {
        			if !parameter.classInSpec {
        				"kubernetes.io/ingress.class": parameter.class
        			}
        			if parameter.gatewayHost != _|_ {
        				"ingress.controller/host": parameter.gatewayHost
        			}
        		}
        	}
        	spec: {
        		if parameter.classInSpec {
        			ingressClassName: parameter.class
        		}
        		if parameter.secretName != _|_ {
        			tls: [{
        				hosts: [
        					parameter.domain,
        				]
        				secretName: parameter.secretName
        			}]
        		}
        		rules: [{
        			if parameter.domain != _|_ {
        				host: parameter.domain
        			}
        			http: paths: [
        				for k, v in parameter.http {
        					path:     k
        					pathType: "ImplementationSpecific"
        					backend: {
        						if legacyAPI {
        							serviceName: context.name
        							servicePort: v
        						}
        						if !legacyAPI {
        							service: {
        								name: context.name
        								port: number: v
        							}
        						}
        					}
        				},
        			]
        		}]
        	}
        }

        parameter: {
        	// +usage=Specify the domain you want to expose
        	domain?: string

        	// +usage=Specify the mapping relationship between the http path and the workload port
        	http: [string]: int

        	// +usage=Specify the class of ingress to use
        	class: *"nginx" | string

        	// +usage=Set ingress class in '.spec.ingressClassName' instead of 'kubernetes.io/ingress.class' annotation.
        	classInSpec: *false | bool

        	// +usage=Specify the secret name you want to quote to use tls.
        	secretName?: string

        	// +usage=Specify the host of the ingress gateway, which is used to generate the endpoints when the host is empty.
        	gatewayHost?: string
        }
  status:
    customStatus: |-
      if context.outputs.ingress.status.loadBalancer.ingress == _|_ {
        message: "No loadBalancer found, visiting by using 'vela port-forward " + context.appName + "'\n"
      }
      if context.outputs.ingress.status.loadBalancer.ingress != _|_ {
      	let igs = context.outputs.ingress.status.loadBalancer.ingress
      	let host = context.outputs.ingress.spec.rules[0].host
        if igs[0].ip != _|_ {
        	if host != _|_ {
      	    message: "Visiting URL: " + context.outputs.ingress.spec.rules[0].host + ", IP: " + igs[0].ip
        	}
        	if host == _|_ {
      	    message: "Host not specified, visit the cluster or load balancer in front of the cluster with IP: " + igs[0].ip
        	}
        }
        if igs[0].ip == _|_ {
        	if host != _|_ {
      		  message: "Visiting URL: " + context.outputs.ingress.spec.rules[0].host
      		}
        	if host == _|_ {
      	    message: "Host not specified, visit the cluster or load balancer in front of the cluster"
      		}
        }
      }
    healthPolicy: 'isHealth: len(context.outputs.service.spec.clusterIP) > 0'