mirror of
https://github.com/ysoftdevs/terraform-aws-eks.git
synced 2026-04-21 08:11:17 +02:00
docs: Fix typos in README and CONTRIBUTING (#1167)
This commit is contained in:
8
.github/CONTRIBUTING.md
vendored
8
.github/CONTRIBUTING.md
vendored
@@ -8,18 +8,18 @@ Please note we have a code of conduct, please follow it in all your interactions
|
|||||||
## Pull Request Process
|
## Pull Request Process
|
||||||
|
|
||||||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
|
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
|
||||||
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
|
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
|
||||||
3. Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will be included in the next release. The terraform-aws-eks mainteners takes care of updating the CHANGELOG as they merge.
|
3. Once all outstanding comments and checklist items have been addressed, your contribution will be merged! Merged PRs will be included in the next release. The terraform-aws-eks maintainers take care of updating the CHANGELOG as they merge.
|
||||||
|
|
||||||
## Checklists for contributions
|
## Checklists for contributions
|
||||||
|
|
||||||
- [ ] Add [sementics prefix](#semantic-pull-requests) to your PR or Commits (at leats one of your commit groups)
|
- [ ] Add [semantics prefix](#semantic-pull-requests) to your PR or Commits (at least one of your commit groups)
|
||||||
- [ ] CI tests are passing
|
- [ ] CI tests are passing
|
||||||
- [ ] README.md has been updated after any changes to variables and outputs. See https://github.com/terraform-aws-modules/terraform-aws-eks/#doc-generation
|
- [ ] README.md has been updated after any changes to variables and outputs. See https://github.com/terraform-aws-modules/terraform-aws-eks/#doc-generation
|
||||||
|
|
||||||
## Semantic Pull Requests
|
## Semantic Pull Requests
|
||||||
|
|
||||||
To generate changelog, Pull Requests or Commits must have sementic and must follow conventional specs below:
|
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
|
||||||
|
|
||||||
- `feat:` for new features
|
- `feat:` for new features
|
||||||
- `fix:` for bug fixes
|
- `fix:` for bug fixes
|
||||||
|
|||||||
@@ -168,7 +168,7 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a
|
|||||||
| Name | Description | Type | Default | Required |
|
| Name | Description | Type | Default | Required |
|
||||||
|------|-------------|------|---------|:--------:|
|
|------|-------------|------|---------|:--------:|
|
||||||
| attach\_worker\_cni\_policy | Whether to attach the Amazon managed `AmazonEKS_CNI_Policy` IAM policy to the default worker IAM role. WARNING: If set `false` the permissions must be assigned to the `aws-node` DaemonSet pods via another method or nodes will not be able to join the cluster. | `bool` | `true` | no |
|
| attach\_worker\_cni\_policy | Whether to attach the Amazon managed `AmazonEKS_CNI_Policy` IAM policy to the default worker IAM role. WARNING: If set `false` the permissions must be assigned to the `aws-node` DaemonSet pods via another method or nodes will not be able to join the cluster. | `bool` | `true` | no |
|
||||||
| aws\_auth\_additional\_labels | Additionnal kubernetes labels applied on aws-auth ConfigMap | `map(string)` | `{}` | no |
|
| aws\_auth\_additional\_labels | Additional kubernetes labels applied on aws-auth ConfigMap | `map(string)` | `{}` | no |
|
||||||
| cluster\_create\_endpoint\_private\_access\_sg\_rule | Whether to create security group rules for the access to the Amazon EKS private API server endpoint. | `bool` | `false` | no |
|
| cluster\_create\_endpoint\_private\_access\_sg\_rule | Whether to create security group rules for the access to the Amazon EKS private API server endpoint. | `bool` | `false` | no |
|
||||||
| cluster\_create\_security\_group | Whether to create a security group for the cluster or attach the cluster to `cluster_security_group_id`. | `bool` | `true` | no |
|
| cluster\_create\_security\_group | Whether to create a security group for the cluster or attach the cluster to `cluster_security_group_id`. | `bool` | `true` | no |
|
||||||
| cluster\_create\_timeout | Timeout value when creating the EKS cluster. | `string` | `"30m"` | no |
|
| cluster\_create\_timeout | Timeout value when creating the EKS cluster. | `string` | `"30m"` | no |
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ variable "manage_aws_auth" {
|
|||||||
}
|
}
|
||||||
|
|
||||||
variable "aws_auth_additional_labels" {
|
variable "aws_auth_additional_labels" {
|
||||||
description = "Additionnal kubernetes labels applied on aws-auth ConfigMap"
|
description = "Additional kubernetes labels applied on aws-auth ConfigMap"
|
||||||
default = {}
|
default = {}
|
||||||
type = map(string)
|
type = map(string)
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user