From 81d33a4512101200abc311589a4d706bf7a5a30f Mon Sep 17 00:00:00 2001 From: deniseschannon Date: Mon, 9 May 2016 22:26:57 -0700 Subject: [PATCH] Updated F5 readme --- templates/f5/0/README.md | 27 ++++++++------------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/templates/f5/0/README.md b/templates/f5/0/README.md index 87a1dd2..370ac79 100644 --- a/templates/f5/0/README.md +++ b/templates/f5/0/README.md @@ -1,26 +1,15 @@ -external-lb -========== -Rancher service facilitating integration of rancher with F5 BIG-IP - external load balancer. This service updates F5 with services created in Rancher that ask to be load balanced using F5. -Initial version comes with support for an unpartitioned F5 BIG-IP installation +# F5 BIG-IP -Design -========== -* The F5 service gets deployed as a Rancher service containerized app. +### Info: -* It enables any other service to be registered to external F5 if the service has exposed a public port and has the label 'io.rancher.service.external_lb_endpoint' +By integrating with F5 BIG-IP, you add the ability to load balance services regardless of which hosts the containers have been deployed on. Currently, we only support an unpartitioned F5 BIG-IP installation. Prior to adding the service, please make sure the VirtualServer is configured on F5. -* Value of this label should be equal to the VirtualServer Name on F5 BIG-IP +After launching the F5 service, services in Rancher will be registered to the F5 BIG-IP if it meets the following conditions: -* The VirtualServer should be pre-configured on F5 +* Exposes a public port on the host -* The rancher hosts on which the containers of the service are running, will be added to the F5 setup as nodes +* Contains a label with a key of 'io.rancher.service.external_lb_endpoint' and a value of the VirtualServer Name on F5 BIG-IP -* A new F5 pool will be created for the service, having the Rancher host_ip:port as pool members +In F5, any Rancher host running services that meet the criteria will be added to the F5 setup as nodes. For each service, a F5 pool will be created and each host that runs the service will be added as a pool member (`:`). In the pool, the name of the pool member will be `__rancher.internal`. You can configure the suffix of the names. By default, this is set as `rancher.internal`. -* This F5 pool created will have a name of the pattern of"service.Name"_"environment_uuid"_"rancher.internal" - The suffix "rancher.internal" is configurable while launching the catalog template. - -* This pool will be assigned to the F5 virtual server provided to Rancher via the above label - -* After the F5 configuration is complete, the service on Rancher can be reached using the F5 vip:port - -* Rancher’s F5 service will keep on synching new services to F5 and remove/scale up-scale down as changes are made on Rancher. +Once the F5 configuration has been completed, you can access any services in Rancher using the F5 `:`. As services matching the criteria are added and removed from Rancher, the F5 service will sync with the F5 BIG-IP will all the changes. \ No newline at end of file