Skip to content

Commit 956a4d6

Browse files
committed
chore: update README.md
1 parent f931b9c commit 956a4d6

File tree

1 file changed

+43
-51
lines changed

1 file changed

+43
-51
lines changed

README.md

Lines changed: 43 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!-- markdownlint-disable -->
44
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-eks-node-group/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
55
<p align="right">
6-
<a href="https://github.com/cloudposse/terraform-aws-eks-node-group/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-eks-node-group.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-eks-node-group/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-eks-node-group.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
6+
<a href="https://github.com/cloudposse/terraform-aws-eks-node-group/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-eks-node-group.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-eks-node-group/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-eks-node-group.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://cloudposse.com/slack"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
77
<!-- markdownlint-restore -->
88

99
<!--
@@ -127,7 +127,6 @@ Note that for all OSes, you can supply the complete `userdata` contents, which w
127127

128128
## Usage
129129

130-
131130
### Major Changes (breaking and otherwise)
132131

133132
With the v3.0.0 release of this module, support for Amazon Linux 2023 (AL2023) has
@@ -262,55 +261,6 @@ module "eks_node_group" {
262261

263262

264263

265-
<!-- markdownlint-disable -->
266-
## Makefile Targets
267-
```text
268-
Available targets:
269-
270-
help Help screen
271-
help/all Display help for all targets
272-
help/short This help short screen
273-
lint Lint terraform code
274-
275-
```
276-
<!-- markdownlint-restore -->
277-
<!-- markdownlint-disable -->
278-
## Windows Managed Node groups
279-
280-
Windows managed node-groups have a few pre-requisites.
281-
282-
* Your cluster must contain at least one linux based worker node
283-
* Your EKS Cluster must have the `AmazonEKSVPCResourceController` and `AmazonEKSClusterPolicy` policies attached
284-
* Your cluster must have a config-map called amazon-vpc-cni with the following content
285-
286-
```yaml
287-
apiVersion: v1
288-
kind: ConfigMap
289-
metadata:
290-
name: amazon-vpc-cni
291-
namespace: kube-system
292-
data:
293-
enable-windows-ipam: "true"
294-
```
295-
296-
* Windows nodes will automatically be tainted
297-
298-
```yaml
299-
kubernetes_taints = [{
300-
key = "WINDOWS"
301-
value = "true"
302-
effect = "NO_SCHEDULE"
303-
}]
304-
```
305-
* Any pods that target Windows will need to have the following attributes set in their manifest
306-
307-
```yaml
308-
nodeSelector:
309-
kubernetes.io/os: windows
310-
kubernetes.io/arch: amd64
311-
```
312-
313-
https://docs.aws.amazon.com/eks/latest/userguide/windows-support.html
314264
<!-- markdownlint-disable -->
315265
## Requirements
316266

@@ -452,6 +402,48 @@ https://docs.aws.amazon.com/eks/latest/userguide/windows-support.html
452402
<!-- markdownlint-restore -->
453403

454404

405+
406+
407+
408+
<!-- markdownlint-disable -->
409+
## Windows Managed Node groups
410+
411+
Windows managed node-groups have a few pre-requisites.
412+
413+
* Your cluster must contain at least one linux based worker node
414+
* Your EKS Cluster must have the `AmazonEKSVPCResourceController` and `AmazonEKSClusterPolicy` policies attached
415+
* Your cluster must have a config-map called amazon-vpc-cni with the following content
416+
417+
```yaml
418+
apiVersion: v1
419+
kind: ConfigMap
420+
metadata:
421+
name: amazon-vpc-cni
422+
namespace: kube-system
423+
data:
424+
enable-windows-ipam: "true"
425+
```
426+
427+
* Windows nodes will automatically be tainted
428+
429+
```yaml
430+
kubernetes_taints = [{
431+
key = "WINDOWS"
432+
value = "true"
433+
effect = "NO_SCHEDULE"
434+
}]
435+
```
436+
* Any pods that target Windows will need to have the following attributes set in their manifest
437+
438+
```yaml
439+
nodeSelector:
440+
kubernetes.io/os: windows
441+
kubernetes.io/arch: amd64
442+
```
443+
444+
https://docs.aws.amazon.com/eks/latest/userguide/windows-support.html
445+
446+
455447
## Related Projects
456448
457449
Check out these related projects.

0 commit comments

Comments
 (0)