Skip to content

Commit

Permalink
Updates to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zawac002 committed Aug 16, 2023
1 parent 1a057f7 commit a8e4f8e
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 48 deletions.
66 changes: 45 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,53 +13,77 @@ The name of the cluster to create.

The name of the region in which to create the cluster.


**vpc_name** `string`

The VPC named that will be used by this cluster.


**domain** `string`

"The DNS domain name of the cluster."

## Optional Inputs

**namespace** `string`
**cluster_version** `string`

The Kuberentes version number to use for this EKS cluster. See https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html

Default: `"1.27"`

**tag_costallocation** `string`

The cost allocation group.

Default: `"csvd:infrastructure"`


**profile** string

The AWS configuration profile.

The namespace to install the cloud watch components.
Default: `""`

Default: `"amazon-cloudwatch"`

**subnets_name** `string`

**tags** `map(string)`
Define the name of the subnets to be used by this cluster.

Arbitrary tags to add to objects created in AWS.
Default: `"*-container-*"`

Default: `{}`

**eks_instance_disk_size** `number`

**log_retention_days** `string`
The size of the disk of the worker nodes in gigabytes. 40 is the approximate minimum. Needs to hold the all of the normal operating system files plus every image that will be used in the cluster.

How long to keep the logs in cloudwatch.
Default: `40`

Default: `"1"`

**eks_instance_types** `list(string)`

**fluent_bit_read_from_head** `string`
EKS worker node instance types

Fluent Bit reads log files from the tail, and will capture only new logs after it is deployed. If you want the opposite, set fluent_bit_read_from_head='On' and it will collect all logs in the file system and set fluent_bit_read_from_tail='Off'.
Default: `[ "t3.xlarge" ]`

Default: `"off"`

**eks_ng_min_size** `number`

**fluent_bit_read_from_tail** `string`
The node group minimum size.

Fluent Bit reads log files from the tail, and will capture only new logs after it is deployed. If you want the opposite, set fluent_bit_read_from_head='On' and it will collect all logs in the file system and set fluent_bit_read_from_tail='Off'.
Default: `4`

Default: `"on"`

**eks_ng_desired_size** `number`

**fluent_bit_http_server** `string`
The node group desired size

fluent_bit_http_server for monitoring plugin metrics is on by default. To turn it off, change this value to ''.
Default: `4`

Default: `"on"`

**eks_ng_max_size** `number`

**fluent_bit_http_port** `string`
The node group maximum size

The port on which the fluent_bit_http_server will run.
Default: `15`

Default: `"2020"`

51 changes: 24 additions & 27 deletions variables.tf
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
variable "tag_costallocation" {
description = "Tag CostAllocation (default)"
variable "cluster_name" {
description = "EKS cluster name name component used through out the EKS cluster describing its purpose (ex: dice-dev)"
type = string
default = "csvd:infrastructure"
}

variable "cluster_version" {
description = "The Kubernetes version number to use for this EKS cluster. See https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html"
type = string
default = "1.27"
}

variable "region" {
description = "AWS region"
type = string
}

variable "tag_costallocation" {
description = "Tag CostAllocation (default)"
type = string
default = "csvd:infrastructure"
}

variable "profile" {
description = "AWS config profile"
type = string
Expand All @@ -18,7 +29,6 @@ variable "profile" {
variable "vpc_name" {
description = "Define the VPC name that will be used by this cluster"
type = string
default = "*UNKNOWN*"
}

variable "subnets_name" {
Expand All @@ -27,50 +37,37 @@ variable "subnets_name" {
default = "*-container-*"
}

variable "cluster_name" {
description = "EKS cluster name name component used through out the EKS cluster describing its purpose (ex: dice-dev)"
type = string
default = null
}

variable "cluster_version" {
description = "The EKS version number, see https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html"
type = string
default = "1.27"
}

variable "domain" {
description = "The DNS domain name of the cluster. Defaults to empty which causes the sample application to use the domain assigned to the load balancer of the istio ingress gateway."
description = "The DNS domain name of the cluster."
type = string
default = ""
}

variable "eks_instance_disk_size" {
description = "The size of the disk in gigabytes"
description = "The size of the disk of the worker nodes in gigabytes. 40 is the approximate minimum. Needs to hold the all of the normal operating system files plus every image that will be used in the cluster."
type = number
default = 40
}

variable "eks_instance_types" {
description = "EKS worker node instance type"
description = "EKS worker node instance types"
type = list(string)
default = [
"t3.xlarge"
]
}

variable "eks_ng_desired_size" {
description = "Node Group desire size, default is 1"
variable "eks_ng_min_size" {
description = "Node Group minimum size"
type = number
default = 4
}
variable "eks_ng_max_size" {
description = "Node Group minimum size, default is 1"
variable "eks_ng_desired_size" {
description = "Node Group desired size"
type = number
default = 4
}
variable "eks_ng_min_size" {
description = "Node Group maximum size, default is 10"
variable "eks_ng_max_size" {
description = "Node Group maximum size"
type = number
default = 16
default = 15
}

0 comments on commit a8e4f8e

Please sign in to comment.