From b66ec512acfea5cad1ad8dc3a809e60b40c675ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Tarot?= Date: Wed, 29 May 2024 18:27:41 +0200 Subject: [PATCH 1/4] Fix helm install on cloud provider admonition block * Add missing admonition type. * Format link to AWS LB controller. * Add nested YAML code block for annotations example * Add a couple of line breaks for breathing and structure --- docs/deploy/index.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/deploy/index.md b/docs/deploy/index.md index 1cc01ba544..19f7fe2a76 100644 --- a/docs/deploy/index.md +++ b/docs/deploy/index.md @@ -65,14 +65,18 @@ It will install the controller in the `ingress-nginx` namespace, creating that n helm show values ingress-nginx --repo https://kubernetes.github.io/ingress-nginx ``` -!!! helm install on AWS/GCP/Azure/Other providers +!!! attention helm install on AWS/GCP/Azure/Other providers There have been too many attempts at using helm to install the controller on the cloud infra like AWS/GCP/Azure/Other. + The ingress-nginx-controller helm-chart is a generic install out of the box. The default set of helm values are not configured for installing on any infra provider. The annotations that are applicable to the cloud provider must be customized by the users. - Link to AWS LB Constroller https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/guide/service/annotations/ - Examples of some annotations needed for the service resource of --type LoadBalancer on AWS are below + + See [AWS LB Constroller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/guide/service/annotations/). + + Examples of some annotations needed for the service resource of --type LoadBalancer on AWS are below: + ```yaml annotations: service.beta.kubernetes.io/aws-load-balancer-scheme: "internet-facing" service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp @@ -85,11 +89,7 @@ helm show values ingress-nginx --repo https://kubernetes.github.io/ingress-nginx service.beta.kubernetes.io/aws-load-balancer-access-log-s3-bucket-name: "somebucket" service.beta.kubernetes.io/aws-load-balancer-access-log-s3-bucket-prefix: "ingress-nginx" service.beta.kubernetes.io/aws-load-balancer-access-log-emit-interval: "5" - - - - - + ``` **If you don't have Helm** or if you prefer to use a YAML manifest, you can run the following command instead: From 9cf0f93659325ac9156599028f9ed1bbf411801b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Tarot?= Date: Wed, 29 May 2024 18:34:32 +0200 Subject: [PATCH 2/4] Fix admonition block title --- docs/deploy/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploy/index.md b/docs/deploy/index.md index 19f7fe2a76..4567f81db0 100644 --- a/docs/deploy/index.md +++ b/docs/deploy/index.md @@ -65,7 +65,7 @@ It will install the controller in the `ingress-nginx` namespace, creating that n helm show values ingress-nginx --repo https://kubernetes.github.io/ingress-nginx ``` -!!! attention helm install on AWS/GCP/Azure/Other providers +!!! attention helm install on AWS/GCP/Azure/Other providers There have been too many attempts at using helm to install the controller on the cloud infra like AWS/GCP/Azure/Other. The ingress-nginx-controller helm-chart is a generic install out of the box. From a041325eeb091818dfad4b5d1e62d181c69e8b0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Tarot?= Date: Wed, 29 May 2024 18:44:11 +0200 Subject: [PATCH 3/4] Another try --- docs/deploy/index.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/deploy/index.md b/docs/deploy/index.md index 4567f81db0..b3777cab8d 100644 --- a/docs/deploy/index.md +++ b/docs/deploy/index.md @@ -65,17 +65,11 @@ It will install the controller in the `ingress-nginx` namespace, creating that n helm show values ingress-nginx --repo https://kubernetes.github.io/ingress-nginx ``` -!!! attention helm install on AWS/GCP/Azure/Other providers - There have been too many attempts at using helm to install the controller on the cloud infra like AWS/GCP/Azure/Other. - - The ingress-nginx-controller helm-chart is a generic install out of the box. - The default set of helm values are not configured for installing on any infra provider. - The annotations that are applicable to the cloud provider must be customized by the users. - - See [AWS LB Constroller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/guide/service/annotations/). - +!!! attention "helm install on AWS/GCP/Azure/Other providers" + There have been too many attempts at using helm to install the controller on the cloud infra like AWS/GCP/Azure/Other.
+ The ingress-nginx-controller helm-chart is a generic install out of the box. The default set of helm values are **not** configured for installing on any infra provider. The annotations that are applicable to the cloud provider must be customized by the users.
+ See [AWS LB Constroller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/guide/service/annotations/).
Examples of some annotations needed for the service resource of --type LoadBalancer on AWS are below: - ```yaml annotations: service.beta.kubernetes.io/aws-load-balancer-scheme: "internet-facing" From 7564ff226a15aef179c9a7ce7227c304dbc87e56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Tarot?= Date: Wed, 29 May 2024 18:51:03 +0200 Subject: [PATCH 4/4] Should be nice now --- docs/deploy/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/deploy/index.md b/docs/deploy/index.md index b3777cab8d..d8cc6f875b 100644 --- a/docs/deploy/index.md +++ b/docs/deploy/index.md @@ -65,11 +65,10 @@ It will install the controller in the `ingress-nginx` namespace, creating that n helm show values ingress-nginx --repo https://kubernetes.github.io/ingress-nginx ``` -!!! attention "helm install on AWS/GCP/Azure/Other providers" - There have been too many attempts at using helm to install the controller on the cloud infra like AWS/GCP/Azure/Other.
- The ingress-nginx-controller helm-chart is a generic install out of the box. The default set of helm values are **not** configured for installing on any infra provider. The annotations that are applicable to the cloud provider must be customized by the users.
+!!! attention "Helm install on AWS/GCP/Azure/Other providers" + The *ingress-nginx-controller helm-chart is a generic install out of the box*. The default set of helm values is **not** configured for installation on any infra provider. The annotations that are applicable to the cloud provider must be customized by the users.
See [AWS LB Constroller](https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.2/guide/service/annotations/).
- Examples of some annotations needed for the service resource of --type LoadBalancer on AWS are below: + Examples of some annotations needed for the service resource of `--type LoadBalancer` on AWS are below: ```yaml annotations: service.beta.kubernetes.io/aws-load-balancer-scheme: "internet-facing"