Skip to content
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

Release 1.5.1 #156

Merged
merged 1 commit into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# To re-generate a bundle for another specific version without changing the standard setup, you can:
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
VERSION ?= 1.5.0
VERSION ?= 1.5.1

# CHANNELS define the bundle channels used in the bundle.
# Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")
Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The following table shows the relation between the versions of the two projects:

| NGINX Ingress Controller | NGINX Ingress Operator |
| ------------------------ | ---------------------- |
| 3.2.x | 1.5.0 |
| 3.2.x | 1.5.1 |
| 3.1.x | 1.4.2 |
| 3.0.x | 1.3.1 |
| 2.4.x | 1.2.1 |
Expand All @@ -39,9 +39,9 @@ Note: The NGINX Ingress Operator works only for NGINX Ingress Controller version
2. Creating the default-server-secret.yaml is optional and it is recommended that users provide their own certificate. An example yaml for this can be found in the [examples folder](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/main/examples/default-server-secret.yaml)
3. (If using OpenShift) Create the scc resource on the cluster by applying the scc.yaml file found in the `resources` folder of this repo:

```shell
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/main/resources/scc.yaml
```
```shell
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/main/resources/scc.yaml
```

4. Deploy a new NGINX Ingress Controller using the [NginxIngress](./config/samples/charts_v1alpha1_nginxingress.yaml) Custom Resource:
- Use the name of the default server secret created above for `controller.defaultTLS.secret` field (needs to be in the form `namespace/name`)
Expand All @@ -68,7 +68,7 @@ See [upgrade docs](./docs/upgrades.md)

We publish NGINX Ingress Operator releases on GitHub. See our [releases page](https://github.com/nginxinc/nginx-ingress-helm-operator/releases).

The latest stable release is [1.5.0](https://github.com/nginxinc/nginx-ingress-helm-operator/releases/tag/v1.5.0). For production use, we recommend that you choose the latest stable release.
The latest stable release is [1.5.1](https://github.com/nginxinc/nginx-ingress-helm-operator/releases/tag/v1.5.1). For production use, we recommend that you choose the latest stable release.

## Development

Expand All @@ -78,9 +78,11 @@ It is possible to run the operator in your local machine. This is useful for tes

1. Have access to a Kubernetes/OpenShift cluster.
2. Apply the IC CRD:
```

```shell
make install
```

3. Run `make run`.

The operator will run in your local machine but will be communicating with the cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ metadata:
capabilities: Basic Install
categories: Monitoring, Networking
certified: "true"
containerImage: quay.io/nginx/nginx-ingress-operator:1.5.0
createdAt: "2023-06-30T10:10:35Z"
containerImage: quay.io/nginx/nginx-ingress-operator:1.5.1
createdAt: "2023-08-21T21:04:10Z"
description: The NGINX Ingress Operator is a Kubernetes/OpenShift component which
deploys and manages one or more NGINX/NGINX Plus Ingress Controllers
operatorframework.io/suggested-namespace: nginx-ingress
Expand All @@ -190,7 +190,7 @@ metadata:
operatorframework.io/arch.arm64: supported
operatorframework.io/arch.ppc64le: supported
operatorframework.io/arch.s390x: supported
name: nginx-ingress-operator.v1.5.0
name: nginx-ingress-operator.v1.5.1
namespace: placeholder
spec:
apiservicedefinitions: {}
Expand Down Expand Up @@ -394,7 +394,7 @@ spec:
- --metrics-bind-address=127.0.0.1:8080
- --leader-elect
- --leader-election-id=nginx-ingress-operator
image: quay.io/nginx/nginx-ingress-operator:1.5.0
image: quay.io/nginx/nginx-ingress-operator:1.5.1
livenessProbe:
httpGet:
path: /healthz
Expand Down Expand Up @@ -485,4 +485,4 @@ spec:
minKubeVersion: 1.22.0
provider:
name: NGINX Inc
version: 1.5.0
version: 1.5.1
2 changes: 1 addition & 1 deletion config/manager/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ kind: Kustomization
images:
- name: controller
newName: quay.io/nginx/nginx-ingress-operator
newTag: 1.5.0
newTag: 1.5.1
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ metadata:
capabilities: Basic Install
categories: Monitoring, Networking
certified: "true"
containerImage: quay.io/nginx/nginx-ingress-operator:1.5.0
containerImage: quay.io/nginx/nginx-ingress-operator:1.5.1
createdAt: placeholder
description: The NGINX Ingress Operator is a Kubernetes/OpenShift component which
deploys and manages one or more NGINX/NGINX Plus Ingress Controllers
Expand Down Expand Up @@ -345,7 +345,7 @@ spec:
- --metrics-bind-address=127.0.0.1:8080
- --leader-elect
- --leader-election-id=nginx-ingress-operator
image: quay.io/nginx/nginx-ingress-operator:1.5.0
image: quay.io/nginx/nginx-ingress-operator:1.5.1
livenessProbe:
httpGet:
path: /healthz
Expand Down Expand Up @@ -451,4 +451,4 @@ spec:
minKubeVersion: 1.22.0
provider:
name: NGINX Inc
version: 1.5.0
version: 1.5.1
18 changes: 9 additions & 9 deletions docs/manual-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,26 @@ This will deploy the operator in the `nginx-ingress-operator-system` namespace.

1. Clone the `nginx-ingress-operator` repo:

```
git clone https://github.com/nginxinc/nginx-ingress-helm-operator/ --branch v1.5.0
```shell
git clone https://github.com/nginxinc/nginx-ingress-helm-operator/ --branch v1.5.1
cd nginx-ingress-helm-operator/
```

2. `OpenShift` To deploy the Operator and associated resources to an OpenShift environment, run:

```
make deploy IMG=nginx/nginx-ingress-operator:1.5.0
```shell
make deploy IMG=nginx/nginx-ingress-operator:1.5.1
```

3. Alternatively, to deploy the Operator and associated resources to all other environments:

```
make deploy IMG=nginx/nginx-ingress-operator:1.5.0
```shell
make deploy IMG=nginx/nginx-ingress-operator:1.5.1
```

2. Check that the Operator is running:

```
```shell
kubectl get deployments -n nginx-ingress-operator-system

NAME READY UP-TO-DATE AVAILABLE AGE
Expand All @@ -36,10 +36,10 @@ This will deploy the operator in the `nginx-ingress-operator-system` namespace.

In order to deploy NGINX Ingress Controller instances into OpenShift environments, a new SCC is required to be created on the cluster which will be used to bind the specific required capabilities to the NGINX Ingress service account(s). To do so for NIC deployments, please run the following command (assuming you are logged in with administrator access to the cluster):

`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.5.0/resources/scc.yaml`
`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.5.1/resources/scc.yaml`

Alternatively, to create an SCC for NIC daemonsets, please run this command:

`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.5.0/resources/scc-daemonset.yaml`
`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.5.1/resources/scc-daemonset.yaml`

You can now deploy the NGINX Ingress Controller instances.
4 changes: 2 additions & 2 deletions docs/openshift-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Additional steps:

In order to deploy NGINX Ingress Controller instances into OpenShift environments, a new SCC is required to be created on the cluster which will be used to bind the specific required capabilities to the NGINX Ingress service account(s). To do so for NIC deployments, please run the following command (assuming you are logged in with administrator access to the cluster):

`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.5.0/resources/scc.yaml`
`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.5.1/resources/scc.yaml`

Alternatively, to create an SCC for NIC daemonsets, please run this command:

`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.5.0/resources/scc-daemonset.yaml`
`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.5.1/resources/scc-daemonset.yaml`

You can now deploy the NGINX Ingress Controller instances.
10 changes: 6 additions & 4 deletions docs/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Release 1.0.0 includes a backward incompatible change from version 0.5.1 as we h
## OLM upgrade - 0.5.1 to 1.0.0

**Note: The `nginx-ingress-operator` supports `Basic Install` only - we do not support auto-updates. When you are installing the Operator using the OLM, the auto-update feature should be disabled to avoid breaking changes being auto-applied. In OpenShift, this can be done by setting the `Approval Strategy` to `Manual`. Please see the [Operator SDK docs](https://sdk.operatorframework.io/docs/advanced-topics/operator-capabilities/operator-capabilities/) for more details on the Operator Capability Levels.**

1. Upgrade CRDs
2. Uninstall Go operator -> this will also remove any instances of the NginxIngressController, but not any dependent objects (ingresses, VSs, etc)
3. Remove the nginx-ingress ingressClass `k delete ingressclass/nginx`
Expand All @@ -15,7 +16,7 @@ Release 1.0.0 includes a backward incompatible change from version 0.5.1 as we h

### 0. Upgrade the existing NIC crds

Navigate [here](../helm-charts/nginx-ingress/) and run ` kubectl apply -f crds/`
Navigate [here](../helm-charts/nginx-ingress/) and run `kubectl apply -f crds/`

### 1. Uninstall the existing 0.5.1 operator, the nginx ingress controller CRD, and the ingressClass

Expand Down Expand Up @@ -43,16 +44,17 @@ Deploy the operator following the steps outlined in [manual installation doc](./

Uninstall the existing operator deployment:

1. Checkout the previous version of the nginx-ingress-operator [0.5.1](https://github.com/nginxinc/nginx-ingress-helm-operator/releases/tag/v0.5.0).
1. Checkout the previous version of the nginx-ingress-operator [0.5.1](https://github.com/nginxinc/nginx-ingress-helm-operator/releases/tag/v0.5.1).
2. Uninstall the resources by running the following command:
```

```shell
make undeploy
```

### 3. Install the latest version of the operator

Install the latest version of the Operator following the steps outlined in [manual installation doc](./manual-installation.md).

### 3. Deploy new ingress controller deployments
### 4. Deploy new ingress controller deployments

Use the new Nginx Ingress Operator installation to deploy Nginx Ingress Controller - see the release notes [here](https://docs.nginx.com/nginx-ingress-controller/releases/#nginx-ingress-controller-2-2-0) and a guide to the Helm configuration parameters [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#configuration)