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

Ensure Objects API and ObjectTypes API work behind a gateway (eg. the 'OPENZAAK_DOMAIN' pattern), with optionally a subpath #388

Closed
6 tasks done
alextreme opened this issue Apr 2, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request owner: amsterdam

Comments

@alextreme
Copy link
Member

alextreme commented Apr 2, 2024

With Open Zaak we have the OPENZAAK_DOMAIN envvar which functions as a 'forced' X-Forwarded-For setting to switch the install do a different domain name.

This is being used by more gemeentes to make use of components behind an API gateway. The problem (without changes) is that URLs used by a component is then the internal URL instead of the API gateway URL (eg: using 'https://api.amsterdam.nl/zgw/objects' instead of 'https://objects.amsterdam.nl')

Nore that it's about more than the domain name, an API gateway often differentiates between backend APIs using a subpath. So in the example above, /zgw/objects would point to our Objects API, while /zgw/openzaak would point to Open Zaak.

Ensure that OIDC and references to other components works as expected (note open-zaak/open-zaak#1585 and open-zaak/open-zaak#1592 ). Also ensure the admin still works using the internal domain name ( open-zaak/open-zaak#1561 )

OZ implementation: open-zaak/open-zaak#1020

Needed/Expected for Amsterdam (APIM) and Rotterdam (HIP)

Components

  • Open Zaak
  • Open Notifications
  • Objects API
  • Objecttypes
  • Open Klant
  • Referentielijsten
@joeribekker
Copy link
Member

Blocked by #1585

@joeribekker
Copy link
Member

Discussed in Weekly: We're not going to use the OPENZAAK_DOMAIN pattern but instead the X_FORWARDED_HOST solution.

@alextreme
Copy link
Member Author

Depends on open-zaak/open-zaak#1629 (if that issue is completed, this one should be done too)

@joeribekker joeribekker added enhancement New feature or request and removed triage labels May 22, 2024
@alextreme
Copy link
Member Author

Discussed, can be closed after the subpath and xforwardedfor settings are included into OAF, in that case no further steps are necessary for the Objects API

@stevenbal stevenbal moved this from Todo to In Progress in Data en API fundament Jul 4, 2024
@stevenbal stevenbal moved this from In Progress to Todo in Data en API fundament Jul 4, 2024
@stevenbal
Copy link
Contributor

open-zaak/open-zaak#1629 was completed, so all of the components now have X_FORWARDED_HOST, this will be visible in each project's docs once open-zaak/open-zaak#1649 is done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request owner: amsterdam
Projects
Status: Done
Development

No branches or pull requests

3 participants