New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc for service advertisement #2303

Merged
merged 3 commits into from Nov 21, 2018

Conversation

Projects
None yet
2 participants
@neiljerram
Copy link
Member

neiljerram commented Nov 19, 2018

Release Note

Calico now supports advertising Kubernetes service cluster IPs over BGP.
@caseydavenport

This comment has been minimized.

Copy link
Member

caseydavenport commented Nov 19, 2018

Deploy preview for calico ready!

Built with commit fd399c6

https://deploy-preview-2303--calico.netlify.com

@neiljerram neiljerram force-pushed the neiljerram:service-advertisement branch from d5af999 to ea0da4e Nov 19, 2018

@@ -45,6 +45,7 @@ The `{{site.nodecontainer}}` container is primarily configured through environme
| K8S_KEY_FILE | Location of a client key for accessing the Kubernetes API. | string |
| K8S_CA_FILE | Location of a CA for accessing the Kubernetes API. | string |
| K8S_TOKEN | Token to be used for accessing the Kubernetes API. | string |
| ADVERTISE_CLUSTER_IPS | Enable [advertising Kubernetes service IPs over BGP]({{site.baseurl}}/{{page.version}}/usage/service-advertisement), within the specified CIDR. [Default: disabled] | IPv4 CIDR |

This comment has been minimized.

@caseydavenport

caseydavenport Nov 19, 2018

Member

Probably want to make it clear in all of these places that it does clusterIP advertisement, as opposed to say externalIP or loadBalancerIP advertisement, since those are all types of "service IPs"

@caseydavenport
Copy link
Member

caseydavenport left a comment

One minor comment but LGTM.

@emanic should do an editorial review.

@caseydavenport caseydavenport requested a review from emanic Nov 19, 2018

@neiljerram

This comment has been minimized.

Copy link
Member

neiljerram commented Nov 19, 2018

@caseydavenport How do those markups look? There are a couple of contexts where I thought s/service IP/service cluster IP/ would make it too long, so I've done s/service IP/service/ instead. WDYT?

```yaml
env:
[...]
- name: ADVERTISE_CLUSTER_IPS

This comment has been minimized.

@caseydavenport

caseydavenport Nov 19, 2018

Member

Also, looks like the code currently supports CALICO_ADVERTISE_CLUSTER_IPS.

So, either need to make the code support both or update this value here. WDYT?

This comment has been minimized.

@neiljerram

neiljerram Nov 20, 2018

Member

I was going by the gdoc; but if you're happy that CALICO_ADVERTISE_CLUSTER_IPS is more the Right Thing, I'll just update the doc to say that.

(Unfortunately we seem to have got ourselves into a mess here, on the point of whether or not we prefix with CALICO; see https://docs.projectcalico.org/master/reference/node/configuration.)

This comment has been minimized.

@caseydavenport

caseydavenport Nov 20, 2018

Member

Sigh, yeah...

I'm not sure. It seems like the way to align all of those inconsistent variables would be to support both a CALICO_ prefixed and not prefixed variants.

I think this is what we do for other bits of config as well, for example ETCD_ENDPOINTS and CALICO_ETCD_ENDPOINTS, where the CALICO_ prefixed version takes precedence.

We get this for free by using envconfig.

@neiljerram neiljerram merged commit 4539a5e into projectcalico:master Nov 21, 2018

2 checks passed

license/cla Contributor License Agreement is signed.
Details
semaphoreci The build passed on Semaphore.
Details

@neiljerram neiljerram deleted the neiljerram:service-advertisement branch Nov 21, 2018

@caseydavenport caseydavenport added this to the Calico v3.4.0 milestone Nov 27, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment