Skip to main content
Version: v1.1

Ingress

The ingress trait exposes a component to public Internet via a valid domain.

Specification

kubectl vela show ingress
# Properties
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
| http | Specify the mapping relationship between the http path and the workload port | map[string]int | true | |
| domain | Specify the domain you want to expose | string | true | |
+--------+------------------------------------------------------------------------------+----------------+----------+---------+

How to use

Attach a ingress trait to the component you want to expose and deploy.

# vela-app.yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-app
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
"/": 8000
kubectl apply -f https://raw.githubusercontent.com/kubevela/kubevela/master/docs/examples/vela-app.yaml
application.core.oam.dev/first-vela-app created

Check the status until we see status is running and services are healthy:

kubectl get application first-vela-app -w
NAME             COMPONENT        TYPE         PHASE            HEALTHY   STATUS   AGE
first-vela-app express-server webservice healthChecking 14s
first-vela-app express-server webservice running true 42s

Check the trait detail for the its visiting url:

kubectl get application first-vela-app -o yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-app
namespace: default
spec:
...
services:
- healthy: true
name: express-server
traits:
- healthy: true
message: 'Visiting URL: testsvc.example.com, IP: <your ip address>'
type: ingress
status: running
...

Then you will be able to visit this application via its domain.

curl -H "Host:testsvc.example.com" http://<your ip address>/
<xmp>
Hello World


## .
## ## ## ==
## ## ## ## ## ===
/""""""""""""""""\___/ ===
~~~ {~~ ~~~~ ~~~ ~~~~ ~~ ~ / ===- ~~~
\______ o _,/
\ \ _,'
`'--.._\..--''
</xmp>

⚠️ This section requires your runtime cluster has a working ingress controller.