Ingress Configuration

If you've tested Pomerium using the all-in-one binary, you're probably familiar with configuring routes in Pomerium's config.yaml. When using the Pomerium Ingress Controller, each route is defined as an Ingress resource in the Kubernetes API.

Ingress

The Pomerium Ingress Controller will monitor Ingress resources in the cluster.

By default, Ingress resources in all namespaces are watched.
Only resources with a matching spec.ingressClassName would be served.
TLS (HTTPS) is required.

Example Ingress

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    cert-manager.io/cluster-issuer: google-dns
    external-dns.alpha.kubernetes.io/hostname: httpbin.localhost.pomerium.io
    ingress.pomerium.io/allow_any_authenticated_user: 'true'
    ingress.pomerium.io/pass_identity_headers: 'true'
  name: httpbin
  namespace: httpbin
spec:
  ingressClassName: pomerium
  rules:
    - host: httpbin.localhost.pomerium.io
      http:
        paths:
          - backend:
              service:
                name: httpbin
                port:
                  name: http
            path: /
            pathType: Prefix
  tls:
    - hosts:
        - httpbin.ingress.localhost.pomerium.io
      secretName: httpbin-localhost-pomerium-io

Ingress Class

The default installation adds pomerium IngressClass to your cluster. In order for Pomerium to service your Ingress objects, please set spec.ingressClassName to pomerium.

It is also possible to set Pomerium to be a default ingress controller cluster-wide.

Annotations

Most configuration keys in non-Kubernetes deployments can be specified as annotation in an Ingress Resource definition. The format is ingress.pomerium.io/${OPTION_NAME}.

note

Kubernetes object annotations are a string map and Ingress annotation value has to be a YAML string in quotemarks. Pomerium would parse the value of the annotation string to decode the desired format.

Representing JSON objects

Some parameters are objects. Use single quotemarks to escape their string representation.

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    ingress.pomerium.io/policy: '[{"allow":{"and":[{"email":{"is":"user@yourdomain.com"}}]}}]'

Longer single-line JSON strings may be hard to read. You may opt using multi-line YAML strings instead:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: name
  annotations:
    ingress.pomerium.io/policy: |
      - allow:
          or:
            - domain:
                is: pomerium.com

The expandable list below contains the annotations available, which behave as described in our reference documentation (with links to the appropriate reference documentation).

Pomerium-Standard Annotations

The remaining annotations are specific to or behave differently than they do when using Pomerium without the Ingress Controller:

Annotation	Description
`ingress.pomerium.io/kubernetes_service_account_token_secret`	Name of a Kubernetes Secret containing a Kubernetes Service Account Token in a `token` key.
`ingress.pomerium.io/path_regex`	When set to `"true"` enables path regex matching. See the Regular Expressions Path Matching section for more information.
`ingress.pomerium.io/secure_upstream`	When set to `"true"`, use `https` when connecting to the upstream endpoint.
`ingress.pomerium.io/set_request_headers_secret`	Name of Kubernetes Secret containing the contents of the request header to send upstream. When used, `ingress.pomerium.io/set_request_headers` should not contain overlapping keys.
`ingress.pomerium.io/set_response_headers_secret`	Name of Kubernetes Secret containing the contents of the response header to send downstream. When used, `ingress.pomerium.io/set_response_headers` should not contain overlapping keys.
`ingress.pomerium.io/service_proxy_upstream`	When set to `"true"` forces Pomerium to connect to upstreams through the k8s service proxy, and not individual endpoints. This is useful when deploying Pomerium inside a service mesh.
`ingress.pomerium.io/tcp_upstream`	When set to `"true"`, defines the route as supporting a TCP tunnel. See the example below for more information.
`ingress.pomerium.io/tls_client_secret`	Name of Kubernetes `tls` Secret containing a client certificate for connecting to the upstream.
`ingress.pomerium.io/tls_custom_ca_secret`	Name of Kubernetes `tls` Secret containing a custom CA certificate for the upstream.
`ingress.pomerium.io/tls_downstream_client_ca_secret`	Name of Kubernetes `tls` Secret containing a Client CA for validating downstream clients.

Access Policy

The access policy is applied by adding Pomerium-specific annotations to the Ingress objects.

Annotation
`ingress.pomerium.io/allow_any_authenticated_user: 'true'` Boolean. Allow access to any user that was successfully authenticated with your Identity Provider.
`ingress.pomerium.io/allow_public_unauthenticated_access: 'true'` Boolean. Do not require any authentication, public access.
`ingress.pomerium.io/allowed_domains: \| - pomerium.com` Array of strings. Users with email domains matched would be allowed.
`ingress.pomerium.io/allowed_users: \| - alice@pomerium.com - bob@contractor.co` Array of strings. Users with matched emails would be allowed.
`ingress.pomerium.io/allowed_idp_claims: \| groups: - admin` Object. Users with matched claims passed by your Identity Provider would be allowed.
`ingress.pomerium.io/policy: \| allow: and: - domain: is: example.com - claim/groups: admin` Pomerium Policy Language.

Deterministic Matching

If you have Ingresses with potentially overlapping host/path combinations, Pomerium maintains the following order that would match an incoming request:

Ascending by host.
Descending by path.
Descending by regex.
Descending by prefix.

This sorting order helps ensure that more restrictive routes for specific paths and regexes are applied correctly.

Regular Expressions Path Matching

You can use a re2 regular expression to create an Ingress that matches multiple paths.

Set the path_regex annotation to "true"
Set pathType to ImplementationSpecific
Set path to an re2 expression matching the full path. It must include the ^/ prefix and $ suffix. Any query strings should be removed.

tip

Check out this example expression at regex101.com for a more detailed explanation and example paths, both matching and not.

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    cert-manager.io/issuer: example-issuer
    ingress.pomerium.io/allowed_domains: '["exampledomain.com"]'
    ingress.pomerium.io/path_regex: 'true'
  name: example
spec:
  ingressClassName: pomerium
  rules:
    - host: example.localhost.pomerium.io
      http:
        paths:
          - backend:
              service:
                name: example
                port:
                  name: http
            path: ^/(admin|superuser)/.*$
            pathType: ImplementationSpecific
  tls:
    - hosts:
        - example.localhost.pomerium.io
      secretName: example-tls

Unsupported features

The following Ingress features are not supported:

Services

Each Ingress should be backed by a Service. Pomerium supports certain extensions while communicating to Kubernetes services, beyond plaintext HTTP interaction via Service Load Balancer.

TCP Services

Pomerium is capable of creating secure connections to services like SSH, Databases, and more by creating a TCP tunnel to the service with a local client.

The example route below defines a route providing a tunneled TCP connection to an upstream service listening for non-web traffic. Pomerium provides command line and GUI clients to interact with the TCP services.

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: tcp-example
  annotations:
    ingress.pomerium.io/tcp_upstream: 'true'
spec:
  ingressClassName: pomerium
  rules:
    - host: 'tcp.localhost.pomerium.io'
      http:
        paths:
          - pathType: ImplementationSpecific
            backend:
              service:
                name: tcp-service
                port:
                  name: app

The important points to note in this example:

The annotation ingress.pomerium.io/tcp_upstream: is set to "true",
spec.rules.[].http.paths.[].path is omitted,
spec.rules.[].http.paths.[].pathType is set to ImplementationSpecific,
spec.rules.[].host and spec.rules.[].paths.[].backend.service.port.name/number together define the address used when connecting to the route using the Pomerium Desktop or CLI clients,
You may apply standard access control annotations to define access restrictions to the service.

note

Unlike a standalone Pomerium configuration, you may not create multiple TCP routes using the same hostname with different ports. This limitation was made to avoid confusion, and because additional configuration parameters, such as the Ingress resource, do not allow passing port numbers in the spec.rules.host parameter.

Service Proxy

For performance reasons, by default, Pomerium routes traffic directly to the referenced Service's Endpoints, bypassing Kubernetes service proxy. If you would like to disable this behaviour, i.e. you are deploying Pomerium inside a service mesh such as Istio, set the following annotation to the Ingress:

ingress.pomerium.io/service_proxy_upstream: 'true'

Load Balancing

Unless you disabled direct traffic to Endpoints, Pomerium would load balance the requests to the upstream endpoints. See the Load Balancing guide for details, and use relevant Ingress annotations to fine tune load balancing and health checks.

note

Kubernetes has its own concept of readiness for the endpoints. If a pod fails Readiness probe, its Endpoint is removed. Pomerium would detect this change and stop serving traffic to that upstream endpoint. You may use both Pomerium and Kubernetes health checks together.

Mutual TLS

The Ingress spec assumes that all communications to the upstream service is sent in plaintext. Pomerium supports mutual TLS communication with upstream endpoints.

Annotate your Ingress with

ingress.pomerium.io/secure_upstream: 'true'

Additional TLS certificates may be supplied by creating a Kubernetes secret(s) in the same namespaces as the Ingress resource. Please note that we do not support file paths or embedded secret references.

Please note that the referenced tls_client_secret must be a TLS Kubernetes secret. tls_custom_ca_secret and tls_downstream_client_ca_secret referenced Secrets must contain ca.crt key containing a .PEM encoded (base64-encoded DER format) public certificate.

External Services

You may refer to external services by defining a Service with externalName.

I.e. if you have https://my-existing-service.corp.com:

apiVersion: v1
kind: Service
metadata:
  name: external
spec:
  type: ExternalName
  externalName: 'my-existing-service.corp.com'
  ports:
    - protocol: TCP
      name: https
      port: 443
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: external
  annotations:
    cert-manager.io/cluster-issuer: letsencrypt-prod-http
    ingress.pomerium.io/secure_upstream: 'true'
    ingress.pomerium.io/policy: |
      - allow:
          and:
            - domain:
                is: pomerium.com
spec:
  ingressClassName: pomerium
  tls:
    - hosts:
        - 'external.localhost.pomerium.io'
      secretName: external-localhost-pomerium.io
  rules:
    - host: 'external.localhost.pomerium.io'
      http:
        paths:
          - path: /
            pathType: Prefix
            backend:
              service:
                name: external
                port:
                  name: https

TLS Certificates

Pomerium expects TLS (HTTPS) for all routes created from the Ingress objects.

HTTP requests would be automatically redirected to the HTTPS port.

Pomerium certificates may be supplied individually per-Ingress via spec.tls, defined globally in the CRD via certificates, or both.

`spec.tls`

Pomerium load use certificates referenced by the spec.tls section of the Ingress. For more information, see the TLS section of the Ingress API documentation.

Global Certs

You may provide certificates as part of the global Pomerium configuration. This may be useful if you i.e. have a wildcard certificate.

cert-manager Integration

Pomerium Ingress Controller can use cert-manager to automatically provision certificates. These may come from the ingress-shim or explicitly configured Certificate resources.

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    cert-manager.io/issuer: example-issuer
    ingress.pomerium.io/policy: '[{"allow":{"and":[{"email":{"is":"user@exampledomain.com"}}]}}]'
  name: example
spec:
  ingressClassName: pomerium
  rules:
    - host: example.localhost.pomerium.io
      http:
        paths:
          - backend:
              service:
                name: example
                port:
                  name: http
            path: /
            pathType: Prefix
  tls:
    - hosts:
        - example.localhost.pomerium.io
      secretName: example-tls

To use HTTP01 Challenges with your Issuer, configure the solver class to match the Ingress Controller. The Pomerium Ingress Controller will automatically configure policy to facilitate the HTTP01 challenge:

apiVersion: cert-manager.io/v1
kind: Issuer
metadata:
  name: example-issuer
spec:
  acme:
    server: https://acme-staging-v02.api.letsencrypt.org/directory
    privateKeySecretRef:
      name: example-issuer-account-key
    solvers:
      - http01:
          ingress:
            class: pomerium

Metrics

Pomerium exposes a number of Prometheus style metrics that you may use to monitor your Ingress.

In order to filter out metrics for a particular Ingress, use envoy_cluster_name metric label, that has a ingressnamespace-ingressname-host-domain-com format.

See Envoy Cluster Stats for details on individual metrics.

Troubleshooting

View Event History

Pomerium Ingress Controller will add events to the Ingress objects as it processes them, and updates the status section of Pomerium CRD.

kubectl describe pomerium/global

Name:         global
Namespace:
Labels:       <none>
Annotations:  <none>
API Version:  ingress.pomerium.io/v1
Kind:         Pomerium
Metadata:
  Creation Timestamp:  2022-07-14T21:43:08Z
  Generation:          5
  Resource Version:  1507973
  UID:               9c7e56ab-e74c-492c-945d-5db1cd6582b0
Spec:
  Authenticate:
    URL:  https://login.localhost.pomerium.io
  Certificates:
    pomerium/wildcard-localhost
  Identity Provider:
    Provider:  google
    Secret:    pomerium/idp
  Secrets:     pomerium/bootstrap
  Storage:
    Postgres:
      Secret:  pomerium/postgres
Status:
  Ingress:
    pomerium/httpbin:
      Observed At:          2022-07-29T13:01:37Z
      Observed Generation:  1
      Reconciled:           true
  Settings Status:
    Observed At:          2022-07-27T18:44:43Z
    Observed Generation:  5
    Reconciled:           true
Events:
  Type    Reason   Age   From              Message
  ----    ------   ----  ----              -------
  Normal  Updated  43m   pomerium-ingress  pomerium/httpbin: config updated

Additionally, events are posted to the individual Ingress objects.

kubectl describe ingress/my-ingress

Events:
  Type    Reason   Age   From              Message
  ----    ------   ----  ----              -------
  Normal  Updated  18s   pomerium-ingress  updated pomerium configuration

If an error occurs, it may be reflected in the events:

Events:
  Type     Reason       Age                 From              Message
  ----     ------       ----                ----              -------
  Normal   Updated      5m53s               pomerium-ingress  updated pomerium configuration
  Warning  UpdateError  3s                  pomerium-ingress  upsert routes: parsing ingress: annotations: applying policy annotations: parsing policy: invalid rules in policy: unsupported conditional "maybe", only and, or, not, nor and action are allowed

Logs

kubectl logs deployment/pomerium

Pomerium assigns a unique request-id that is also set in the response headers. Filter by request-id to see access and authorization logs for a particular request.

Pomerium produces an access log entry for each request. Filter by "service":"envoy".

Pomerium performs authorization check for each and every request. Filter by "service":"authorize". See Authorization Log Keys.

HSTS

If your domain has HSTS enabled and you visit an endpoint while Pomerium is using the self-signed bootstrap certificate or a LetsEncrypt staging certificate (before cert-manager has provisioned a production certificate), the untrusted certificate may be pinned in your browser and would need to be reset. See this article for more information.

More Information

For more information on the Pomerium Ingress Controller or the Kubernetes concepts discussed, see:

Ingress​

Ingress Class​

Annotations​

Access Policy​

Deterministic Matching​

Regular Expressions Path Matching​

Unsupported features​

Services​

TCP Services​

Service Proxy​

Load Balancing​

Mutual TLS​

External Services​

TLS Certificates​

spec.tls​

Global Certs​

cert-manager Integration​

Metrics​

Troubleshooting​

View Event History​

Logs​

HSTS​

More Information​

Ingress

Ingress Class

Annotations

Access Policy

Deterministic Matching

Regular Expressions Path Matching

Unsupported features

Services

TCP Services

Service Proxy

Load Balancing

Mutual TLS

External Services

TLS Certificates

`spec.tls`

Global Certs

cert-manager Integration

Metrics

Troubleshooting

View Event History

Logs

HSTS

More Information