github.com/verrazzano/verrazzano@v1.7.0/platform-operator/thirdparty/charts/ingress-nginx/templates/NOTES.txt (about)

     1  The ingress-nginx controller has been installed.
     2  
     3  {{- if contains "NodePort" .Values.controller.service.type }}
     4  Get the application URL by running these commands:
     5  
     6  {{- if (not (empty .Values.controller.service.nodePorts.http)) }}
     7    export HTTP_NODE_PORT={{ .Values.controller.service.nodePorts.http }}
     8  {{- else }}
     9    export HTTP_NODE_PORT=$(kubectl --namespace {{ .Release.Namespace }} get services -o jsonpath="{.spec.ports[0].nodePort}" {{ include "ingress-nginx.controller.fullname" . }})
    10  {{- end }}
    11  {{- if (not (empty .Values.controller.service.nodePorts.https)) }}
    12    export HTTPS_NODE_PORT={{ .Values.controller.service.nodePorts.https }}
    13  {{- else }}
    14    export HTTPS_NODE_PORT=$(kubectl --namespace {{ .Release.Namespace }} get services -o jsonpath="{.spec.ports[1].nodePort}" {{ include "ingress-nginx.controller.fullname" . }})
    15  {{- end }}
    16    export NODE_IP=$(kubectl --namespace {{ .Release.Namespace }} get nodes -o jsonpath="{.items[0].status.addresses[1].address}")
    17  
    18    echo "Visit http://$NODE_IP:$HTTP_NODE_PORT to access your application via HTTP."
    19    echo "Visit https://$NODE_IP:$HTTPS_NODE_PORT to access your application via HTTPS."
    20  {{- else if contains "LoadBalancer" .Values.controller.service.type }}
    21  It may take a few minutes for the LoadBalancer IP to be available.
    22  You can watch the status by running 'kubectl --namespace {{ .Release.Namespace }} get services -o wide -w {{ include "ingress-nginx.controller.fullname" . }}'
    23  {{- else if contains "ClusterIP"  .Values.controller.service.type }}
    24  Get the application URL by running these commands:
    25    export POD_NAME=$(kubectl --namespace {{ .Release.Namespace }} get pods -o jsonpath="{.items[0].metadata.name}" -l "app={{ template "ingress-nginx.name" . }},component={{ .Values.controller.name }},release={{ .Release.Name }}")
    26    kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80
    27    echo "Visit http://127.0.0.1:8080 to access your application."
    28  {{- end }}
    29  
    30  An example Ingress that makes use of the controller:
    31  
    32  {{- $isV1 := semverCompare ">=1" .Chart.AppVersion}}
    33    apiVersion: networking.k8s.io/v1
    34    kind: Ingress
    35    metadata:
    36      name: example
    37      namespace: foo
    38      {{- if eq $isV1 false }}
    39      annotations:
    40        kubernetes.io/ingress.class: {{ .Values.controller.ingressClass }}
    41      {{- end }}
    42    spec:
    43      {{- if $isV1 }}
    44      ingressClassName: {{ .Values.controller.ingressClassResource.name }}
    45      {{- end }}
    46      rules:
    47        - host: www.example.com
    48          http:
    49            paths:
    50              - pathType: Prefix
    51                backend:
    52                  service:
    53                    name: exampleService
    54                    port:
    55                      number: 80
    56                path: /
    57      # This section is only required if TLS is to be enabled for the Ingress
    58      tls:
    59        - hosts:
    60          - www.example.com
    61          secretName: example-tls
    62  
    63  If TLS is enabled for the Ingress, a Secret containing the certificate and key must also be provided:
    64  
    65    apiVersion: v1
    66    kind: Secret
    67    metadata:
    68      name: example-tls
    69      namespace: foo
    70    data:
    71      tls.crt: <base64 encoded cert>
    72      tls.key: <base64 encoded key>
    73    type: kubernetes.io/tls