From 540ba4b4334d4770f94204f78d71d9d5d9811d96 Mon Sep 17 00:00:00 2001 From: Rohit Ramkumar Date: Fri, 20 Sep 2019 16:17:46 -0400 Subject: [PATCH] Some documentation fixes to reflect current state of world --- BETA_LIMITATIONS.md => LIMITATIONS.md | 8 ++------ README.md | 8 -------- docs/faq/gce.md | 2 +- 3 files changed, 3 insertions(+), 15 deletions(-) rename BETA_LIMITATIONS.md => LIMITATIONS.md (97%) diff --git a/BETA_LIMITATIONS.md b/LIMITATIONS.md similarity index 97% rename from BETA_LIMITATIONS.md rename to LIMITATIONS.md index 9619fe77cb..a813f2c7aa 100644 --- a/BETA_LIMITATIONS.md +++ b/LIMITATIONS.md @@ -1,8 +1,4 @@ -# GLBC: Beta limitations - -As of the Kubernetes 1.7 release, the GCE L7 Loadbalancer controller is still a *beta* product. - -This is a list of beta limitations: +# GLBC: Known Limitations * [IPs](#static-and-ephemeral-ips): Creating a simple HTTP Ingress will allocate an ephemeral IP. Creating an Ingress with a TLS section will allocate a static IP. * [Latency](#latency): GLBC is not built for performance. Creating many Ingresses at a time can overwhelm it. It won't fall over, but will take its own time to churn through the Ingress queue. @@ -93,7 +89,7 @@ Events: GCE has a concept of [ephemeral](https://cloud.google.com/compute/docs/instances-and-network#ephemeraladdress) and [static](https://cloud.google.com/compute/docs/instances-and-network#reservedaddress) IPs. A production website would always want a static IP, which ephemeral IPs are cheaper (both in terms of quota and cost), and are therefore better suited for experimentation. * Creating a HTTP Ingress (i.e an Ingress without a TLS section) allocates an ephemeral IP, because we don't believe HTTP is the right way to deploy an app. * Creating an Ingress with a TLS section allocates a static IP, because GLBC assumes you mean business. -* Modifying an Ingress and adding a TLS section allocates a static IP, but the IP *will* change. This is a beta limitation. +* Modifying an Ingress and adding a TLS section allocates a static IP, but the IP *will* change. * You can [promote](https://cloud.google.com/compute/docs/instances-and-network#promote_ephemeral_ip) an ephemeral to a static IP by hand, if required. ## Load Balancing Algorithms diff --git a/README.md b/README.md index e70a6de4a7..d53cd5c42d 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,6 @@ GLBC is a GCE L7 load balancer controller that manages external loadbalancers configured through the Kubernetes Ingress API. -## A word to the wise - -Please read the [beta limitations](BETA_LIMITATIONS.md) doc to before using this controller. In summary: - -- This is a **work in progress**. -- It relies on a beta Kubernetes resource. -- The loadbalancer controller pod is not aware of your GCE quota. - ## Overview See [here](https://kubernetes.io/docs/concepts/services-networking/ingress/) for high-level concepts on Ingress in Kubernetes. diff --git a/docs/faq/gce.md b/docs/faq/gce.md index df1dacc698..edeafb5eb6 100644 --- a/docs/faq/gce.md +++ b/docs/faq/gce.md @@ -148,7 +148,7 @@ are therefore better suited for experimentation. * static-ips have limited quota and pure HTTP ingress is often used for testing * Creating an Ingress with a TLS section allocates a static IP * Modifying an Ingress and adding a TLS section allocates a static IP, but the - IP *will* change. This is a beta limitation. + IP *will* change. * You can [promote](https://cloud.google.com/compute/docs/instances-and-network#promote_ephemeral_ip) an ephemeral to a static IP by hand, if required.