Skip to content

Commit a07c63c

Browse files
committed
docs: update README.md
1 parent f0ebc9c commit a07c63c

File tree

1 file changed

+40
-32
lines changed

1 file changed

+40
-32
lines changed

README.md

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
<!-- BEGIN_TF_DOCS -->
2+
[<img src="https://cdn.prod.website-files.com/66b4bc4ca83726f5a87183ab/685136470d15399f106cb13e_adcbd542a834a1942d077cd5c09d3057_GitHub%20cover%20image%201584x396.png">](https://lablabs.io/)
3+
4+
**About us:**</br>
5+
[Labyrinth Labs](https://lablabs.io/) is a one-stop-shop for **DevOps, Cloud & Kubernetes**! We specialize in creating **powerful**, **scalable** and **cloud-native platforms** tailored to elevate your business.
6+
7+
[As a team of experienced DevOps engineers](https://lablabs.io/about/), we know how to help our customers start their journey in the cloud, address the issues they have in their current setups and provide a **strategic solution to transform their infrastructure**.
8+
9+
----
210
# AWS EKS Load Balancer Controller Terraform module
311

412
A Terraform module to deploy the [AWS Load Balancer Controller](https://github.com/kubernetes-sigs/aws-load-balancer-controller) on Amazon EKS cluster.
@@ -19,29 +27,27 @@ A Terraform module to deploy the [AWS Load Balancer Controller](https://github.c
1927

2028
---
2129

22-
## Related Projects
23-
24-
Check out other [Terraform Kubernetes addons](https://github.com/orgs/lablabs/repositories?q=terraform-aws-eks&type=public&language=&sort=).
25-
26-
[<img src="https://lablabs.io/static/ll-logo.png" width=350px>](https://lablabs.io/)
30+
## Supported Terraform provider versions
2731

28-
We help companies build, run, deploy and scale software and infrastructure by embracing the right technologies and principles. Check out our website at <https://lablabs.io/>.
32+
While we are not setting upper bound on the Terraform providers used by the addon we are testing its functionality only against versions specified in the [`.terraform.lock.hcl`](.terraform.lock.hcl) file.
2933

3034
## Deployment methods
3135

3236
### Helm
37+
3338
Deploy Helm chart via Helm resource (default method, set `enabled = true`)
3439

3540
### Argo Kubernetes
41+
3642
Deploy Helm chart as ArgoCD Application via Kubernetes manifest resource (set `enabled = true` and `argo_enabled = true`)
3743

38-
> **Warning**
39-
>
44+
> [!WARNING]
4045
> When deploying with ArgoCD application, Kubernetes terraform provider requires access to Kubernetes cluster API during plan time. This introduces potential issue when you want to deploy the cluster with this addon at the same time, during the same Terraform run.
4146
>
4247
> To overcome this issue, the module deploys the ArgoCD application object using the Helm provider, which does not require API access during plan. If you want to deploy the application using this workaround, you can set the `argo_helm_enabled` variable to `true`.
4348
4449
### Argo Helm
50+
4551
Deploy Helm chart as ArgoCD Application via Helm resource (set `enabled = true`, `argo_enabled = true` and `argo_helm_enabled = true`)
4652

4753
## Examples
@@ -51,18 +57,18 @@ See [basic example](examples/basic) for further information.
5157

5258
| Name | Version |
5359
|------|---------|
54-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.5 |
55-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5 |
56-
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | ~> 2.6 |
57-
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | ~> 2.20 |
58-
| <a name="requirement_utils"></a> [utils](#requirement\_utils) | ~> 1 |
60+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5 |
61+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5 |
62+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.6 |
63+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.20 |
64+
| <a name="requirement_utils"></a> [utils](#requirement\_utils) | >= 1 |
5965

6066
## Modules
6167

6268
| Name | Source | Version |
6369
|------|--------|---------|
64-
| <a name="module_addon"></a> [addon](#module\_addon) | git::https://github.com/lablabs/terraform-aws-eks-universal-addon.git//modules/addon | v0.0.23 |
65-
| <a name="module_addon-irsa"></a> [addon-irsa](#module\_addon-irsa) | git::https://github.com/lablabs/terraform-aws-eks-universal-addon.git//modules/addon-irsa | v0.0.23 |
70+
| <a name="module_addon"></a> [addon](#module\_addon) | git::https://github.com/lablabs/terraform-aws-eks-universal-addon.git//modules/addon | v0.0.24 |
71+
| <a name="module_addon-irsa"></a> [addon-irsa](#module\_addon-irsa) | git::https://github.com/lablabs/terraform-aws-eks-universal-addon.git//modules/addon-irsa | v0.0.24 |
6672
## Resources
6773

6874
| Name | Type |
@@ -82,7 +88,7 @@ See [basic example](examples/basic) for further information.
8288
| <a name="input_argo_helm_enabled"></a> [argo\_helm\_enabled](#input\_argo\_helm\_enabled) | If set to `true`, the ArgoCD Application manifest will be deployed using Kubernetes provider as a Helm release. Otherwise it'll be deployed as a Kubernetes manifest. See README for more info. Defaults to `false`. | `bool` |
8389
| <a name="input_argo_helm_values"></a> [argo\_helm\_values](#input\_argo\_helm\_values) | Value overrides to use when deploying ArgoCD Application object with Helm. Defaults to `""`. | `string` |
8490
| <a name="input_argo_helm_wait_backoff_limit"></a> [argo\_helm\_wait\_backoff\_limit](#input\_argo\_helm\_wait\_backoff\_limit) | Backoff limit for ArgoCD Application Helm release wait job. Defaults to `6`. | `number` |
85-
| <a name="input_argo_helm_wait_kubectl_version"></a> [argo\_helm\_wait\_kubectl\_version](#input\_argo\_helm\_wait\_kubectl\_version) | Version of kubectl to use for ArgoCD Application wait job. Defaults to `1.33.2`. | `string` |
91+
| <a name="input_argo_helm_wait_kubectl_version"></a> [argo\_helm\_wait\_kubectl\_version](#input\_argo\_helm\_wait\_kubectl\_version) | Version of kubectl to use for ArgoCD Application wait job. Defaults to `1.33.3`. | `string` |
8692
| <a name="input_argo_helm_wait_node_selector"></a> [argo\_helm\_wait\_node\_selector](#input\_argo\_helm\_wait\_node\_selector) | Node selector for ArgoCD Application Helm release wait job. Defaults to `{}`. | `map(string)` |
8793
| <a name="input_argo_helm_wait_timeout"></a> [argo\_helm\_wait\_timeout](#input\_argo\_helm\_wait\_timeout) | Timeout for ArgoCD Application Helm release wait job. Defaults to `10m`. | `string` |
8894
| <a name="input_argo_helm_wait_tolerations"></a> [argo\_helm\_wait\_tolerations](#input\_argo\_helm\_wait\_tolerations) | Tolerations for ArgoCD Application Helm release wait job. Defaults to `[]`. | `list(any)` |
@@ -198,20 +204,22 @@ details.
198204

199205
See [LICENSE](LICENSE) for full details.
200206

201-
Licensed to the Apache Software Foundation (ASF) under one
202-
or more contributor license agreements. See the NOTICE file
203-
distributed with this work for additional information
204-
regarding copyright ownership. The ASF licenses this file
205-
to you under the Apache License, Version 2.0 (the
206-
"License"); you may not use this file except in compliance
207-
with the License. You may obtain a copy of the License at
208-
209-
https://www.apache.org/licenses/LICENSE-2.0
210-
211-
Unless required by applicable law or agreed to in writing,
212-
software distributed under the License is distributed on an
213-
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
214-
KIND, either express or implied. See the License for the
215-
specific language governing permissions and limitations
216-
under the License.
207+
```plan
208+
Licensed to the Apache Software Foundation (ASF) under one
209+
or more contributor license agreements. See the NOTICE file
210+
distributed with this work for additional information
211+
regarding copyright ownership. The ASF licenses this file
212+
to you under the Apache License, Version 2.0 (the
213+
"License"); you may not use this file except in compliance
214+
with the License. You may obtain a copy of the License at
215+
216+
<https://www.apache.org/licenses/LICENSE-2.0>
217+
218+
Unless required by applicable law or agreed to in writing,
219+
software distributed under the License is distributed on an
220+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
221+
KIND, either express or implied. See the License for the
222+
specific language governing permissions and limitations
223+
under the License.
224+
```
217225
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)