View source for Kind: Ingress

{{lowercase}}
[[v1.19]] (Aug 2020)

* https://kubernetes.io/docs/concepts/services-networking/ingress/
* https://kind.sigs.k8s.io/docs/user/ingress/
* https://docs.okd.io/latest/rest_api/network_apis/ingress-networking-k8s-io-v1.html
* <code>[[helm install my-release ingress-nginx/ingress-nginx]]</code>
* <code>[[minikube addons enable ingress]]</code>
* [[spec.rules.host]]
* rules: [  [[http:]] | [[hosts:]] ]

== Official examples ==
 [[apiVersion: networking.k8s.io/v1]]
 [[kind:]] Ingress
 metadata:
   name: minimal-ingress
   [[annotations:]]
     [[nginx.ingress.kubernetes.io]]/rewrite-target: /
 spec:
   [[ingressClassName]]: nginx-example
   rules:
   - http:
       paths:
       - path: /testpath
         pathType: Prefix
         backend:
           service:
             name: test
             port:
               number: 80

 https://kind.sigs.k8s.io/docs/user/ingress/
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
   name: example-ingress
   annotations:
     nginx.ingress.kubernetes.io/rewrite-target: /$2
 spec:
   rules:
   - http:
       paths:
       - pathType: Prefix
         path: /foo(/|$)(.*)
         backend:
           service:
             name: foo-service
             port:
               number: 8080
       - pathType: Prefix
         path: /bar(/|$)(.*)
         backend:
           service:
             name: bar-service
             port:
               number: 8080

== Examples ==

 apiVersion: [[networking.k8s.io/v1]]
 kind: Ingress
 metadata:
   annotations:
     [[kubernetes.io/ingress.class]]: nginx
   name: example
   namespace: foo
 spec:
   rules:
     - host: www.example.com
       http:
         paths:
           - backend:
               serviceName: exampleService
               servicePort: 80
             path: /



 apiVersion: [[networking.k8s.io/v1beta1]]
 kind: Ingress
 metadata:
   annotations:
     [[kubernetes.io/ingress.class]]: nginx
   name: example
   namespace: foo
 spec:
   rules:
     - host: www.example.com
       http:
         paths:
           - backend:
               serviceName: exampleService
               servicePort: 80
             path: /
   # This section is only required if TLS is to be enabled for the Ingress
   [[tls:]]
       - hosts:
           - www.example.com
         [[secretName:]] example-tls


  .../...
  status:
    [[loadBalancer:]]
      ingress:
      - hostname: a324242432.elb.ap-southeast-1.amazonaws.com
  .../...


 [[apiVersion]]: [[extensions/]]v1beta1
 [[kind:]] Ingress
 [[metadata:]]
   name: foobar
 [[spec:]]
   [[rules:]]
   - host: foobar.example.com
     http:
       paths:
       - backend:
           [[serviceName]]: foo
           servicePort: 8080
         path: /

== Errors ==
 {{error validating ingress.yaml}}

== Related terms ==
* [[Kubernetes: Ingress controllers]]
* <code>[[kubectl get ingress]], [[kubectl describe ingress]]</code>
* <code>[[kind: ConfigMap]]</code>
* <code>[[kind: IngressClass]]</code>
* <code>[[pathType:]] [[ImplementationSpecific]]</code>
* <code>[[field.cattle.io/publicEndpoints]]</code>
* <code>[[cattle.io/creator: norman]]</code>
* <code>[[.local]]</code>
* [[Address:]]
* <code>[[kubectl apply -f ingress.yaml]]</code>
* [[Ingress-nginx-controller ConfigMap]]

== See also ==
* {{kind: Ingress}}
* {{networking.k8s.io}}
* {{kubectl ingress}}
* {{Ingress}}

[[Category:K8s]]