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

GeoIP2 docs mention incorrect folder for mounted volumes #11147

Closed
dVerhees opened this issue Mar 21, 2024 · 1 comment · Fixed by #11150
Closed

GeoIP2 docs mention incorrect folder for mounted volumes #11147

dVerhees opened this issue Mar 21, 2024 · 1 comment · Fixed by #11150
Labels
area/docs kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@dVerhees
Copy link
Contributor

What happened:

I tried to mount the geopip2 databases using a volume mount, using the paths in the official docs. After searching the github issues and the code I noticed the path used has changed:
from /etc/nginx/geoip/ to /etc/ingress-controller/geoip/

specifically in this pr: #10470

This is not reflected in the docs:
https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#use-geoip2

This line:

Alternatively, it is possible to use a volume to mount the files `/etc/nginx/geoip/GeoLite2-City.mmdb` and `/etc/nginx/geoip/GeoLite2-ASN.mmdb`, avoiding the overhead of the download.

What you expected to happen:

GeoIP2 files to be mounted, and controller to start with GeoIP2 enabled.

NGINX Ingress controller version (exec into the pod and run nginx-ingress-controller --version.):


NGINX Ingress controller
Release: v1.10.0
Build: 71f78d4
Repository: https://github.com/kubernetes/ingress-nginx
nginx version: nginx/1.25.3


Kubernetes version (use kubectl version):
Client Version: v1.29.2
Server Version: v1.28.5

Environment:

  • Cloud provider or hardware configuration: AKS

  • OS (e.g. from /etc/os-release): Ubuntu 22.04

  • Kernel (e.g. uname -a): 5.15.0-1057-azure

  • Install tools:

    • azure cli
  • Basic cluster related info: Not Relevant, documentation issue

  • How was the ingress-nginx-controller installed: Helm

  • Current State of the controller: running

  • Current state of ingress object, if applicable: N/A

  • Others: N/A

How to reproduce this issue:

  • Create a volume containing the GeoIP2 databases required.
  • set the volume mounts for the volume with the databases and set the path to /etc/nginx/geoip/ as listed in the docs
  • do not set the maxmind key
  • Enable GeoIP2 in the helm chart and deploy it
  • GeoIP2 will not be loaded, because it's missing the files.

Anything else we need to know: No, setting the correct path works, so it's just a documentation issue

/kind documentation
/remove-kind bug

@dVerhees dVerhees added the kind/bug Categorizes issue or PR as related to a bug. label Mar 21, 2024
@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority and removed kind/bug Categorizes issue or PR as related to a bug. labels Mar 21, 2024
@longwuyuan
Copy link
Contributor

/triage accepted
/area docs
/priority important-longterm

Seems what you are saying is true. Can you submit a docs PR

cc @rikatz , please confirm, when you get a chance

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. area/docs priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority labels Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Development

Successfully merging a pull request may close this issue.

3 participants