Skip to content
This repository has been archived by the owner on Sep 20, 2022. It is now read-only.

Add Deprecation Notice #143

Merged
merged 7 commits into from
Nov 8, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[![codecov](https://img.shields.io/codecov/c/github/pomerium/pomerium-operator.svg?style=flat)](https://codecov.io/gh/pomerium/pomerium-operator)
![Docker Pulls](https://img.shields.io/docker/pulls/pomerium/pomerium-operator)

- [:warning: Deprecation Notice](#warning-deprecation-notice)
- [About](#about)
- [Initial discussion](#initial-discussion)
- [Installing](#installing)
Expand All @@ -17,6 +18,20 @@
- [Development](#development)
- [Building](#building)
- [Roadmap](#roadmap)

# :warning: Deprecation Notice

We've just released a new Ingress Controller (docs [here](https://www.pomerium.com/docs/k8s/ingress.html)), which supersedes the operator.

[Pomerium Ingress Controller](https://github.com/pomerium/ingress-controller) addresses shortcomings in the operator and allows Pomerium to directly handle `Ingress` resources without the need for an external/third-party ingress controller. Additionally, the ingress controller supports Pomerium's new [policy language](https://www.pomerium.com/enterprise/reference/manage.html#pomerium-policy-language) and other features introduced in the last year or so.

As such, pomerium-operator will no longer be receiving updates. Most practically, the operator will not be supported on Kubernetes v1.22+ due to the [deprecation](https://kubernetes.io/docs/reference/using-api/deprecation-guide/#ingress-v122) of the `v1beta1/Ingress` API.

While it is possible to deploy the ingress controller in an "operator compatible" manner, the new project is meant to function as a first class ingress controller and we strongly recommend migrating to the native functionality. This provides higher performance, stronger security guarantees, lower complexity, and reduced error opportunities compared to using a third party ingress integration via forward-auth.

See https://github.com/pomerium/pomerium-helm/tree/master/charts/pomerium#2500-1 for upgrade steps if you'd like to continue using forward-auth and a separate proxy.

Note: Beginning in Helm chart `v25.0.0`, the operator deployment has been replaced with Pomerium Ingress Controller.
# About

An operator for running Pomerium on a Kubernetes cluster.
Expand Down