Skip to content

Commit

Permalink
OPSEXP-3005 Document using specific version of ingress-nginx to avoid…
Browse files Browse the repository at this point in the history
… breakage (#1278)
  • Loading branch information
pmacius authored Jan 22, 2025
1 parent 66cad31 commit 105d8f6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 24 deletions.
15 changes: 4 additions & 11 deletions docs/helm/ingress-nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,12 @@ Install the ingress-nginx controller namespace:
```bash
helm upgrade --install ingress-nginx ingress-nginx \
--repo https://kubernetes.github.io/ingress-nginx \
--namespace ingress-nginx --create-namespace
--namespace ingress-nginx --create-namespace \
--version 4.7.2 \
--set controller.allowSnippetAnnotations=true
```

Enable snippet annotations which is disabled by default for security reasons, but
we still requires it for `alfresco-search-services` while still filtering only
the ones we strictly need.

```bash
kubectl -n ingress-nginx patch cm ingress-nginx-controller \
-p '{"data": {"allow-snippet-annotations":"true"}}'
```

Wait for the ingress-nginx controller to be up again after the configuration change:
Wait for the ingress-nginx controller:

```sh
kubectl wait --namespace ingress-nginx \
Expand Down
21 changes: 8 additions & 13 deletions docs/helm/kind-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,26 +54,21 @@ EOF

Wait for the Kind cluster to be created. This may take a few minutes.

## Step 3: Install patched ingress-nginx
## Step 3: Install ingress-nginx

Follow the instructions for
[deploying nginx ingress on KinD](https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx).
Install the ingress-nginx controller namespace:

Reconfigure ingress-nginx to allow snippet annotations that are still required
when using our search services chart:

```sh
kubectl -n ingress-nginx patch cm ingress-nginx-controller \
-p '{"data": {"allow-snippet-annotations":"true"}}'
```bash
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.8.2/deploy/static/provider/kind/deploy.yaml
```

Wait for the ingress-nginx controller to be up again after the configuration change:
Wait for the ingress-nginx controller:

```sh
kubectl wait --namespace ingress-nginx \
--for=condition=ready pod \
--selector=app.kubernetes.io/component=controller \
--timeout=90s
--for=condition=ready pod \
--selector=app.kubernetes.io/component=controller \
--timeout=90s
```

## Install metrics server
Expand Down

0 comments on commit 105d8f6

Please sign in to comment.