-
Notifications
You must be signed in to change notification settings - Fork 2k
Add upgrading to 4.x docs #6930
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 6 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
b6a818e
add upgrading to 4.x page
d4376c9
Merge branch 'main' into chore/r33-upgrade-doc
e90efce
Merge branch 'main' into chore/r33-upgrade-doc
jjngx 410397e
Update upgrading docs
ed46ec8
Delete upgrading-to-4.x.x.md
3a0a68f
Apply suggestions from code review
a9c568c
Apply suggestions from code review
25963bc
Merge branch 'main' into chore/r33-upgrade-doc
ADubhlaoich 8194930
Merge branch 'main' into chore/r33-upgrade-doc
vepatel 0a36438
feat: Update IA, metadata and content related to v4 upgrades
ADubhlaoich d138483
Merge branch 'chore/r33-upgrade-doc' of github.com:nginxinc/kubernete…
ADubhlaoich 8c1cc8f
Merge branch 'main' into chore/r33-upgrade-doc
vepatel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| --- | ||
| description: Guide on upgrading to v4 and above | ||
| docs: DOCS-000 | ||
| title: Guild on Upgrading to v4 and above | ||
| toc: true | ||
| weight: 2100 | ||
| headless: true | ||
| --- | ||
|
|
||
| {{< note >}} | ||
| If you are using NGINX Ingress Controller version `v3.3.2` (Helm Chart `v1.0.2`) or earlier, please upgrade to `v3.7.2` (Helm Chart `v1.4.2`), and convert your TransportServer and GlobalConfiguration resources to `apiVersion` `k8s.nginx.org/v1`. | ||
vepatel marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| {{</ note >}} | ||
| 1. If using NGINX Ingress Controller resources with an `apiVersion` of `k8s.nginx.org/v1alpha1`, prior to upgrading to `v4.x` (Helm Chart `v2.x`) , **please ensure** that they are updated to `apiVersion: k8s.nginx.org/v1` | ||
j1m-ryan marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| {{< important >}} | ||
| If a resource of `kind: GlobalConfiguration`, `kind: Policy` or `kind: TransportServer` is deployed as `apiVersion: k8s.nginx.org/v1alpha1`, it will be **deleted** during the upgrade process | ||
| {{</ important >}} | ||
|
|
||
| Below is an example of how a Policy resource would change. Please ensure the same is done for GlobalConfiguration and TransportServer. | ||
|
|
||
| {{<tabs name="resource-version-update">}} | ||
|
|
||
| {{% comment %}} Keep this left aligned. {{% /comment %}} | ||
| {{%tab name="Before"%}} | ||
|
|
||
| ```yaml | ||
| apiVersion: k8s.nginx.org/v1alpha1 | ||
| kind: Policy | ||
| metadata: | ||
| name: rate-limit-policy | ||
| spec: | ||
| rateLimit: | ||
| rate: 1r/s | ||
| key: ${binary_remote_addr} | ||
| zoneSize: 10M | ||
| ``` | ||
|
|
||
|
|
||
| {{% /tab %}} | ||
|
|
||
| {{%tab name="After"%}} | ||
| ```yaml | ||
| apiVersion: k8s.nginx.org/v1 | ||
| kind: Policy | ||
| metadata: | ||
| name: rate-limit-policy | ||
| spec: | ||
| rateLimit: | ||
| rate: 1r/s | ||
| key: ${binary_remote_addr} | ||
| zoneSize: 10M | ||
| ``` | ||
| {{% /tab %}} | ||
|
|
||
| {{</tabs>}} | ||
|
|
||
| 1. Read the [Create License Secret]({{< relref "installation/installing-nic/create-license-secret">}}) topic to set up your NGINX Plus license. | ||
| 1. Usage reporting through the Cluster Connector is no longer required, and is now native to NGINX. | ||
| 1. If your NGINX Ingress Controller installation is in an "air-gapped" environment, [usage reports can be sent to NGINX Instance Manager]({{< relref "installation/installing-nic/create-license-secret/#nim">}}). | ||
| 1. Configure Structured Logging | ||
|
|
||
| {{<tabs name="structured logging">}} | ||
|
|
||
| {{%tab name="Helm"%}} | ||
|
|
||
| The previous Helm value `controller.logLevel` has been changed from an integer to a string. Options include: trace, debug, info, warning, error and fatal. | ||
|
|
||
| Logs can also be rendered in different formats using the `controller.logFormat` key. Options include: glog, json and text. This only applies to NGINX Ingress Controller logs, not NGINX logs. | ||
|
|
||
| ```yaml | ||
| controller: | ||
| logLevel: info | ||
| logFormat: json | ||
| ``` | ||
| {{% /tab %}} | ||
|
|
||
| {{%tab name="Manifests"%}} | ||
|
|
||
| The command line argument `-v` has been replaced with `-log-level`. It has been changed from an integer to a string. Options include: trace, debug, info, warning, error and fatal. | ||
|
|
||
| Logs can also be rendered in different formats using the `-log-format` command line argument. Options include: glog, json and text. This only applies to NGINX Ingress Controller logs, not NGINX logs. | ||
|
|
||
| The command line argument `-logtostderr` has been deprecated. | ||
|
|
||
| ```yaml | ||
| args: | ||
| - -log-level=info | ||
| - -log-format=json | ||
| ``` | ||
|
|
||
| {{% /tab %}} | ||
|
|
||
| {{</tabs>}} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.