How to load a custom module to an ingress-nginx deployment?

[varkey98]

We have a custom module that we deploy to our nginx deployments? How can we load the same module to ingress-nginx deployments? We we using a custom lua plugin in place of it till now, but looks like that support got stopped and now we would like to load the ingress-nginx deployment with our custom nginx module

[k8s-ci-robot]

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[varkey98]

I tried using main-snippets directive in the config map, but did not work for me

[longwuyuan]

We don't support loading custom modules because of difficulty in supporting and securing the controller with custom modules. You can look up older issues where others have tried and/or succeeded.

[Gacko]

You can define an image which is being used as init container here:

https://github.com/kubernetes/ingress-nginx/blob/main/charts/ingress-nginx/values.yaml#L712

This image needs to contain the script described in the footer of the value. This script is then being executed on startup. You can also use distroless images, the binary executed changes to /init_module then.

https://github.com/kubernetes/ingress-nginx/blob/main/charts/ingress-nginx/templates/_helpers.tpl#L247

[varkey98]

@Gacko does this document(https://docs.nginx.com/nginx-ingress-controller/tutorials/nginx-dynamic-module/) not work anymore? I mounted my module to the pod and edited the config map, but still not seeing the module being there in the nginx.conf file

[longwuyuan]

this is the K8S community controller project. That link is from the commercial product from NGINX INC

[varkey98]

Ah sorry for being naive here. Thanks for all the help :)

[varkey98]

I've been going though the helm charts, one thing I dont understand is how the nginx.conf gets modified with the new dynamic module's load_module directive when I specify an extraModule? Not very familiar with k8s or nginx, apologies if I missed something

[NgoHuy]

I've been going though the helm charts, one thing I dont understand is how the nginx.conf gets modified with the new dynamic module's load_module directive when I specify an extraModule? Not very familiar with k8s or nginx, apologies if I missed something

we may need to add this line to /etc/nginx/nginx.conf. Try if it works

[varkey98]

I was able to update the nginx conf to load the new dynamic module using config map itself. This was the key to use:

ingress-nginx/docs/user-guide/nginx-configuration/configmap.md

Line 170 in 6a889f4

| [main-snippet](#main-snippet) | string | "" | |

[NgoHuy]

oh greate, previous comment made me think it's impossibile, I use server-snippet to include new config and config map to load custom template, your comment is very helpful