Skip to content

Commit 65a2924

Browse files
committed
tweak line wrappings in switch-to-evented-pleg and running-cloud-controller
1 parent cd4cad9 commit 65a2924

File tree

1 file changed

+84
-36
lines changed

1 file changed

+84
-36
lines changed

content/en/docs/tasks/administer-cluster/running-cloud-controller.md

Lines changed: 84 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -12,81 +12,129 @@ weight: 110
1212

1313
{{< feature-state state="beta" for_k8s_version="v1.11" >}}
1414

15-
Since cloud providers develop and release at a different pace compared to the Kubernetes project, abstracting the provider-specific code to the `{{< glossary_tooltip text="cloud-controller-manager" term_id="cloud-controller-manager" >}}` binary allows cloud vendors to evolve independently from the core Kubernetes code.
16-
17-
The `cloud-controller-manager` can be linked to any cloud provider that satisfies [cloudprovider.Interface](https://github.com/kubernetes/cloud-provider/blob/master/cloud.go). For backwards compatibility, the [cloud-controller-manager](https://github.com/kubernetes/kubernetes/tree/master/cmd/cloud-controller-manager) provided in the core Kubernetes project uses the same cloud libraries as `kube-controller-manager`. Cloud providers already supported in Kubernetes core are expected to use the in-tree cloud-controller-manager to transition out of Kubernetes core.
18-
19-
20-
15+
Since cloud providers develop and release at a different pace compared to the
16+
Kubernetes project, abstracting the provider-specific code to the
17+
`{{< glossary_tooltip text="cloud-controller-manager" term_id="cloud-controller-manager" >}}`
18+
binary allows cloud vendors to evolve independently from the core Kubernetes code.
19+
20+
The `cloud-controller-manager` can be linked to any cloud provider that satisfies
21+
[cloudprovider.Interface](https://github.com/kubernetes/cloud-provider/blob/master/cloud.go).
22+
For backwards compatibility, the
23+
[cloud-controller-manager](https://github.com/kubernetes/kubernetes/tree/master/cmd/cloud-controller-manager)
24+
provided in the core Kubernetes project uses the same cloud libraries as `kube-controller-manager`.
25+
Cloud providers already supported in Kubernetes core are expected to use the in-tree
26+
cloud-controller-manager to transition out of Kubernetes core.
2127

2228
<!-- body -->
2329

2430
## Administration
2531

2632
### Requirements
2733

28-
Every cloud has their own set of requirements for running their own cloud provider integration, it should not be too different from the requirements when running `kube-controller-manager`. As a general rule of thumb you'll need:
34+
Every cloud has their own set of requirements for running their own cloud provider
35+
integration, it should not be too different from the requirements when running
36+
`kube-controller-manager`. As a general rule of thumb you'll need:
2937

30-
* cloud authentication/authorization: your cloud may require a token or IAM rules to allow access to their APIs
31-
* kubernetes authentication/authorization: cloud-controller-manager may need RBAC rules set to speak to the kubernetes apiserver
32-
* high availability: like kube-controller-manager, you may want a high available setup for cloud controller manager using leader election (on by default).
38+
* cloud authentication/authorization: your cloud may require a token or IAM rules
39+
to allow access to their APIs
40+
* kubernetes authentication/authorization: cloud-controller-manager may need RBAC
41+
rules set to speak to the kubernetes apiserver
42+
* high availability: like kube-controller-manager, you may want a high available
43+
setup for cloud controller manager using leader election (on by default).
3344

3445
### Running cloud-controller-manager
3546

3647
Successfully running cloud-controller-manager requires some changes to your cluster configuration.
3748

38-
* `kube-apiserver` and `kube-controller-manager` MUST NOT specify the `--cloud-provider` flag. This ensures that it does not run any cloud specific loops that would be run by cloud controller manager. In the future, this flag will be deprecated and removed.
39-
* `kubelet` must run with `--cloud-provider=external`. This is to ensure that the kubelet is aware that it must be initialized by the cloud controller manager before it is scheduled any work.
40-
41-
Keep in mind that setting up your cluster to use cloud controller manager will change your cluster behaviour in a few ways:
42-
43-
* kubelets specifying `--cloud-provider=external` will add a taint `node.cloudprovider.kubernetes.io/uninitialized` with an effect `NoSchedule` during initialization. This marks the node as needing a second initialization from an external controller before it can be scheduled work. Note that in the event that cloud controller manager is not available, new nodes in the cluster will be left unschedulable. The taint is important since the scheduler may require cloud specific information about nodes such as their region or type (high cpu, gpu, high memory, spot instance, etc).
44-
* cloud information about nodes in the cluster will no longer be retrieved using local metadata, but instead all API calls to retrieve node information will go through cloud controller manager. This may mean you can restrict access to your cloud API on the kubelets for better security. For larger clusters you may want to consider if cloud controller manager will hit rate limits since it is now responsible for almost all API calls to your cloud from within the cluster.
45-
49+
* `kube-apiserver` and `kube-controller-manager` MUST NOT specify the `--cloud-provider`
50+
flag. This ensures that it does not run any cloud specific loops that would be run by
51+
cloud controller manager. In the future, this flag will be deprecated and removed.
52+
* `kubelet` must run with `--cloud-provider=external`. This is to ensure that the
53+
kubelet is aware that it must be initialized by the cloud controller manager
54+
before it is scheduled any work.
55+
56+
Keep in mind that setting up your cluster to use cloud controller manager will
57+
change your cluster behaviour in a few ways:
58+
59+
* kubelets specifying `--cloud-provider=external` will add a taint
60+
`node.cloudprovider.kubernetes.io/uninitialized` with an effect `NoSchedule`
61+
during initialization. This marks the node as needing a second initialization
62+
from an external controller before it can be scheduled work. Note that in the
63+
event that cloud controller manager is not available, new nodes in the cluster
64+
will be left unschedulable. The taint is important since the scheduler may
65+
require cloud specific information about nodes such as their region or type
66+
(high cpu, gpu, high memory, spot instance, etc).
67+
* cloud information about nodes in the cluster will no longer be retrieved using
68+
local metadata, but instead all API calls to retrieve node information will go
69+
through cloud controller manager. This may mean you can restrict access to your
70+
cloud API on the kubelets for better security. For larger clusters you may want
71+
to consider if cloud controller manager will hit rate limits since it is now
72+
responsible for almost all API calls to your cloud from within the cluster.
4673

4774
The cloud controller manager can implement:
4875

49-
* Node controller - responsible for updating kubernetes nodes using cloud APIs and deleting kubernetes nodes that were deleted on your cloud.
50-
* Service controller - responsible for loadbalancers on your cloud against services of type LoadBalancer.
76+
* Node controller - responsible for updating kubernetes nodes using cloud APIs
77+
and deleting kubernetes nodes that were deleted on your cloud.
78+
* Service controller - responsible for loadbalancers on your cloud against
79+
services of type LoadBalancer.
5180
* Route controller - responsible for setting up network routes on your cloud
5281
* any other features you would like to implement if you are running an out-of-tree provider.
5382

54-
5583
## Examples
5684

57-
If you are using a cloud that is currently supported in Kubernetes core and would like to adopt cloud controller manager, see the [cloud controller manager in kubernetes core](https://github.com/kubernetes/kubernetes/tree/master/cmd/cloud-controller-manager).
85+
If you are using a cloud that is currently supported in Kubernetes core and would
86+
like to adopt cloud controller manager, see the
87+
[cloud controller manager in kubernetes core](https://github.com/kubernetes/kubernetes/tree/master/cmd/cloud-controller-manager).
5888

59-
For cloud controller managers not in Kubernetes core, you can find the respective projects in repositories maintained by cloud vendors or by SIGs.
89+
For cloud controller managers not in Kubernetes core, you can find the respective
90+
projects in repositories maintained by cloud vendors or by SIGs.
6091

61-
For providers already in Kubernetes core, you can run the in-tree cloud controller manager as a DaemonSet in your cluster, use the following as a guideline:
92+
For providers already in Kubernetes core, you can run the in-tree cloud controller
93+
manager as a DaemonSet in your cluster, use the following as a guideline:
6294

6395
{{< codenew file="admin/cloud/ccm-example.yaml" >}}
6496

65-
6697
## Limitations
6798

68-
Running cloud controller manager comes with a few possible limitations. Although these limitations are being addressed in upcoming releases, it's important that you are aware of these limitations for production workloads.
99+
Running cloud controller manager comes with a few possible limitations. Although
100+
these limitations are being addressed in upcoming releases, it's important that
101+
you are aware of these limitations for production workloads.
69102

70103
### Support for Volumes
71104

72-
Cloud controller manager does not implement any of the volume controllers found in `kube-controller-manager` as the volume integrations also require coordination with kubelets. As we evolve CSI (container storage interface) and add stronger support for flex volume plugins, necessary support will be added to cloud controller manager so that clouds can fully integrate with volumes. Learn more about out-of-tree CSI volume plugins [here](https://github.com/kubernetes/features/issues/178).
105+
Cloud controller manager does not implement any of the volume controllers found
106+
in `kube-controller-manager` as the volume integrations also require coordination
107+
with kubelets. As we evolve CSI (container storage interface) and add stronger
108+
support for flex volume plugins, necessary support will be added to cloud
109+
controller manager so that clouds can fully integrate with volumes. Learn more
110+
about out-of-tree CSI volume plugins [here](https://github.com/kubernetes/features/issues/178).
73111

74112
### Scalability
75113

76-
The cloud-controller-manager queries your cloud provider's APIs to retrieve information for all nodes. For very large clusters, consider possible bottlenecks such as resource requirements and API rate limiting.
114+
The cloud-controller-manager queries your cloud provider's APIs to retrieve
115+
information for all nodes. For very large clusters, consider possible
116+
bottlenecks such as resource requirements and API rate limiting.
77117

78118
### Chicken and Egg
79119

80-
The goal of the cloud controller manager project is to decouple development of cloud features from the core Kubernetes project. Unfortunately, many aspects of the Kubernetes project has assumptions that cloud provider features are tightly integrated into the project. As a result, adopting this new architecture can create several situations where a request is being made for information from a cloud provider, but the cloud controller manager may not be able to return that information without the original request being complete.
81-
82-
A good example of this is the TLS bootstrapping feature in the Kubelet. TLS bootstrapping assumes that the Kubelet has the ability to ask the cloud provider (or a local metadata service) for all its address types (private, public, etc) but cloud controller manager cannot set a node's address types without being initialized in the first place which requires that the kubelet has TLS certificates to communicate with the apiserver.
120+
The goal of the cloud controller manager project is to decouple development
121+
of cloud features from the core Kubernetes project. Unfortunately, many aspects
122+
of the Kubernetes project has assumptions that cloud provider features are tightly
123+
integrated into the project. As a result, adopting this new architecture can create
124+
several situations where a request is being made for information from a cloud provider,
125+
but the cloud controller manager may not be able to return that information without
126+
the original request being complete.
127+
128+
A good example of this is the TLS bootstrapping feature in the Kubelet.
129+
TLS bootstrapping assumes that the Kubelet has the ability to ask the cloud provider
130+
(or a local metadata service) for all its address types (private, public, etc)
131+
but cloud controller manager cannot set a node's address types without being
132+
initialized in the first place which requires that the kubelet has TLS certificates
133+
to communicate with the apiserver.
83134

84135
As this initiative evolves, changes will be made to address these issues in upcoming releases.
85136

86-
87137
## {{% heading "whatsnext" %}}
88138

89-
90-
To build and develop your own cloud controller manager, read [Developing Cloud Controller Manager](/docs/tasks/administer-cluster/developing-cloud-controller-manager/).
91-
92-
139+
To build and develop your own cloud controller manager, read
140+
[Developing Cloud Controller Manager](/docs/tasks/administer-cluster/developing-cloud-controller-manager/).

0 commit comments

Comments
 (0)