pomerium / pomerium/documentation

update Runtime Flags reference page to document Ingress Controller support

Open Beginner friendly
#1,963 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Fix Content
Dominant language
MDX
Stars
13
Forks
23
Avg merge
1d 5h
Merged PRs (30d)
11

Description

Page: https://www.pomerium.com/docs/reference/runtime-flags#how-to-configure

What's incorrect or missing

The page states that:

Runtime flags are currently configurable only in Pomerium Core.

However it looks like support was added to Ingress Controller in https://github.com/pomerium/ingress-controller/pull/1010.

What's the resolution?

Let's update the "How to configure" section with an Ingress Controller example and/or a link to the CRD reference.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Runtime Flags reference page's "How to configure" section and review the linked ingress-controller PR #1010 for the supported configuration details. Done means the page no longer incorrectly limits runtime flags to Pomerium Core and includes an Ingress Controller example and/or a link to the CRD reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.