Skip to content

Commit

Permalink
Added output documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
zawac002 committed Sep 1, 2023
1 parent 410a73a commit 814191b
Showing 1 changed file with 192 additions and 10 deletions.
202 changes: 192 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@

Create an EKS cluster given the specification of the cluster.

**NOTE:** At this time, the cluster-admin group is not created in AWS due
to interactions with the ldap provider.
**NOTE:** At this time, the cluster-admin group is not created in AWS due to interactions with the ldap provider.

The module creates an EKS cluster with `eks_ng_desired_size` nodes initially.
The cluster-autoscaler will resize the node group based upon capacity from a
minimum of `eks_ng_min_size` to a maximum of `eks_ng_max_size`.
The `eks_instance_types` is a prioritized list of instance types to use as
the worker nodes.
Note that it is best if the vCPU and Mem sizes of all of the instance types
are the same.
The module creates an EKS cluster named `cluster_name` in the `region` using kuberenetes version `cluster_version` with `eks_ng_desired_size` nodes initially.
The services in the cluster will be accessible using hostnames for the services ending with the `cluster_name`.`domain` fully qualified domain name.
The cluster-autoscaler will resize the node group based upon capacity from a minimum of `eks_ng_min_size` to a maximum of `eks_ng_max_size`.
The `eks_instance_types` is a prioritized list of instance types to use as the worker nodes.
Note that it is best if the vCPU and Mem sizes of all of the instance types are the same.

The cluster is configured with an oidc provider allowing service accounts to be configured with IRSA roles as needed.

Addons installed:
- aws-efs-csi-driver
Expand All @@ -21,7 +20,8 @@ Addons installed:
- kube-proxy
- vpc-cni

Note that at this stage, the csi-drivers are not configured. That takes place in the eks-storage-classes module.
Note that at this stage, the csi-drivers are not configured.
The csi-driver configuration takes place in the eks-storage-classes module.

## Required Inputs

Expand Down Expand Up @@ -108,3 +108,185 @@ The node group maximum size
Default: `15`


## Outputs

**module_name**

Description: The name of this module."


**module_version**

Description: The version of this module."


**vpc_cni_irsa_role**

Description: The arn/name/unique_id of the irsa role for the vpc-cni addon"


**ebs_csi_irsa_role**

Description: The arn/name/unique_id of the irsa role for the ebs-csi-driver addon"


**efs_csi_irsa_role**

Description: The arn/name/unique_id of the irsa role for the efs-csi-driver addon"


**cluster_autoscaler_irsa_role**

Description: The arn/name/unique_id of the irsa role for the cluster autoscaler addon"


**cluster_iam_role**

Description: The arn/name/unique_id of the iam role for the cluster"


**cluster_arn**

Description: The Amazon Resource Name (ARN) of the cluster"


**cluster_certificate_authority_data**

Description: Base64 encoded certificate data required to communicate with the cluster"


**cluster_endpoint**

Description: Endpoint for your Kubernetes API server"


**cluster_id**

Description: The ID of the EKS cluster. Note: currently a value is returned only for local EKS clusters created on Outposts"


**cluster_name**

Description: The name of the EKS cluster"


**cluster_version**

Description: The Kubernetes version for the cluster"


**cluster_platform_version**

Description: Platform version for the cluster"


**cluster_status**

Description: Status of the EKS cluster. One of `CREATING`, `ACTIVE`, `DELETING`, `FAILED`"


**kms_key_arn**

Description: The Amazon Resource Name (ARN) of the key"


**kms_key_id**

Description: The globally unique identifier for the key"


**kms_key_policy**

Description: The IAM resource policy set on the key"


**cluster_security_group_arn**

Description: Amazon Resource Name (ARN) of the cluster security group"


**cluster_security_group_id**

Description: ID of the cluster security group"


**cluster_primary_security_group_id**

Description: Cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication. Referred to as 'Cluster security group' in the EKS console"


**node_security_group_arn**

Description: Amazon Resource Name (ARN) of the node shared security group"


**node_security_group_id**

Description: ID of the node shared security group"


**oidc_provider**

Description: The OpenID Connect identity provider (issuer URL without leading `https://`)"


**oidc_provider_arn**

Description: The ARN of the OIDC Provider if `enable_irsa = true`"


**cluster_oidc_issuer_url**

Description: The URL on the EKS cluster for the OpenID Connect identity provider"


**cluster_tls_certificate_sha1_fingerprint**

Description: The SHA1 fingerprint of the public key of the cluster's certificate"


**cluster_addons**

Description: Map of attribute maps for all EKS cluster addons enabled"


**cluster_identity_providers**

Description: Map of attribute maps for all EKS identity providers enabled"


**cloudwatch_log_group_arn**

Description: Arn of cloudwatch log group created"


**cloudwatch_log_group_name**

Description: Name of cloudwatch log group created"


**fargate_profiles**

Description: Map of attribute maps for all EKS Fargate Profiles created"


**eks_managed_node_groups**

Description: Map of attribute maps for all EKS managed node groups created"


**eks_managed_node_groups_autoscaling_group_names**

Description: List of the autoscaling group names created by EKS managed node groups"


**self_managed_node_groups**

Description: Map of attribute maps for all self managed node groups created"


**self_managed_node_groups_autoscaling_group_names**

Description: List of the autoscaling group names created by self-managed node groups"


0 comments on commit 814191b

Please sign in to comment.