PR feedback

Author: Dean-Coakley

CHANGELOG.md

@@ -4,32 +4,24 @@
 
 Features
 
-* Add IngressLink support (#58) @Dean-Coakley
-* Add AppProtect User Defined Signatures support (#55) @Dean-Coakley
-* Graduate Policies. Add enablePreviewPolicy flag support. (#56) @Dean-Coakley
-* Update secret type of default secret to TLS (#39) @pleshakov
+* [58](https://github.com/nginxinc/nginx-ingress-operator/pull/58) Add IngressLink support.
+* [56](https://github.com/nginxinc/nginx-ingress-operator/pull/56) Graduate Policies. Add enablePreviewPolicy flag support.
+* [55](https://github.com/nginxinc/nginx-ingress-operator/pull/55) Add AppProtect User Defined Signatures support.
+* [39](https://github.com/nginxinc/nginx-ingress-operator/pull/39) Update secret type of default secret to TLS.
 
 Bug Fixes
 
-* Fix replicas and service to be optional fields (#71) @Dean-Coakley
-* Make enableCRDs optional (#70) @Dean-Coakley
-* Fix Service to be an optional field. Add support for updating ExtraLabels. (#66) @Dean-Coakley
-* Fix SCC resource to only affect KIC pods (#65) @Dean-Coakley
+* [71](https://github.com/nginxinc/nginx-ingress-operator/pull/71) Fix replicas and service to be optional fields.
+* [70](https://github.com/nginxinc/nginx-ingress-operator/pull/70) Make enableCRDs optional.
+* [66](https://github.com/nginxinc/nginx-ingress-operator/pull/66) Fix Service to be an optional field. Add support for updating ExtraLabels.
+* [65](https://github.com/nginxinc/nginx-ingress-operator/pull/65) Fix SCC resource to only affect KIC pods.
 
 Documentation
 
-* Update IC compatibility in changelog (#54) @pleshakov
+* [54](https://github.com/nginxinc/nginx-ingress-operator/pull/54) Update IC compatibility in changelog.
 
-Maintenance
-
-* Bump golangci/golangci-lint-action from v2.4.0 to v2.5.1 (#67) @dependabot
-* Add release-drafter (#64) @lucacome
-* Change dependabot interval to weekly (#63) @lucacome
-* Bump actions/cache from v2 to v2.1.4 (#53) @dependabot
-* Bump golangci/golangci-lint-action from v2 to v2.4.0 (#59) @dependabot
-* Bump github.com/google/go-cmp from 0.4.0 to 0.5.4 (#49) @dependabot
-* Add dependabot (#45) @lucacome
-* Update CRDs, CSVs and Makefile (#36) @lucacome
+KNOWN ISSUES:
+* The Operator doesn't automatically remove IngressClasses created by [29](https://github.com/nginxinc/nginx-ingress-operator/pull/29).
 
 Compatibility
 
@@ -38,11 +30,14 @@ Compatibility
 
 Upgrade Instructions
 
-1. Remove existing policy CRD: `kubectl delete crds policies.k8s.nginx.org`
+1. Remove the existing Policy CRD: `kubectl delete crd policies.k8s.nginx.org`
   **Please note that deletion of the policies.k8s.nginx.org CRD will result in all instances of that CRD being deleted too. Ensure to back up any important Custom Resource instances first!**
-2. Delete existing SCC: `kubectl delete scc nginx-ingress-scc`
-3. Deploy new operator.
-4. Update any existing instances of the nginxingresscontrollers.k8s.nginx.org Custom Resource to use a KIC 1.10 image.
+2. Delete the existing SCC: `kubectl delete scc nginx-ingress-scc`
+3. Upgrade the operator to version 0.1.0.
+4. Update any existing instances of the nginxingresscontrollers.k8s.nginx.org Custom Resource to use an NGINX Ingress Controller 1.10.x image.
+
+Updating the secrets in KIC:
+Version 1.10.0 of the Ingress Controller added a requirement for secrets to be one of the following types: kubernetes.io/tls for TLS secrets; nginx.org/jwk for JWK secrets; or nginx.org/ca for CA secrets. The Ingress Controller now ignores secrets that are not one of these supported types. Before upgrading, please ensure that the secrets referenced in Ingress, VirtualServer or Policies resources are of a supported type, which is configured via the type field. Please see https://docs.nginx.com/nginx-ingress-controller/releases/#nginx-ingress-controller-1-10-0 for more details.
 
 ### 0.0.7
 

README.md

@@ -12,11 +12,11 @@ The following table shows the relation between the versions of the two projects:
 
 | NGINX Ingress Controller | NGINX Ingress Operator |
 | --- | --- |
-| < 1.7.0 | N/A |
-| 1.7.x | 0.0.4 |
-| 1.8.x | 0.0.6 |
-| 1.9.x | 0.0.7 |
 | 1.10.x | 0.1.0 |
+| 1.9.x | 0.0.7 |
+| 1.8.x | 0.0.6 |
+| 1.7.x | 0.0.4 |
+| < 1.7.0 | N/A |
 
 Note: The NGINX Ingress Operator works only for NGINX Ingress Controller versions after `1.7.0`.