Skip to content
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.

Sign up for GitHub

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

Update Calico section of kubeadm install guide #18821

Merged
merged 2 commits into from
Feb 1, 2020
Merged

Update Calico section of kubeadm install guide #18821

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c31f8c
Update Calico section of kubeadm install guide
caseydavenport Jan 22, 2020
75c8d8b
Address review feedback
caseydavenport Jan 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions ...nt/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,7 @@ kubeadm only supports Container Network Interface (CNI) based networks (and does

Several projects provide Kubernetes Pod networks using CNI, some of which also
support [Network Policy](/docs/concepts/services-networking/networkpolicies/). See the [add-ons page](/docs/concepts/cluster-administration/addons/) for a complete list of available network add-ons.
- IPv6 support was added in [CNI v0.6.0](https://github.com/containernetworking/cni/releases/tag/v0.6.0).
- [CNI bridge](https://github.com/containernetworking/plugins/blob/master/plugins/main/bridge/README.md) and [local-ipam](https://github.com/containernetworking/plugins/blob/master/plugins/ipam/host-local/README.md) are the only supported IPv6 network plugins in Kubernetes version 1.9.
- IPv6 support was added in [CNI v0.6.0](https://github.com/containernetworking/cni/releases/tag/v0.6.0). See each plugin's documentation to see if it supports IPv6.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@caseydavenport the existing page doesn't render this correctly. Does the rendered version of this look how you wanted?


Note that kubeadm sets up a more secure cluster by default and enforces use of [RBAC](/docs/reference/access-authn-authz/rbac/).
Make sure that your network manifest supports RBAC.
Expand All @@ -290,12 +289,12 @@ Below you can find installation instructions for some popular Pod network plugin
{{< tabs name="tabs-pod-install" >}}

{{% tab name="Calico" %}}
For more information about using Calico, see [Quickstart for Calico on Kubernetes](https://docs.projectcalico.org/latest/getting-started/kubernetes/), [Installing Calico for policy and networking](https://docs.projectcalico.org/latest/getting-started/kubernetes/installation/calico), and other related resources.
[Calico](https://docs.projectcalico.org/latest/introduction/) is a networking and network policy provider. Calico supports a flexible set of networking options designed to give you the most efficient networking across a range of situations, including non-overlay and overlay networks, with or without BGP. Calico uses the same engine to enforce network policy for hosts, pods, and (if using Istio & Envoy) applications at the service mesh layer.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@caseydavenport recently we had a purge of CNI providers in the kubeadm docs. SIG Docs have a KEP to remove third party documentation that attempts to advertise their product.

to comply with this can we simplify the above sentences to something more technical with less adjectives, as if it was written by a third party - possibly a single sentence listing the key features of latest 3.11.

Calico is a networking and network policy provider that supports .... x, y, z.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@neolit123 Can you link to the KEP? This may help folks judge what is the appropriate level of content here. I do believe the goal should be to provide the level of content that is sufficient for a k8s user to judge whether an external project is of interest to them. It shouldn't be marketing material but I think it does need to say what the project does at a level where an average reader of the docs would know if it is of interest in them learning more about.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lxpollitt the KEP is here:
kubernetes/enhancements#1327


For Calico to work correctly, you need to pass `--pod-network-cidr=192.168.0.0/16` to `kubeadm init` or update the `calico.yml` file to match your Pod network. Note that Calico works on `amd64`, `arm64`, and `ppc64le` only.
By default, Calico uses `192.168.0.0/16` to assign pod IP addresses, though this can be configured. For Calico to work correctly, you need to pass `--pod-network-cidr=192.168.0.0/16` to `kubeadm init` or update the `calico.yaml` file to match your desired pod network CIDR. Calico works on several architectures, including `amd64`, `arm64`, and `ppc64le`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

possibly :

Calico works on several architectures, including amd64, arm64, and ppc64le.

can be moved to the above paragraph.

maybe the rest can be refactored to:

By default, Calico uses 192.168.0.0/16 as the Pod network CIDR, though this can be configured in the the calico.yaml file. For Calico to work correctly, you need to pass this same CIDR to the kubeadm init command using the --pod-network-cidr=192.168.0.0/16 flag or via the kubeadm configuration.


```shell
kubectl apply -f https://docs.projectcalico.org/v3.8/manifests/calico.yaml
kubectl apply -f https://docs.projectcalico.org/v3.11/manifests/calico.yaml
```

{{% /tab %}}
Expand Down