From 40c69a1ef706a76c6b47d317003965ba9186cde3 Mon Sep 17 00:00:00 2001 From: Jintao Zhang Date: Fri, 28 Jan 2022 22:16:31 +0800 Subject: [PATCH] chore: add Artifact Hub lint (#8204) Signed-off-by: Jintao Zhang --- .github/workflows/ci.yaml | 7 ++++ charts/ingress-nginx/Chart.yaml | 70 ++++++++++++++++---------------- charts/ingress-nginx/README.md | 10 +++-- charts/ingress-nginx/values.yaml | 1 + 4 files changed, 49 insertions(+), 39 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 63bc7da08a..25b8d5e14a 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -148,6 +148,13 @@ jobs: git diff --exit-code rm -f ./helm-docs + - name: Run Artifact Hub lint + run: | + wget https://github.com/artifacthub/hub/releases/download/v1.5.0/ah_1.5.0_linux_amd64.tar.gz + tar -xzvf ah_1.5.0_linux_amd64.tar.gz ah + ./ah lint -p charts/ingress-nginx || exit 1 + rm -f ./ah ./ah_1.5.0_linux_amd64.tar.gz + - name: fix permissions run: | sudo mkdir -p $HOME/.kube diff --git a/charts/ingress-nginx/Chart.yaml b/charts/ingress-nginx/Chart.yaml index 4d48ca0c38..e57e3ebb6a 100644 --- a/charts/ingress-nginx/Chart.yaml +++ b/charts/ingress-nginx/Chart.yaml @@ -24,38 +24,38 @@ annotations: # List of changes for the release in artifacthub.io # https://artifacthub.io/packages/helm/ingress-nginx/ingress-nginx?modal=changelog artifacthub.io/changes: | - - #8120 Update go in runner and release v1.1.1 - - #8119 Update to go v1.17.6 - - #8118 Remove deprecated libraries, update other libs - - #8117 Fix codegen errors - - #8115 chart/ghaction: set the correct permission to have access to push a release - - #8098 generating SHA for CA only certs in backend_ssl.go + comparision of P… - - #8088 Fix Edit this page link to use main branch - - #8072 Expose GeoIP2 Continent code as variable - - #8061 docs(charts): using helm-docs for chart - - #8058 Bump github.com/spf13/cobra from 1.2.1 to 1.3.0 - - #8054 Bump google.golang.org/grpc from 1.41.0 to 1.43.0 - - #8051 align bug report with feature request regarding kind documentation - - #8046 Report expired certificates (#8045) - - #8044 remove G109 check till gosec resolves issues - - #8042 docs_multiple_instances_one_cluster_ticket_7543 - - #8041 docs: fix typo'd executible name - - #8035 Comment busy owners - - #8029 Add stream-snippet as a ConfigMap and Annotation option - - #8023 fix nginx compilation flags - - #8021 Disable default modsecurity_rules_file if modsecurity-snippet is specified - - #8019 Revise main documentation page - - #8018 Preserve order of plugin invocation - - #8015 Add newline indenting to admission webhook annotations - - #8014 Add link to example error page manifest in docs - - #8009 Fix spelling in documentation and top-level files - - #8008 Add relabelings in controller-servicemonitor.yaml - - #8003 Minor improvements (formatting, consistency) in install guide - - #8001 fix: go-grpc Dockerfile - - #7999 images: use k8s-staging-test-infra/gcb-docker-gcloud - - #7996 doc: improvement - - #7983 Fix a couple of misspellings in the annotations documentation. - - #7979 allow set annotations for admission Jobs - - #7977 Add ssl_reject_handshake to defaul server - - #7975 add legacy version update v0.50.0 to main changelog - - #7972 updated service upstream definition + - "#8120 Update go in runner and release v1.1.1" + - "#8119 Update to go v1.17.6" + - "#8118 Remove deprecated libraries, update other libs" + - "#8117 Fix codegen errors" + - "#8115 chart/ghaction: set the correct permission to have access to push a release" + - "#8098 generating SHA for CA only certs in backend_ssl.go + comparision of P…" + - "#8088 Fix Edit this page link to use main branch" + - "#8072 Expose GeoIP2 Continent code as variable" + - "#8061 docs(charts): using helm-docs for chart" + - "#8058 Bump github.com/spf13/cobra from 1.2.1 to 1.3.0" + - "#8054 Bump google.golang.org/grpc from 1.41.0 to 1.43.0" + - "#8051 align bug report with feature request regarding kind documentation" + - "#8046 Report expired certificates (#8045)" + - "#8044 remove G109 check till gosec resolves issues" + - "#8042 docs_multiple_instances_one_cluster_ticket_7543" + - "#8041 docs: fix typo'd executible name" + - "#8035 Comment busy owners" + - "#8029 Add stream-snippet as a ConfigMap and Annotation option" + - "#8023 fix nginx compilation flags" + - "#8021 Disable default modsecurity_rules_file if modsecurity-snippet is specified" + - "#8019 Revise main documentation page" + - "#8018 Preserve order of plugin invocation" + - "#8015 Add newline indenting to admission webhook annotations" + - "#8014 Add link to example error page manifest in docs" + - "#8009 Fix spelling in documentation and top-level files" + - "#8008 Add relabelings in controller-servicemonitor.yaml" + - "#8003 Minor improvements (formatting, consistency) in install guide" + - "#8001 fix: go-grpc Dockerfile" + - "#7999 images: use k8s-staging-test-infra/gcb-docker-gcloud" + - "#7996 doc: improvement" + - "#7983 Fix a couple of misspellings in the annotations documentation." + - "#7979 allow set annotations for admission Jobs" + - "#7977 Add ssl_reject_handshake to defaul server" + - "#7975 add legacy version update v0.50.0 to main changelog" + - "#7972 updated service upstream definition" diff --git a/charts/ingress-nginx/README.md b/charts/ingress-nginx/README.md index 15536a79eb..17b5341549 100644 --- a/charts/ingress-nginx/README.md +++ b/charts/ingress-nginx/README.md @@ -2,7 +2,7 @@ [ingress-nginx](https://github.com/kubernetes/ingress-nginx) Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer -![Version: 4.0.15](https://img.shields.io/badge/Version-4.0.15-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.1](https://img.shields.io/badge/AppVersion-1.1.1-informational?style=flat-square) +![Version: 4.0.16](https://img.shields.io/badge/Version-4.0.16-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.1](https://img.shields.io/badge/AppVersion-1.1.1-informational?style=flat-square) To use, add `ingressClassName: nginx` spec field or the `kubernetes.io/ingress.class: nginx` annotation to your Ingress resources. @@ -237,6 +237,7 @@ Kubernetes: `>=1.19.0-0` | Key | Type | Default | Description | |-----|------|---------|-------------| +| commonLabels | object | `{}` | | | controller.addHeaders | object | `{}` | Will add custom headers before sending response traffic to the client according to: https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#add-headers | | controller.admissionWebhooks.annotations | object | `{}` | | | controller.admissionWebhooks.certificate | string | `"/usr/local/certificates/cert"` | | @@ -278,10 +279,10 @@ Kubernetes: `>=1.19.0-0` | controller.autoscaling.targetMemoryUtilizationPercentage | int | `50` | | | controller.autoscalingTemplate | list | `[]` | | | controller.config | object | `{}` | Will add custom configuration options to Nginx https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/ | -| controller.configAnnotations | object | `{}` | Annotations to be added to the controller config configuration configmap | +| controller.configAnnotations | object | `{}` | Annotations to be added to the controller config configuration configmap. | | controller.configMapNamespace | string | `""` | Allows customization of the configmap / nginx-configmap namespace; defaults to $(POD_NAMESPACE) | | controller.containerName | string | `"controller"` | Configures the controller container name | -| controller.containerPort | object | `{"http":80,"https":443}` | Configures the ports the nginx-controller listens on | +| controller.containerPort | object | `{"http":80,"https":443}` | Configures the ports that the nginx-controller listens on | | controller.customTemplate.configMapKey | string | `""` | | | controller.customTemplate.configMapName | string | `""` | | | controller.dnsConfig | object | `{}` | Optionally customize the pod dnsConfig. | @@ -293,6 +294,7 @@ Kubernetes: `>=1.19.0-0` | controller.extraContainers | list | `[]` | Additional containers to be added to the controller pod. See https://github.com/lemonldap-ng-controller/lemonldap-ng-controller as example. | | controller.extraEnvs | list | `[]` | Additional environment variables to set | | controller.extraInitContainers | list | `[]` | Containers, which are run before the app containers are started. | +| controller.extraModules | list | `[]` | | | controller.extraVolumeMounts | list | `[]` | Additional volumeMounts to the controller main container. | | controller.extraVolumes | list | `[]` | Additional volumes to the controller pod. | | controller.healthCheckHost | string | `""` | Address to bind the health check endpoint. It is better to set this option to the internal node address if the ingress nginx controller is running in the `hostNetwork: true` mode. | @@ -309,7 +311,7 @@ Kubernetes: `>=1.19.0-0` | controller.image.registry | string | `"k8s.gcr.io"` | | | controller.image.runAsUser | int | `101` | | | controller.image.tag | string | `"v1.1.1"` | | -| controller.ingressClassByName | bool | `false` | Process IngressClass per name (additionally as per spec.controller) | +| controller.ingressClassByName | bool | `false` | Process IngressClass per name (additionally as per spec.controller). | | controller.ingressClassResource.controllerValue | string | `"k8s.io/ingress-nginx"` | Controller-value of the controller that is processing this ingressClass | | controller.ingressClassResource.default | bool | `false` | Is this the default ingressClass for the cluster | | controller.ingressClassResource.enabled | bool | `true` | Is this ingressClass enabled or not | diff --git a/charts/ingress-nginx/values.yaml b/charts/ingress-nginx/values.yaml index 67144b0973..079094b2ba 100644 --- a/charts/ingress-nginx/values.yaml +++ b/charts/ingress-nginx/values.yaml @@ -888,6 +888,7 @@ serviceAccount: create: true name: "" automountServiceAccountToken: true + # -- Annotations for the controller service account annotations: {} # -- Optional array of imagePullSecrets containing private registry credentials