README
¶
IngressTrait
An abstraction for k8s Ingress which will always create Service automatically for you.
Supported workloads:
- ContainerizedWorkload
- StatefulSet
- Deployment
Prerequisites
Please follow common prerequisites to install OAM Controllers.
Getting started
- Get the IngressTrait project to your GOPATH
git clone https://github.com/oam-dev/catalog.git
- Install CRD to your Kubernetes cluster
cd catalog/traits/ingresstrait/
make install
- Run the IngressTrait controller
go run main.go
K8s Deployment
- Apply the sample Deployment
kubectl apply -f config/samples/deployment
Please notice that IngressTrait's filed is a little different from K8s native ingress.
# ./config/samples/deployment/sample_workload_definition.yaml
apiVersion: core.oam.dev/v1alpha2
kind: WorkloadDefinition
metadata:
name: deployments.apps
spec:
definitionRef:
name: deployments.apps
# ./config/samples/deployment/sample_application_config.yaml
...
traits:
- trait:
apiVersion: core.oam.dev/v1alpha2
kind: IngressTrait
metadata:
name: example-ingress-trait
spec:
# No need to define service here :-)
rules:
- host: nginx.oam.com
paths:
- path: /
backend:
serviceName: deploy-test
servicePort: 8080
- Verify IngressTrait you should see a deployment looking like below
kubectl get deployment
NAME READY UP-TO-DATE AVAILABLE AGE
web 1/1 1 1 32s
- And a service automatically created by IngressTrait controller
kubectl get service
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
deploy-test ClusterIP 10.108.95.103 <none> 8080:32105/TCP 42s
- You should see a ingress and it's rules looking like below
kubectl get ingress
NAME HOSTS ADDRESS PORTS AGE
example-ingress-trait nginx.oam.com 172.18.0.2 80 53s
kubectl describe ingress
...
Rules:
Host Path Backends
---- ---- --------
nginx.oam.com
/ deploy-test:8080 (10.244.1.11:80)
...
- Verrify Ingress works and the result is same as ContainerizedWorkload
ContainerizedWorkload
- Apply the sample ContainerizedWorkload
kubectl apply -f config/samples/containerized
# ./config/samples/contaierized/sample_application_config.yaml
...
traits:
- trait:
apiVersion: core.oam.dev/v1alpha2
kind: IngressTrait
metadata:
name: example-ingress-trait
spec:
# No need to define service here :-)
rules:
- host: nginx.oam.com
paths:
- path: /
- Verify IngressTrait you should see a deployment created by ContainerizedWorkload
kubectl get deployment
NAME READY UP-TO-DATE AVAILABLE AGE
example-appconfig-workload 1/1 1 1 15s
- And a service created by ContainerizedWorkload
kubectl get service
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
example-appconfig-workload NodePort 10.106.34.129 <none> 80:30038/TCP 22s
- You should see a ingress and it's rules looking like below
kubectl get ingress
NAME HOSTS ADDRESS PORTS AGE
example-ingress-trait nginx.oam.com 172.18.0.2 80 33s
kubectl describe ingress
...
Rules:
Host Path Backends
---- ---- --------
nginx.oam.com
/ example-appconfig-workload:80 (10.244.1.19:80)
...
- Verrify Ingress works
# curl -H "host: nginx.oam.com" 172.18.0.2
<!DOCTYPE html>
<html>
<head>
<title>Welcome to nginx!</title>
<style>
body {
width: 35em;
margin: 0 auto;
font-family: Tahoma, Verdana, Arial, sans-serif;
}
</style>
</head>
<body>
<h1>Welcome to nginx!</h1>
<p>If you see this page, the nginx web server is successfully installed and
working. Further configuration is required.</p>
<p>For online documentation and support please refer to
<a href="http://nginx.org/">nginx.org</a>.<br/>
Commercial support is available at
<a href="http://nginx.com/">nginx.com</a>.</p>
<p><em>Thank you for using nginx.</em></p>
</body>
</html>
K8s StatefulSet
- Apply the sample StatefulSet
kubectl apply -f config/samples/statefulset
# ./config/samples/statefulset/sample_workload_definition.yaml
apiVersion: core.oam.dev/v1alpha2
kind: WorkloadDefinition
metadata:
name: statefulsets.apps
spec:
definitionRef:
name: statefulsets.apps
# ./config/samples/statefulset/sample_application_config.yaml
...
traits:
- trait:
apiVersion: core.oam.dev/v1alpha2
kind: IngressTrait
metadata:
name: example-ingress-trait
spec:
# No need to define service here :-)
rules:
- host: nginx.oam.com
paths:
- path: /
- Verify IngressTrait you should see a statefulset looking like below
kubectl get statefulset
NAME READY AGE
web 1/1 6s
- And a service created by IngressTrait
kubectl get service
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
test ClusterIP 10.96.198.230 <none> 80:32424/TCP 19s
- You should see a ingress and it's rules looking like below
kubectl get ingress
NAME HOSTS ADDRESS PORTS AGE
example-ingress-trait nginx.oam.com 172.18.0.2 80 23s
kubectl describe ingress
...
Rules:
Host Path Backends
---- ---- --------
nginx.oam.com
/ test:80 (10.244.1.20:80)
...
- Verrify Ingress works and the result is same as ContainerizedWorkload
How it work?
Essentially, the IngressTrait controller will generate Service based on the workload spec.
In detail:
- If the workload type is ContainerizedWorkload which has two child resources (Deployment and Service), IngressTrait can help to create corresponding ingress based on the child Service.
- If the workload type is K8S native resources (StatefulSet or Deployment), IngressTrait can help to create a Service based on
spec.template.spec.contaiersfirstly, and then create corresponding ingress.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha2
Package v1alpha2 contains API Schema definitions for the core v1alpha2 API group +kubebuilder:object:generate=true +groupName=core.oam.dev
|
Package v1alpha2 contains API Schema definitions for the core v1alpha2 API group +kubebuilder:object:generate=true +groupName=core.oam.dev |
Click to show internal directories.
Click to hide internal directories.