diff --git a/README.md b/README.md index d8b004d..48cdd05 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ # Kubernetes Ingress Controller Manager for Servers.com +Servers.com provides you with the own Ingress controller built upon the Servers.com HTTP(S) (L7) Load Balancer. It can be used along with the LoadBalancer and NodePort Services. +The Ingress controller is featured with annotations based on the L7 Load Balancer features. + +You can find more details on the Servers.com Ingress controller and peculiarities of usage in the [knowledge base](https://www.servers.com/support/knowledge/kubernetes-clusters/serverscom-ingress-controller). + +This is an example how an Ingress object with an annotation may look like: + +``` +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: minimal-ingress + annotations: + servers.com/load-balancer-geo-ip-enabled: "true" +spec: + ingressClassName: serverscom + tls: + - hosts: + - example.com + secretName: testsecret-tls + rules: + - host: example.com + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: nginxdemo + port: + number: 80 +``` [![GitHub Actions status](https://github.com/serverscom/serverscom-ingress-controller/workflows/Test/badge.svg)](https://github.com/serverscom/serverscom-ingress-controller/actions)