-
Notifications
You must be signed in to change notification settings - Fork 677
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
[DRAFT] EKS Hybrid Nodes Networking Docs (pod network routing, webhooks, mixed mode clusters) #906
Open
csplinter
wants to merge
4
commits into
awsdocs:mainline
Choose a base branch
from
csplinter:docs-eks-hybrid-networking
base: mainline
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6c30578
add content for hybrid nodes pod network routability and mixed mode c…
csplinter dcb1ddf
CNI docs improvements, add considerations section
csplinter d006c28
use correct formats for code snippets
csplinter 454afb8
more formatting changes for replaceable fields
csplinter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,7 +62,67 @@ The sections that follow describe differences between running compatible {aws} a | |
[#hybrid-nodes-add-ons-core] | ||
== kube-proxy and CoreDNS | ||
|
||
EKS installs Kube-proxy and CoreDNS as self-managed add-ons by default when you create an EKS cluster with the {aws} API and {aws} SDKs, including from the {aws} CLI. You can overwrite these add-ons as Amazon EKS add-ons after cluster creation. Reference the EKS documentation for details on <<managing-kube-proxy>> and <<managing-coredns>>. If you are running a cluster with hybrid nodes and nodes in {aws} Cloud, we recommend that you have at least one CoreDNS replica on hybrid nodes and at least one CoreDNS replica on your nodes in {aws} Cloud. | ||
EKS installs kube-proxy and CoreDNS as self-managed add-ons by default when you create an EKS cluster with the {aws} API and {aws} SDKs, including from the {aws} CLI. You can overwrite these add-ons as Amazon EKS add-ons after cluster creation. Reference the EKS documentation for details on <<managing-kube-proxy>> and <<managing-coredns>>. | ||
|
||
If you are running a mixed mode cluster with both hybrid nodes and nodes in {aws} Cloud, we recommend that you have at least one CoreDNS replica on hybrid nodes and at least one CoreDNS replica on your nodes in {aws} Cloud. CoreDNS can be configured such that your workloads will use the closest CoreDNS replica, meaning your cloud workloads will use the CoreDNS running in the cloud and your hybrid workloads will use the CoreDNS running on hybrid nodes. See the steps below for how to configure CoreDNS for a mixed mode cluster. | ||
|
||
. Add a topology zone label for each of your hybrid nodes, for example `topology.kubernetes.io/zone: onprem`. This can alternatively be done at the `nodeadm init` phase. Note, nodes running in {aws} Cloud automatically get a topology zone label applied to them. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is the topology label added at the |
||
+ | ||
[source,bash,subs="verbatim,attributes,quotes"] | ||
---- | ||
kubectl label node [.replaceable]`hybrid-node-name` topology.kubernetes.io/zone=[.replaceable]`zone` | ||
---- | ||
+ | ||
. Add `podAntiAffinity` to the CoreDNS deployment configuration for the topology zone key. You can alternatively configure the CoreDNS deployment during installation with EKS add-ons. | ||
+ | ||
[source,bash,subs="verbatim,attributes,quotes"] | ||
---- | ||
kubectl edit deployment coredns -n kube-system | ||
---- | ||
+ | ||
[source,yaml,subs="verbatim,attributes"] | ||
---- | ||
spec: | ||
template: | ||
spec: | ||
affinity | ||
... | ||
podAntiAffinity: | ||
preferredDuringSchedulingIgnoredDuringExecution: | ||
- podAffinityTerm: | ||
labelSelector: | ||
matchExpressions: | ||
- key: k8s-app | ||
operator: In | ||
values: | ||
- kube-dns | ||
topologyKey: kubernetes.io/hostname | ||
weight: 100 | ||
- podAffinityTerm: | ||
labelSelector: | ||
matchExpressions: | ||
- key: k8s-app | ||
operator: In | ||
values: | ||
- kube-dns | ||
topologyKey: topology.kubernetes.io/zone | ||
weight: 50 | ||
... | ||
---- | ||
+ | ||
. Add `trafficDistribution` to the kube-dns Service configuration. | ||
+ | ||
[source,bash,subs="verbatim,attributes"] | ||
---- | ||
kubectl edit service kube-dns -n kube-system | ||
---- | ||
+ | ||
[source,yaml,subs="verbatim,attributes"] | ||
---- | ||
spec: | ||
... | ||
trafficDistribution: PreferClose | ||
---- | ||
|
||
[#hybrid-nodes-add-ons-cw] | ||
== CloudWatch Observability agent | ||
|
@@ -71,7 +131,7 @@ As the CloudWatch Observability agent runs https://kubernetes.io/docs/reference/ | |
Node-level metrics are not available for hybrid nodes because link:AmazonCloudWatch/latest/monitoring/ContainerInsights.html[CloudWatch Container Insights,type="documentation"] depends on the availability of link:AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html[Instance Metadata Service,type="documentation"] (IMDS) for node-level metrics. Cluster, workload, pod, and container-level metrics are available for hybrid nodes. | ||
|
||
After installing the add-on by following the steps described in link:AmazonCloudWatch/latest/monitoring/install-CloudWatch-Observability-EKS-addon.html[Install the CloudWatch agent with the Amazon CloudWatch Observability,type="documentation"], the add-on manifest must be updated before the agent can run successfully on hybrid nodes. Edit the `amazoncloudwatchagents` resource on the cluster to add the `RUN_WITH_IRSA` environment variable as shown below. | ||
[source,yaml,subs="verbatim,attributes"] | ||
[source,bash,subs="verbatim,attributes"] | ||
---- | ||
kubectl edit amazoncloudwatchagents -n amazon-cloudwatch cloudwatch-agent | ||
---- | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.