Skip to content

Commit 7558cc0

Browse files
feat: Update NIC information architecture and content (#1422)
This commit flattens the information architecture of the installation section for NGINX Ingress Controller, flattening it and simplifying the URLs. It also adds a new Changelog section to replace the previous releases page, updates the Helm chart reference information, and addresses Markdown and metadata conventions for each affected page. --------- Co-authored-by: Paul Abel <[email protected]>
1 parent 60a2138 commit 7558cc0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+2923
-3110
lines changed

content/includes/nic/installation/create-custom-resources.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,10 @@ kubectl apply -f https://raw.githubusercontent.com/nginx/kubernetes-ingress/v{{<
3232

3333
{{< call-out "note" >}}
3434

35-
Read the steps outlined in [Upgrade from 3.x to 4.x]({{< ref "/nic/installation/upgrade-version.md#upgrade-from-3x-to-4x" >}}) before running the CRD upgrade and perform the steps if applicable.
35+
Read the steps outlined in [Upgrade from 3.x to 4.x]({{< ref "/nic/install/upgrade.md#upgrade-from-3x-to-4x" >}}) before running the CRD upgrade and perform the steps if applicable.
3636

3737
{{< /call-out >}}
3838

39-
4039
```shell
4140
kubectl apply -f config/crd/bases/k8s.nginx.org_virtualservers.yaml
4241
kubectl apply -f config/crd/bases/k8s.nginx.org_virtualserverroutes.yaml

content/nginx-one/k8s/add-nic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Upgrade or install NGINX Ingress Controller with the following command to config
6666
The `dataplaneKeySecretName` is used to authenticate the agent with NGINX One Console. See the [NGINX One Console Docs]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}})
6767
for instructions on how to generate your dataplane key from the NGINX One Console.
6868

69-
Follow the [Installation with Helm]({{< ref "/nic/installation/installing-nic/installation-with-helm.md" >}}) instructions to deploy NGINX Ingress Controller.
69+
Follow the [Installation with Helm]({{< ref "/nic/install/helm.md" >}}) instructions to deploy NGINX Ingress Controller.
7070

7171
{{%/tab%}}
7272
{{%tab name="Manifests"%}}
@@ -134,7 +134,7 @@ volumes:
134134
secretName: "<data_plane_key_secret_name>"
135135
```
136136

137-
Follow the [Installation with Manifests]({{< ref "/nic/installation/installing-nic/installation-with-manifests.md" >}}) instructions to deploy NGINX Ingress Controller.
137+
Follow the [Installation with Manifests]({{< ref "/nic/install/manifests.md" >}}) instructions to deploy NGINX Ingress Controller.
138138

139139
{{%/tab%}}
140140
{{</tabs>}}

content/nic/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ It supports standard [Ingress]({{< ref "/nic/glossary.md#ingress">}}) features s
3333
{{<card title="Migrate from Ingress-NGINX Controller" titleUrl="/nginx-ingress-controller/installation/ingress-nginx">}}
3434
Replace an Ingress-NGINX cluster with NGINX Ingress Controller
3535
{{</card>}}
36-
{{<card title="Releases" titleUrl="/nginx-ingress-controller/releases">}}
36+
{{<card title="Changelog" titleUrl="/nginx-ingress-controller/changelog">}}
3737
Review the changes from the latest NGINX Ingress Controller releases
3838
{{</card>}}
3939
{{</card-section>}}

content/nic/changelog/2019.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
title: "2019 archive"
3+
# Weights are assigned in increments of 100: determines sorting order
4+
weight: 600
5+
# Creates a table of contents and sidebar, useful for large documents
6+
toc: true
7+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
8+
nd-content-type: reference
9+
nd-product: NIC
10+
---
11+
12+
## 1.6.0
13+
14+
19 December 2019
15+
16+
### <i class="fa-solid fa-magnifying-glass"></i> Overview
17+
18+
Release 1.6.0 includes:
19+
20+
- Improvements to VirtualServer and VirtualServerRoute resources, adding support for richer load balancing behavior, more sophisticated request routing, redirects, direct responses, and blue-green and circuit breaker patterns. The VirtualServer and VirtualServerRoute resources are enabled by default and are ready for production use.
21+
- Support for OpenTracing, helping you to monitor and debug complex transactions.
22+
- An improved security posture, with support to run the Ingress Controller as a non-root user.
23+
24+
The release announcement blog post includes the overview for each feature. See <https://www.nginx.com/blog/announcing-nginx-ingress-controller-for-kubernetes-release-1-6-0/>
25+
26+
You will find the complete changelog for release 1.6.0, including bug fixes, improvements, and changes below.
27+
28+
FEATURES FOR VIRTUALSERVER AND VIRTUALSERVERROUTE RESOURCES:
29+
30+
- [780](https://github.com/nginx/kubernetes-ingress/pull/780): Add support for canned responses to VS/VSR.
31+
- [778](https://github.com/nginx/kubernetes-ingress/pull/778): Add redirect support in VS/VSR.
32+
- [766](https://github.com/nginx/kubernetes-ingress/pull/766): Add exact matches and regex support to location paths in VS/VSR.
33+
- [748](https://github.com/nginx/kubernetes-ingress/pull/748): Add TLS redirect support in Virtualserver.
34+
- [745](https://github.com/nginx/kubernetes-ingress/pull/745): Improve routing rules in VS/VSR
35+
- [728](https://github.com/nginx/kubernetes-ingress/pull/728): Add session persistence in VS/VSR.
36+
- [724](https://github.com/nginx/kubernetes-ingress/pull/724): Add VS/VSR Prometheus metrics.
37+
- [712](https://github.com/nginx/kubernetes-ingress/pull/712): Add service subselector support in vs/vsr.
38+
- [707](https://github.com/nginx/kubernetes-ingress/pull/707): Emit warning events in VS/VSR.
39+
- [701](https://github.com/nginx/kubernetes-ingress/pull/701): Add support queue in upstreams for plus in VS/VSR.
40+
- [693](https://github.com/nginx/kubernetes-ingress/pull/693): Add ServerStatusZones support in vs/vsr.
41+
- [670](https://github.com/nginx/kubernetes-ingress/pull/670): Add buffering support for vs/vsr.
42+
- [660](https://github.com/nginx/kubernetes-ingress/pull/660): Add ClientBodyMaxSize support in vs/vsr.
43+
- [659](https://github.com/nginx/kubernetes-ingress/pull/659): Support configuring upstream zone sizes in VS/VSR.
44+
- [655](https://github.com/nginx/kubernetes-ingress/pull/655): Add slow-start support in vs/vsr.
45+
- [653](https://github.com/nginx/kubernetes-ingress/pull/653): Add websockets support for vs/vsr upstreams.
46+
- [641](https://github.com/nginx/kubernetes-ingress/pull/641): Add support for ExternalName Services for vs/vsr.
47+
- [635](https://github.com/nginx/kubernetes-ingress/pull/635): Add HealthChecks support for vs/vsr.
48+
- [634](https://github.com/nginx/kubernetes-ingress/pull/634): Add Active Connections support to vs/vsr.
49+
- [628](https://github.com/nginx/kubernetes-ingress/pull/628): Add retries support for vs/vsr.
50+
- [621](https://github.com/nginx/kubernetes-ingress/pull/621): Add TLS support for vs/vsr upstreams.
51+
- [617](https://github.com/nginx/kubernetes-ingress/pull/617): Add keepalive support to vs/vsr.
52+
- [612](https://github.com/nginx/kubernetes-ingress/pull/612): Add timeouts support to vs/vsr.
53+
- [607](https://github.com/nginx/kubernetes-ingress/pull/607): Add fail-timeout and max-fails support to vs/vsr.
54+
- [596](https://github.com/nginx/kubernetes-ingress/pull/596): Add lb-method support in vs and vsr.
55+
56+
### <i class="fa-solid fa-rocket"></i> Features
57+
58+
- [750](https://github.com/nginx/kubernetes-ingress/pull/750): Add support for health status uri customisation.
59+
- [691](https://github.com/nginx/kubernetes-ingress/pull/691): Helper Functions for custom annotations.
60+
- [631](https://github.com/nginx/kubernetes-ingress/pull/631): Add max_conns support for NGINX plus.
61+
- [629](https://github.com/nginx/kubernetes-ingress/pull/629): Added upstream zone directive annotation. Thanks to [Victor Regalado](https://github.com/vrrs).
62+
- [616](https://github.com/nginx/kubernetes-ingress/pull/616): Add proxy-send-timeout to configmap key and annotation.
63+
- [615](https://github.com/nginx/kubernetes-ingress/pull/615): Add support for Opentracing.
64+
- [614](https://github.com/nginx/kubernetes-ingress/pull/614): Add max-conns annotation. Thanks to [Victor Regalado](https://github.com/vrrs).
65+
- [678](https://github.com/nginx/kubernetes-ingress/pull/678): Increase defaults for server-names-hash-max-size and servers-names-hash-bucket-size ConfigMap keys.
66+
- [694](https://github.com/nginx/kubernetes-ingress/pull/694): Reject VS/VSR resources with enabled plus features for OSS.
67+
- [799](https://github.com/nginx/kubernetes-ingress/pull/779): Enable CRDs by default. VirtualServer and VirtualServerRoute resources are now enabled by default.
68+
- [772](https://github.com/nginx/kubernetes-ingress/pull/772): Update VS/VSR version from v1alpha1 to v1. Make sure to update the `apiVersion` of your VirtualServer and VirtualServerRoute resources.
69+
- [748](https://github.com/nginx/kubernetes-ingress/pull/748): Add TLS redirect support in VirtualServer. The `redirect-to-https` and `ssl-redirect` ConfigMap keys no longer have any effect on generated configs for VirtualServer resources.
70+
- [745](https://github.com/nginx/kubernetes-ingress/pull/745): Improve routing rules. Update the spec of VirtualServer and VirtualServerRoute accordingly. See YAML examples of the changes [here](https://github.com/nginx/kubernetes-ingress/pull/745).
71+
- [710](https://github.com/nginx/kubernetes-ingress/pull/710): Run IC as non-root. Make sure to use the updated manifests to install/upgrade the Ingress Controller.
72+
- [603](https://github.com/nginx/kubernetes-ingress/pull/603): Update apiVersion in Deployments and DaemonSets to apps/v1.
73+
- Documentation improvements: [713](https://github.com/nginx/kubernetes-ingress/pull/713) thanks to [Matthew Wahner](https://github.com/mattwahner).
74+
75+
### <i class="fa-solid fa-bug-slash"></i> Fixes
76+
77+
- [788](https://github.com/nginx/kubernetes-ingress/pull/788): Fix VSR updates when namespace is set implicitly.
78+
- [736](https://github.com/nginx/kubernetes-ingress/pull/736): Init Ingress labeled metrics on start.
79+
- [686](https://github.com/nginx/kubernetes-ingress/pull/686): Check if config map created for leader-election.
80+
- [664](https://github.com/nginx/kubernetes-ingress/pull/664): Fix reporting events for Ingress minions.
81+
- [632](https://github.com/nginx/kubernetes-ingress/pull/632): Fix hsts support when not using SSL. Thanks to [Martín Fernández](https://github.com/bilby91).
82+
83+
### <i class="fa-solid fa-box"></i> Helm Chart
84+
85+
- Add new parameters to the Chart: `controller.healthCheckURI`, `controller.resources`, `controller.logLevel`, `controller.customPorts`, `controller.service.customPorts`. Added in [750](https://github.com/nginx/kubernetes-ingress/pull/750), [636](https://github.com/nginx/kubernetes-ingress/pull/636) thanks to [Guilherme Oki](https://github.com/guilhermeoki), [600](https://github.com/nginx/kubernetes-ingress/pull/600), [581](https://github.com/nginx/kubernetes-ingress/pull/581) thanks to [Alex Meijer](https://github.com/ameijer-corsha).
86+
- [722](https://github.com/nginx/kubernetes-ingress/pull/722): Fix trailing leader election cm when using helm. This change might lead to a failed upgrade. See the helm upgrade instruction below.
87+
- [573](https://github.com/nginx/kubernetes-ingress/pull/573): Use Controller name value for app selectors.
88+
89+
### <i class="fa-solid fa-upload"></i> Dependencies
90+
91+
- Update NGINX versions to 1.17.6.
92+
- Update NGINX Plus version to R20.
93+
94+
### <i class="fa-solid fa-download"></i> Upgrade
95+
96+
- For NGINX, use the 1.6.0 image from our DockerHub: `nginx/nginx-ingress:1.6.0` or `nginx/nginx-ingress:1.6.0-alpine`
97+
- For NGINX Plus, please build your own image using the 1.6.0 source code.
98+
- For Helm, use version 0.4.0 of the chart.
99+
100+
#### Helm upgrade
101+
102+
If leader election (the `controller.reportIngressStatus.enableLeaderElection` parameter) is enabled, when upgrading to the new version of the Helm chart:
103+
104+
1. Make sure to specify a new ConfigMap lock name (`controller.reportIngressStatus.leaderElectionLockName`) different from the one that was created by the current version. To find out the current name, check ConfigMap resources in the namespace where the Ingress Controller is running.
105+
1. After the upgrade, delete the old ConfigMap.
106+
107+
Otherwise, the helm upgrade will not succeed.
108+
109+
## Previous Releases
110+
111+
To see the previous releases, see the [Releases page](https://github.com/nginx/kubernetes-ingress/releases) on the Ingress Controller GitHub repo.

0 commit comments

Comments
 (0)