Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds ip range lookup support #1262

Merged
merged 7 commits into from
Feb 26, 2024
Merged

Adds ip range lookup support #1262

merged 7 commits into from
Feb 26, 2024

Conversation

ZPain8464
Copy link
Contributor

This PR adds a section to our Integrations page explaining the CIDR indexing support for external data sources.

Resolves https://github.com/pomerium/internal/issues/1737

@ZPain8464 ZPain8464 requested a review from kenjenkins February 22, 2024 18:23
@ZPain8464 ZPain8464 requested a review from a team as a code owner February 22, 2024 18:23
@ZPain8464 ZPain8464 requested review from cmo-pomerium and removed request for a team February 22, 2024 18:23
Copy link

netlify bot commented Feb 22, 2024

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit ef4c16a
🔍 Latest deploy log https://app.netlify.com/sites/pomerium-docs/deploys/65dcf471851c2a0008b5a336
😎 Deploy Preview https://deploy-preview-1262--pomerium-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


## IP range lookup support

Pomerium supports Classless Inter-Domain Routing (CIDR) indexing to improve database querying performance. This is useful if you're importing a list of records containing IP ranges.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The thing I was surprised about was the ability to match on IP address ranges at all (setting aside any questions to do with performance).

I'd like to see some explanation along these lines:

"When using request.ip as a key, you can also match against IP address ranges (expressed in CIDR notation). To do so, add a special $index key to your external data source records, like so:"

It also might make sense to move this up, next to the "Foreign Key" heading?

@@ -33,7 +33,7 @@ See the pages in this section for more information on our example data sources,

Any external data source integration requires the following settings:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Side note: I don't think this is accurate. I think the last four settings are optional ("Headers", "Allow Insecure TLS", "Polling Min/Max Delay", "Client TLS Key").

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I was actually looking for "Allow Insecure TLS" in the Console UI and couldn't find it at all. I'll submit an issue to update this page, but it's not a high priority in my opinion at the moment.

@ZPain8464 ZPain8464 requested a review from kenjenkins February 26, 2024 16:17
@ZPain8464 ZPain8464 merged commit dc40dae into main Feb 26, 2024
2 checks passed
@ZPain8464 ZPain8464 deleted the zpain/document-index branch February 26, 2024 20:29
backport-actions-token bot pushed a commit that referenced this pull request Feb 26, 2024
* adds ip range lookup support

* updates text

* runs prettier

* updates text and moves section

* Update content/docs/integrations.mdx

Co-authored-by: Kenneth Jenkins <[email protected]>

* Update content/docs/integrations.mdx

Co-authored-by: Kenneth Jenkins <[email protected]>

* Update content/docs/integrations.mdx

Co-authored-by: Kenneth Jenkins <[email protected]>

---------

Co-authored-by: Kenneth Jenkins <[email protected]>
ZPain8464 added a commit that referenced this pull request Feb 26, 2024
Adds ip range lookup support (#1262)

* adds ip range lookup support

* updates text

* runs prettier

* updates text and moves section

* Update content/docs/integrations.mdx



* Update content/docs/integrations.mdx



* Update content/docs/integrations.mdx



---------

Co-authored-by: zachary painter <[email protected]>
Co-authored-by: Kenneth Jenkins <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants