Skip to content

Commit

Permalink
Repository: Rename master to main. (#357)
Browse files Browse the repository at this point in the history
Also updates upstream references since they already renamed a while ago.
  • Loading branch information
Gacko committed Oct 24, 2022
1 parent 1a1a877 commit f5ca672
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 25 deletions.
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ workflows:
- architect/run-tests-with-ats:
name: execute chart tests
filters:
# Do not trigger the job on merge to master.
# Do not trigger the job on merge to main.
branches:
ignore:
- master
- main
requires:
- push-to-giantswarm-app-catalog

Expand Down
31 changes: 16 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project's packages adheres to [Semantic Versioning](http://semver.org/s
### Changed

- Helpers: Rename `resource.default.name` to `ingress-nginx.fullname`. ([#356](https://github.com/giantswarm/nginx-ingress-controller-app/pull/356))
- Repository: Rename `master` to `main`. ([#357](https://github.com/giantswarm/nginx-ingress-controller-app/pull/357))

## [2.19.0] - 2022-10-17

Expand Down Expand Up @@ -233,7 +234,7 @@ This release contains a potential breaking change in case you are using and rely

### Changed

- **Breaking change** Update controller container image to [`v1.0.0`](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#100). From this version on, only clusters with kubernetes >= 1.19 are supported. Please make sure to read the [upgrading notes](https://github.com/giantswarm/nginx-ingress-controller-app/blob/master/README.md#upgrading-notes). ([#218](https://github.com/giantswarm/nginx-ingress-controller-app/pull/218)).
- **Breaking change** Update controller container image to [`v1.0.0`](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#100). From this version on, only clusters with kubernetes >= 1.19 are supported. Please make sure to read the [upgrading notes](https://github.com/giantswarm/nginx-ingress-controller-app/blob/main/README.md#upgrading-notes). ([#218](https://github.com/giantswarm/nginx-ingress-controller-app/pull/218)).

## [2.1.4] - 2022-04-07

Expand Down Expand Up @@ -282,7 +283,7 @@ Note: This upgrade is only a breaking change in the unlikely event that you have

### Changed

- Update controller container image to [`v0.47.0`](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0470). ([#204](https://github.com/giantswarm/nginx-ingress-controller-app/pull/204))
- Update controller container image to [`v0.47.0`](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#0470). ([#204](https://github.com/giantswarm/nginx-ingress-controller-app/pull/204))

## [1.16.1] - 2021-04-20

Expand All @@ -295,7 +296,7 @@ Note: This upgrade is only a breaking change in the unlikely event that you have
### Fixed

- Fixes validation of cpu requests and limits to allow for string and integer values.
- Update controller container image to [`v0.45.0`](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0450) to correct OpenSSL CVEs. ([#188](https://github.com/giantswarm/nginx-ingress-controller-app/pull/188))
- Update controller container image to [`v0.45.0`](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#0450) to correct OpenSSL CVEs. ([#188](https://github.com/giantswarm/nginx-ingress-controller-app/pull/188))
- Change monitoring service port to `10254`. ([#188](https://github.com/giantswarm/nginx-ingress-controller-app/pull/188))

## [1.15.1] - 2021-04-01
Expand All @@ -308,7 +309,7 @@ Note: This upgrade is only a breaking change in the unlikely event that you have

### Changed

- Update controller container image to [`v0.44.0`](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md) and kube-webhook-certgen container image to 1.5.1. ([#179](https://github.com/giantswarm/nginx-ingress-controller-app/pull/179))
- Update controller container image to [`v0.44.0`](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md) and kube-webhook-certgen container image to 1.5.1. ([#179](https://github.com/giantswarm/nginx-ingress-controller-app/pull/179))
- Remove conflicting admission webhook api versions. ([#178](https://github.com/giantswarm/nginx-ingress-controller-app/pull/178))
- Remove unecessary annotation. ([#180](https://github.com/giantswarm/nginx-ingress-controller-app/pull/180))

Expand Down Expand Up @@ -356,18 +357,18 @@ Note: This upgrade is only a breaking change in the unlikely event that you have

### Changed

- Upgrade ingress-nginx-controller from v0.35.0 to [v0.40.2](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0402).
- Upgrade ingress-nginx-controller from v0.35.0 to [v0.40.2](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#0402).

**Important** upstream changes to pay special attention to:

- App/chart requires Kubernetes 1.16+ based platform release
- It is recommended to change API group of Ingress resources from `extensions/v1beta1` to `networking.k8s.io/v1beta1` (available since Kubernetes 1.14)
- Default configuration changes:
- [`gzip-level`](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/configmap.md#gzip-level) default changed from `5` to `1`
- [`ssl-session-tickets`](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/configmap.md#ssl-session-tickets) default changed from `true` to `false`
- [`use-gzip`](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/configmap.md#use-gzip) default changed from `true` to `false`
- [`upstream-keepalive-connections`](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/configmap.md#upstream-keepalive-connections) changed from `32` to `320`
- [`upstream-keepalive-requests`](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/configmap.md#upstream-keepalive-requests) changed from `100` to `10000`
- [`gzip-level`](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/configmap.md#gzip-level) default changed from `5` to `1`
- [`ssl-session-tickets`](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/configmap.md#ssl-session-tickets) default changed from `true` to `false`
- [`use-gzip`](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/configmap.md#use-gzip) default changed from `true` to `false`
- [`upstream-keepalive-connections`](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/configmap.md#upstream-keepalive-connections) changed from `32` to `320`
- [`upstream-keepalive-requests`](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/configmap.md#upstream-keepalive-requests) changed from `100` to `10000`
- Support and enable by default [mimalloc](https://github.com/microsoft/mimalloc) as a drop-in malloc replacement to reduce nginx memory utilization.
- Support configuring additional environment variables for NGINX Ingress Controller container, to support configuring additional mimalloc [options](https://github.com/microsoft/mimalloc#environment-options).
- Adjust Helm `hook-delete-policy` and `hook-weight` to make admission webhook management more reliable.
Expand All @@ -381,7 +382,7 @@ Note: This upgrade is only a breaking change in the unlikely event that you have

### Changed

- Upgrade to ingress-nginx [v0.35.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0350).
- Upgrade to ingress-nginx [v0.35.0](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#0350).

## [1.9.1] - 2020-08-14

Expand Down Expand Up @@ -450,13 +451,13 @@ In recent platform releases (Azure v12.0.2, and AWS v12.1.4 and v11.5.4) we've i

### Changed

- Upgrade to ingress-nginx [v0.34.1](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0341).
- Upgrade to ingress-nginx [v0.34.1](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#0341).

## [1.7.2] 2020-07-10

### Changed

- Upgrade to ingress-nginx [v0.34.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0340).
- Upgrade to ingress-nginx [v0.34.0](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#0340).

## [1.7.1] 2020-07-07

Expand All @@ -472,7 +473,7 @@ In recent platform releases (Azure v12.0.2, and AWS v12.1.4 and v11.5.4) we've i

- Use LoadBalancer Service on Azure.
- Change controller.service.type to LoadBalancer/NodePort, and introduce controller.service.public for public/internal service classification.
- Upgrade to ingress-nginx [0.33.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0330).
- Upgrade to ingress-nginx [0.33.0](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#0330).

## [1.6.12] 2020-06-04

Expand Down Expand Up @@ -514,7 +515,7 @@ In recent platform releases (Azure v12.0.2, and AWS v12.1.4 and v11.5.4) we've i
- Default `max-worker-connections` to `0`, making it same as `max-worker-open-files` i.e. `max open files (system's limit) / worker-processes - 1024`.
This optimizes for high load conditions where it improves performance at the cost of increasing RAM utilization (even on idle).
- HorizontalPodAutoscaler was tuned to use `targetMemoryUtilizationPercentage` of `80` due to increased RAM utilization with new default for `max-worker-connections` of `0`.
- Removed use of `enable-dynamic-certificates` CLI flag, it has been deprecated since [ingress-nginx 0.26.0](https://github.com/kubernetes/ingress-nginx/blob/master/Changelog.md#0260) via [ingress-nginx PR #4356](https://github.com/kubernetes/ingress-nginx/pull/4356)
- Removed use of `enable-dynamic-certificates` CLI flag, it has been deprecated since [ingress-nginx 0.26.0](https://github.com/kubernetes/ingress-nginx/blob/main/Changelog.md#0260) via [ingress-nginx PR #4356](https://github.com/kubernetes/ingress-nginx/pull/4356)
- Changed default `error-log-level` from `error` to `notice`.
- Added a link to the README in the sources of Chart.yaml

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ updates to the Ingress resource.

## Upgrading notes

Version [2.2.0](https://github.com/giantswarm/nginx-ingress-controller-app/blob/master/CHANGELOG.md#220---2021-09-09) of the nginx Ingress Controller app contains version [1.0.0](https://github.com/kubernetes/ingress-nginx/releases/tag/controller-v1.0.0)
Version [2.2.0](https://github.com/giantswarm/nginx-ingress-controller-app/blob/main/CHANGELOG.md#220---2021-09-09) of the nginx Ingress Controller app contains version [1.0.0](https://github.com/kubernetes/ingress-nginx/releases/tag/controller-v1.0.0)

### Prerequisites
- kubernetes version >= 1.19
- requires `networking.k8s.io/v1` (`extensions/v1beta1` or `networking.k8s.io/v1beta1` are no longer supported)
- An IngressClass (One will be created when installing app version [2.2.0](https://github.com/giantswarm/nginx-ingress-controller-app/blob/master/CHANGELOG.md#220---2021-09-09))
- An IngressClass (One will be created when installing app version [2.2.0](https://github.com/giantswarm/nginx-ingress-controller-app/blob/main/CHANGELOG.md#220---2021-09-09))

Additionally, you'll have to make sure your Ingress resources are using the `spec.IngressClassName` (or the deprecated `kubernetes.io/ingress.class` annotation) matching the name of your IngressClass (default `nginx`).

Expand Down Expand Up @@ -181,11 +181,11 @@ yourself you must remember to do this.

## Configuration Options

All configuration options are documented in the [values.yaml](https://github.com/giantswarm/nginx-ingress-controller-app/blob/master/helm/nginx-ingress-controller-app/values.yaml) file.
All configuration options are documented in the [values.yaml](https://github.com/giantswarm/nginx-ingress-controller-app/blob/main/helm/nginx-ingress-controller-app/values.yaml) file.

### Internal nginx IC options

This chart contains a template for an additional [internal service](https://github.com/giantswarm/nginx-ingress-controller-app/blob/master/helm/nginx-ingress-controller-app/templates/controller-service-internal.yaml) to cover the use case of having separate internal and external ingress routes with a single nginx IC instance.
This chart contains a template for an additional [internal service](https://github.com/giantswarm/nginx-ingress-controller-app/blob/main/helm/nginx-ingress-controller-app/templates/controller-service-internal.yaml) to cover the use case of having separate internal and external ingress routes with a single nginx IC instance.

Valid configuration options are as follows:

Expand All @@ -195,7 +195,7 @@ This is the default behavior. No additional configuration required.

**Make default service internal**

This configures the [default service](https://github.com/giantswarm/nginx-ingress-controller-app/blob/master/helm/nginx-ingress-controller-app/templates/controller-service.yaml) to spawn an internal facing load balancer. This disables the external ingress.
This configures the [default service](https://github.com/giantswarm/nginx-ingress-controller-app/blob/main/helm/nginx-ingress-controller-app/templates/controller-service.yaml) to spawn an internal facing load balancer. This disables the external ingress.
```yaml
controller:
service:
Expand Down Expand Up @@ -251,7 +251,7 @@ $ helm install nginx-ingress-controller-app -f values.yaml
### Release Process

* Ensure CHANGELOG.md is up to date.
* Create a new branch with name `master#release#vX.X.X`. Automation will create a release PR.
* Create a new branch with name `main#release#vX.X.X`. Automation will create a release PR.
* Merging the release PR will push a new git tag and trigger a new tarball to be pushed to the
[giantswarm-catalog].
* Test and verify the ingress controller release across supported environments in a new or existing WIP platform release.
Expand Down
2 changes: 1 addition & 1 deletion helm/nginx-ingress-controller-app/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# These values get applied directly to a configmap which configures the
# nginx-ingress-controller
# For all the nginx configmap config options see:
# https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/configmap.md#configmaps
# https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/configmap.md#configmaps
configmap:

# configmap.error-log-level
Expand Down
2 changes: 1 addition & 1 deletion objectives.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ General Quality Assurance
* Platform Compatibility Testing, with latest platform releases across providers (AWS, Azure, and KVM)
* End-to-End smoke tests to make sure Ingress traffic gets routed when (1) installing a new app, and (2) upgrading an app

Implementation details regarding performance tests and general quality assurance can be found in [performance test files](https://github.com/giantswarm/nginx-ingress-controller-app/blob/master/test/kat), [integration test files](https://github.com/giantswarm/nginx-ingress-controller-app/tree/master/integration) and [CircleCI configuration](https://github.com/giantswarm/nginx-ingress-controller-app/blob/master/.circleci/config.yml).
Implementation details regarding performance tests and general quality assurance can be found in [performance test files](https://github.com/giantswarm/nginx-ingress-controller-app/blob/main/test/kat), [integration test files](https://github.com/giantswarm/nginx-ingress-controller-app/tree/main/integration) and [CircleCI configuration](https://github.com/giantswarm/nginx-ingress-controller-app/blob/main/.circleci/config.yml).


**Third, 30 day upgrade objective.**
Expand Down

0 comments on commit f5ca672

Please sign in to comment.