From 4356587ec8adebd850cfb8b0ef74f877c7e8ee0b Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Wed, 19 Aug 2020 15:48:16 -0400 Subject: [PATCH 1/3] Fix chart readme link in upgrade section. Removes redundant URL in favor of zero-downtime section header anchor Signed-off-by: Scott Rigby --- charts/ingress-nginx/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/ingress-nginx/README.md b/charts/ingress-nginx/README.md index 071bc8d06..67f2b2abd 100644 --- a/charts/ingress-nginx/README.md +++ b/charts/ingress-nginx/README.md @@ -71,7 +71,7 @@ There are two main ways to migrate a release from `stable/nginx-ingress` to `ing 1. Redirect your DNS traffic from the old controller to the new controller 1. Log traffic from both controllers during this changeover 1. [Uninstall](#uninstall-chart) the old controller once traffic has fully drained from it - 1. For details on all of these steps see [Upgrading With Zero Downtime in Production](https://medium.com/codecademy-engineering/kubernetes-nginx-and-zero-downtime-in-production-2c910c6a5ed8) + 1. For details on all of these steps see [Upgrading With Zero Downtime in Production](#upgrading-with-zero-downtime-in-production) Note that there are some different and upgraded configurations between the two charts, described by Rimas Mocevicius from JFrog in the "Upgrading to ingress-nginx Helm chart" section of [Migrating from Helm chart nginx-ingress to ingress-nginx](https://rimusz.net/migrating-to-ingress-nginx). As the `ingress-nginx/ingress-nginx` chart continues to update, you will want to check current differences by running [helm configuration](#configuration) commands on both charts. From ae136cac925aad2eb27acb1b9609fb154f2785b6 Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Wed, 19 Aug 2020 15:58:07 -0400 Subject: [PATCH 2/3] Direct link to index.yaml for easy browsing by end users without CLI Signed-off-by: Scott Rigby --- charts/ingress-nginx/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/ingress-nginx/README.md b/charts/ingress-nginx/README.md index 67f2b2abd..9ca4d9372 100644 --- a/charts/ingress-nginx/README.md +++ b/charts/ingress-nginx/README.md @@ -77,7 +77,7 @@ Note that there are some different and upgraded configurations between the two c ## Configuration -See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments: +See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console # Helm 2 From 58c1ca6176df6731af65ffd1c1c3c2bf046701ef Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Wed, 19 Aug 2020 15:58:32 -0400 Subject: [PATCH 3/3] Fix YAML linting Signed-off-by: Scott Rigby --- charts/ingress-nginx/README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/charts/ingress-nginx/README.md b/charts/ingress-nginx/README.md index 9ca4d9372..ebaf66221 100644 --- a/charts/ingress-nginx/README.md +++ b/charts/ingress-nginx/README.md @@ -13,9 +13,9 @@ This chart bootstraps an ingress-nginx deployment on a [Kubernetes](http://kuber ## Get Repo Info ```console -$ helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx -$ helm repo add stable https://kubernetes-charts.storage.googleapis.com/ -$ helm repo update +helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx +helm repo add stable https://kubernetes-charts.storage.googleapis.com/ +helm repo update ``` ## Install Chart @@ -101,8 +101,9 @@ You can add Prometheus annotations to the metrics service using `controller.metr ### ingress-nginx nginx\_status page/stats server Previous versions of this chart had a `controller.stats.*` configuration block, which is now obsolete due to the following changes in nginx ingress controller: -* in [0.16.1](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0161), the vts (virtual host traffic status) dashboard was removed -* in [0.23.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0230), the status page at port 18080 is now a unix socket webserver only available at localhost. + +- In [0.16.1](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0161), the vts (virtual host traffic status) dashboard was removed +- In [0.23.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0230), the status page at port 18080 is now a unix socket webserver only available at localhost. You can use `curl --unix-socket /tmp/nginx-status-server.sock http://localhost/nginx_status` inside the controller container to access it locally, or use the snippet from [nginx-ingress changelog](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0230) to re-enable the http server ### ExternalDNS Service Configuration @@ -162,6 +163,7 @@ If one of them is missing the internal load balancer will not be deployed. Examp `controller.service.internal.annotations` varies with the cloud service you're using. Example for AWS: + ```yaml controller: service: @@ -174,6 +176,7 @@ controller: ``` Example for GCE: + ```yaml controller: service: @@ -187,7 +190,6 @@ controller: An use case for this scenario is having a split-view DNS setup where the public zone CNAME records point to the external balancer URL while the private zone CNAME records point to the internal balancer URL. This way, you only need one ingress kubernetes object. - ### Ingress Admission Webhooks With nginx-ingress-controller version 0.25+, the nginx ingress controller pod exposes an endpoint that will integrate with the `validatingwebhookconfiguration` Kubernetes feature to prevent bad ingress from being added to the cluster. @@ -199,7 +201,7 @@ With nginx-ingress-controller in 0.25.* work only with kubernetes 1.14+, 0.26 fi If you are upgrading this chart from a version between 0.31.0 and 1.2.2 then you may get an error like this: -``` +```console Error: UPGRADE FAILED: Service "?????-controller" is invalid: spec.clusterIP: Invalid value: "": field is immutable ```