From 62418fd120f92896c59614fdae34ffeb1287847d Mon Sep 17 00:00:00 2001 From: Brendan Burns Date: Mon, 23 Mar 2015 20:22:36 -0700 Subject: [PATCH] Describe manual setting of PortalIP in service creation. --- docs/services.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/services.md b/docs/services.md index 86df68e670a..4fa1ddffeab 100644 --- a/docs/services.md +++ b/docs/services.md @@ -211,6 +211,15 @@ network interfaces. If you assign that `Node`'s external IP as a `publicIP`, yo can then aim traffic at the `Service` port on that `Node` and it will be proxied to the backends. +## Choosing your own PortalIP address +A user can specify their own ```PortalIP``` address as part of a service creation +request. For example, if they already have an existing DNS entry that they wish +to replace, or legacy systems that are configured for a specific IP address and difficult +to re-configure. The ```PortalIP``` address that a user chooses must be a valid IP address +and within the portal net CIDR range that is specified by flag to the API server. If +the PortalIP value is invalid, the apiserver returns a ```422``` HTTP status code to +indicate that the value is invalid. + ## Shortcomings We expect that using iptables and userspace proxies for portals will work at