Getting unknown directive "root" when trying to add configuration to serve content from specific directory

[Velan987]

What happened:

I am trying to configure nginx to provide content from specific directory, i.e If i invoke root path (/) I need to show index.html. while configuring server-snippet for this I am getting below error.

Below is my ingress yaml file

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: my-ingress
  annotations:
    nginx.ingress.kubernetes.io/server-snippet: |
      location =/{
        alias /usr/share/nginx/html;
        try_files $uri $uri/ /index.html;
      }
spec:
  ingressClassName: nginx
  rules:
  - host: test.com 
    http:
      paths:
      - path: /test
        pathType: Prefix
        backend:
          service:
            name: test-svc
            port:
              number: 80

2024/03/11 06:56:57 [emerg] 955#955: unknown directive "root" in /tmp/nginx/nginx-cfg3003441674:276 nginx: [emerg] unknown directive "root" in /tmp/nginx/nginx-cfg3003441674:276 nginx: configuration file /tmp/nginx/nginx-cfg3003441674 test failed

What you expected to happen:

I am configuring below code in ingress resource:

annotations:
    nginx.ingress.kubernetes.io/server-snippet: |
      location =/{
        alias /usr/share/nginx/html;
        try_files $uri $uri/ /index.html;
      }

I have placed landing page files in /usr/share/nginx/html. When I hit root path I need to show index.html.

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

Kubernetes version (use kubectl version): v1.29.1

Environment:

• Cloud provider or hardware configuration:

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

• Kernel (e.g. uname -a): Linux 5.4.0-159-generic #176-Ubuntu SMP Mon Aug 14 12:04:20 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux

• Install tools: Cluster is initialized using kubeadm

  • Please mention how/where was the cluster created like kubeadm/kops/minikube/kind etc.

• Basic cluster related info:

  • kubectl version : v1.29.1
  • kubectl get nodes -o wide

• How was the ingress-nginx-controller installed:

  • If helm was used then please show output of helm ls -A | grep -i ingress
  • If helm was used then please show output of helm -n <ingresscontrollernamespace> get values <helmreleasename>
  • If helm was not used, then copy/paste the complete precise command used to install the controller, along with the flags and options used
  • if you have more than one instance of the ingress-nginx-controller installed in the same cluster, please provide details for all the instances
  • Ingress controller is installed using manifest file, below is my manifest file

    
    apiVersion: v1
    kind: Namespace
    metadata:
    labels:
    app.kubernetes.io/instance: ingress-nginx
    app.kubernetes.io/name: ingress-nginx
    name: ingress-nginx
    ---
    apiVersion: v1
    automountServiceAccountToken: true
    kind: ServiceAccount
    metadata:
    labels:
    app.kubernetes.io/component: controller
    app.kubernetes.io/instance: ingress-nginx
    app.kubernetes.io/name: ingress-nginx
    app.kubernetes.io/part-of: ingress-nginx
    app.kubernetes.io/version: 1.8.1
    name: ingress-nginx
    namespace: ingress-nginx
    ---
    apiVersion: v1
    kind: ServiceAccount
    metadata:
    labels:
    app.kubernetes.io/component: admission-webhook
    app.kubernetes.io/instance: ingress-nginx
    app.kubernetes.io/name: ingress-nginx
    app.kubernetes.io/part-of: ingress-nginx
    app.kubernetes.io/version: 1.8.1
    name: ingress-nginx-admission
    namespace: ingress-nginx
    ---
    apiVersion: rbac.authorization.k8s.io/v1
    kind: Role
    metadata:
    labels:
    app.kubernetes.io/component: controller
    app.kubernetes.io/instance: ingress-nginx
    app.kubernetes.io/name: ingress-nginx
    app.kubernetes.io/part-of: ingress-nginx
    app.kubernetes.io/version: 1.8.1
    name: ingress-nginx
    namespace: ingress-nginx
    rules:

• apiGroups:

  • "" resources:
  • namespaces verbs:
  • get

• apiGroups:

  • "" resources:
  • configmaps
  • pods
  • secrets
  • endpoints verbs:
  • get
  • list
  • watch

• apiGroups:

  • "" resources:
  • services verbs:
  • get
  • list
  • watch

• apiGroups:

  • networking.k8s.io resources:
  • ingresses verbs:
  • get
  • list
  • watch

• apiGroups:

  • networking.k8s.io resources:
  • ingresses/status verbs:
  • update

• apiGroups:

  • networking.k8s.io resources:
  • ingressclasses verbs:
  • get
  • list
  • watch

• apiGroups:

  • coordination.k8s.io resourceNames:
  • ingress-nginx-leader resources:
  • leases verbs:
  • get
  • update

• apiGroups:

  • coordination.k8s.io resources:
  • leases verbs:
  • create

• apiGroups:

  • "" resources:
  • events verbs:
  • create
  • patch

• apiGroups:

  • discovery.k8s.io resources:
  • endpointslices verbs:
  • list
  • watch

  • get

    apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission namespace: ingress-nginx rules:

• apiGroups:

  • "" resources:
  • secrets verbs:
  • get

  • create

    apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: labels: app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx rules:

• apiGroups:

  • "" resources:
  • configmaps
  • endpoints
  • nodes
  • pods
  • secrets
  • namespaces verbs:
  • list
  • watch

• apiGroups:

  • coordination.k8s.io resources:
  • leases verbs:
  • list
  • watch

• apiGroups:

  • "" resources:
  • nodes verbs:
  • get

• apiGroups:

  • "" resources:
  • services verbs:
  • get
  • list
  • watch

• apiGroups:

  • networking.k8s.io resources:
  • ingresses verbs:
  • get
  • list
  • watch

• apiGroups:

  • "" resources:
  • events verbs:
  • create
  • patch

• apiGroups:

  • networking.k8s.io resources:
  • ingresses/status verbs:
  • update

• apiGroups:

  • networking.k8s.io resources:
  • ingressclasses verbs:
  • get
  • list
  • watch

• apiGroups:

  • discovery.k8s.io resources:
  • endpointslices verbs:
  • list
  • watch

  • get

    apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission rules:

• apiGroups:

  • admissionregistration.k8s.io resources:
  • validatingwebhookconfigurations verbs:
  • get

  • update

    apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: labels: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx namespace: ingress-nginx roleRef: apiGroup: rbac.authorization.k8s.io kind: Role name: ingress-nginx subjects:

• kind: ServiceAccount name: ingress-nginx namespace: ingress-nginx

  apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission namespace: ingress-nginx roleRef: apiGroup: rbac.authorization.k8s.io kind: Role name: ingress-nginx-admission subjects:

• kind: ServiceAccount name: ingress-nginx-admission namespace: ingress-nginx

  apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: labels: app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole name: ingress-nginx subjects:

• kind: ServiceAccount name: ingress-nginx namespace: ingress-nginx

  apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole name: ingress-nginx-admission subjects:

• kind: ServiceAccount name: ingress-nginx-admission namespace: ingress-nginx

  apiVersion: v1 data: allow-snippet-annotations: "true" kind: ConfigMap metadata: labels: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-controller namespace: ingress-nginx

  apiVersion: v1 kind: Service metadata: labels: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-controller namespace: ingress-nginx spec: ipFamilies:

  • IPv4 ipFamilyPolicy: SingleStack ports:
  • appProtocol: http name: http port: 80 protocol: TCP targetPort: http
  • appProtocol: https name: https port: 443 protocol: TCP targetPort: https selector: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx type: LoadBalancer externalIPs:

  • XX.XX.XX.XX

    apiVersion: v1 kind: Service metadata: labels: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-controller-admission namespace: ingress-nginx spec: ports:

  • appProtocol: https name: https-webhook port: 443 targetPort: webhook selector: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx type: ClusterIP

    apiVersion: apps/v1 kind: Deployment metadata: labels: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-controller namespace: ingress-nginx spec: minReadySeconds: 0 revisionHistoryLimit: 10 selector: matchLabels: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx template: metadata: labels: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 spec: containers:

    • args:
    • /nginx-ingress-controller
    • --election-id=ingress-nginx-leader
    • --controller-class=k8s.io/ingress-nginx
    • --ingress-class=nginx
    • --configmap=$(POD_NAMESPACE)/ingress-nginx-controller
    • --validating-webhook=:8443
    • --validating-webhook-certificate=/usr/local/certificates/cert
    • --validating-webhook-key=/usr/local/certificates/key env:
    • name: POD_NAME valueFrom: fieldRef: fieldPath: metadata.name
    • name: POD_NAMESPACE valueFrom: fieldRef: fieldPath: metadata.namespace
    • name: LD_PRELOAD value: /usr/local/lib/libmimalloc.so image: registry.k8s.io/ingress-nginx/controller:v1.8.5@sha256:5831fa630e691c0c8c93ead1b57b37a6a8e5416d3d2364afeb8fe36fe0fef680 imagePullPolicy: IfNotPresent lifecycle: preStop: exec: command:
      • /wait-shutdown livenessProbe: failureThreshold: 5 httpGet: path: /healthz port: 10254 scheme: HTTP initialDelaySeconds: 10 periodSeconds: 10 successThreshold: 1 timeoutSeconds: 1 name: controller ports:
    • containerPort: 80 name: http protocol: TCP
    • containerPort: 443 name: https protocol: TCP
    • containerPort: 8443 name: webhook protocol: TCP readinessProbe: failureThreshold: 3 httpGet: path: /healthz port: 10254 scheme: HTTP initialDelaySeconds: 10 periodSeconds: 10 successThreshold: 1 timeoutSeconds: 1 resources: requests: cpu: 100m memory: 90Mi securityContext: allowPrivilegeEscalation: true capabilities: add:
      • NET_BIND_SERVICE drop:
      • ALL runAsUser: 101 volumeMounts:
    • mountPath: /usr/local/certificates/ name: webhook-cert readOnly: true dnsPolicy: ClusterFirst nodeSelector: kubernetes.io/os: linux serviceAccountName: ingress-nginx terminationGracePeriodSeconds: 300 volumes:

    • name: webhook-cert secret: secretName: ingress-nginx-admission

      apiVersion: batch/v1 kind: Job metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission-create namespace: ingress-nginx spec: template: metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission-create spec: containers:

    • args:
    • create
    • --host=ingress-nginx-controller-admission,ingress-nginx-controller-admission.$(POD_NAMESPACE).svc
    • --namespace=$(POD_NAMESPACE)
    • --secret-name=ingress-nginx-admission env:

    • name: POD_NAMESPACE valueFrom: fieldRef: fieldPath: metadata.namespace image: registry.k8s.io/ingress-nginx/kube-webhook-certgen:v20230407@sha256:543c40fd093964bc9ab509d3e791f9989963021f1e9e4c9c7b6700b02bfb227b imagePullPolicy: IfNotPresent name: create securityContext: allowPrivilegeEscalation: false nodeSelector: kubernetes.io/os: linux restartPolicy: OnFailure securityContext: fsGroup: 2000 runAsNonRoot: true runAsUser: 2000 serviceAccountName: ingress-nginx-admission

      apiVersion: batch/v1 kind: Job metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission-patch namespace: ingress-nginx spec: template: metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission-patch spec: containers:

    • args:
    • patch
    • --webhook-name=ingress-nginx-admission
    • --namespace=$(POD_NAMESPACE)
    • --patch-mutating=false
    • --secret-name=ingress-nginx-admission
    • --patch-failure-policy=Fail env:

    • name: POD_NAMESPACE valueFrom: fieldRef: fieldPath: metadata.namespace image: registry.k8s.io/ingress-nginx/kube-webhook-certgen:v20230407@sha256:543c40fd093964bc9ab509d3e791f9989963021f1e9e4c9c7b6700b02bfb227b imagePullPolicy: IfNotPresent name: patch securityContext: allowPrivilegeEscalation: false nodeSelector: kubernetes.io/os: linux restartPolicy: OnFailure securityContext: fsGroup: 2000 runAsNonRoot: true runAsUser: 2000 serviceAccountName: ingress-nginx-admission

      apiVersion: networking.k8s.io/v1 kind: IngressClass metadata: labels: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: nginx spec: controller: k8s.io/ingress-nginx

      apiVersion: admissionregistration.k8s.io/v1 kind: ValidatingWebhookConfiguration metadata: labels: app.kubernetes.io/component: admission-webhook app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx app.kubernetes.io/part-of: ingress-nginx app.kubernetes.io/version: 1.8.1 name: ingress-nginx-admission webhooks:

• admissionReviewVersions:

  • v1 clientConfig: service: name: ingress-nginx-controller-admission namespace: ingress-nginx path: /networking/v1/ingresses failurePolicy: Fail matchPolicy: Equivalent name: validate.nginx.ingress.kubernetes.io rules:
  • apiGroups:
  • networking.k8s.io apiVersions:
  • v1 operations:
  • CREATE
  • UPDATE resources:
  • ingresses sideEffects: None

• Current State of the controller:

  • kubectl describe ingressclasses
  • kubectl -n <ingresscontrollernamespace> get all -A -o wide
  • kubectl -n <ingresscontrollernamespace> describe po <ingresscontrollerpodname>
  • kubectl -n <ingresscontrollernamespace> describe svc <ingresscontrollerservicename>

NAME                                        READY   STATUS      RESTARTS   AGE
ingress-nginx-admission-create-gh86m        0/1     Completed   0          2d14h
ingress-nginx-admission-patch-2zwsg         0/1     Completed   0          2d14h
ingress-nginx-controller-847d74c887-dc4m7   1/1     Running     0          2d14h

• Current state of ingress object, if applicable:

  • kubectl -n <appnamespace> get all,ing -o wide
  • kubectl -n <appnamespace> describe ing <ingressname>
  • If applicable, then, your complete and exact curl/grpcurl command (redacted if required) and the reponse to the curl/grpcurl command with the -v flag

• Others:

  • Any other related information like ;
  • copy/paste of the snippet (if applicable)
  • kubectl describe ... of any custom configmap(s) created and in use
  • Any other related information that may help

I am configuring below code in ingress resource:

annotations:
    nginx.ingress.kubernetes.io/server-snippet: |
      location =/{
        alias /usr/share/nginx/html;
        try_files $uri $uri/ /index.html;
      }

I have placed landing page files in /usr/share/nginx/html. When I hit root path I need to show index.html.

How to reproduce this issue:

Anything else we need to know:

[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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

[longwuyuan]

/remove-kind bug

I don't understand anything about the environment or the use case or practical steps to reproduce the problem. There is no clear definition of the problem. Wait till someone can understand and triage the issue, so the problem description is more clear

/kind support /triage needs-information

[Velan987]

I am trying to configure nginx to provide content from specific directory, i.e If i invoke root path (/) I need to show index.html. while configuring server-snippet for this I am getting below error.

Below is my ingress yaml file

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: my-ingress
  annotations:
    nginx.ingress.kubernetes.io/server-snippet: |
      location =/{
        root /usr/share/nginx/html;
        try_files $uri $uri/ /index.html;
      }
spec:
  ingressClassName: nginx
  rules:
  - host: test.com 
    http:
      paths:
      - path: /test
        pathType: Prefix
        backend:
          service:
            name: test-svc
            port:
              number: 80

For this ingress I am getting below error Unknown directive "root" in /tmp/nginx/nginx-cfg3003441674:276 nginx: [emerg] unknown directive "root" in /tmp/nginx/nginx-cfg3003441674:276 nginx: configuration file /tmp/nginx/nginx-cfg3003441674 test failed.

I also went into nginx ingress controller pod, and added below snippet

 location =/{
        root /usr/share/nginx/html;
        try_files $uri $uri/ /index.html;
      }

Getting same error (Unknown directive "root") while reloadin nginx using "nginx -s reload"

[longwuyuan]

At the very least, you should look at the questions that are asked in the new bug report template.

You have not answered any of the questions asked in the new issue template so readers have to guess what the heck is going on here, to begin with.

And then you don't care to explain why you are talking about providing content from inside the controller. The controller has nothing to do providing your content from inside the controller pod

Once you have edited the issue description here and answered all the questions that are asked in a new bug report template, please write a detailed description of why you are trying to provide content from inside the ingress-controller pod. This project is a ingress controller so look at the documentation and write proper issue description that is related to some feature mentioned in the documentation https://kubernetes.github.io/ingress-nginx/

After that you can re-open the issue so that readers can make comments based on useful data posted here.

/close

[k8s-ci-robot]

@longwuyuan: Closing this issue.

In response to [this](https://github.com/kubernetes/ingress-nginx/issues/11086#issuecomment-1990988816): >At the very least, you should look at the questions that are asked in the new bug report template. > >You have not answered any of the questions asked in the new issue template so readers have to guess what the heck is going on here, to begin with. > >And then you don't care to explain why you are talking about providing content from inside the controller. The controller has nothing to do providing your content from inside the controller pod > >Once you have edited the issue description here and answered all the questions that are asked in a new bug report template, please write a detailed description of why you are trying to provide content from inside the ingress-controller pod. This project is a ingress controller so look at the documentation and write proper issue description that is related to some feature mentioned in the documentation https://kubernetes.github.io/ingress-nginx/ > >After that you can re-open the issue so that readers can make comments based on useful data posted here. > >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

[zengyuxing007]

please look at this : https://github.com/kubernetes/ingress-nginx/pull/8624