-
Notifications
You must be signed in to change notification settings - Fork 4
feat: Add helm chart auth options. #118
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
Conversation
985ef13 to
fa530fa
Compare
helm/AUTHORIZATION.md
Outdated
| @@ -0,0 +1,150 @@ | |||
| # Authorization configuration guide | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we push this into the docs directory to publish at developmentseed.org/stac-auth-proxy?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might be a bit out of context. We could move it into the docs but frame it as helm/kubernetes setup and include this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aside from the repo, is there anywhere else that this information would be surfaced?
I'd ideally like for people to be able to think about this tool as a packaged product rather than just a codebase, hence my view that docs should be available outside of the repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aside from the repo, is there anywhere else that this information would be surfaced?
I'd ideally like for people to be able to think about this tool as a packaged product rather than just a codebase, hence my view that docs should be available outside of the repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to move it to the docs. Perhaps good to bring in #117 first? After that I can combine README and AUTHORIZATION into one file in the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wasn't aware of the deployment.md, now that I found it, #117 is not a prerequisite anymore.
- Moved the kubernetes information from
docs/user-guides/deployment.mdtodocs/user-guides/kubernetes.md - Moved the content of
AUTHORIZATION.mdinto the docs folder'skubernetes.md
helm/values.yaml
Outdated
| mode: "default" | ||
|
|
||
| # Custom endpoint configurations (only used when mode: "custom") | ||
| publicEndpoints: {} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will this (and the privateEndpoints) override the defaults established within the stac auth proxy's configuration?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These would just set an env variable with the contents specified here. So, to my understanding, yes, if these are set, they will override them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarified a bit better in the comments.
cdf7bea to
ad51501
Compare
ad51501 to
1f602c5
Compare
alukach
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, let's give this a go. I am still a bit skeptical that this detailed config is superior to just raw environment variables but am going to assume that it's a K8s thing and go with that
🤖 I have created a release *beep* *boop* --- ## [0.11.1](v0.11.0...v0.11.1) (2026-01-13) ### Features * Add helm chart auth options. ([#118](#118)) ([cfae34b](cfae34b)) * Add helm README.md and unit tests ([#117](#117)) ([74a1bc8](74a1bc8)) ### Bug Fixes * Enhance type safety in middleware and utility functions ([#122](#122)) ([52cdd0e](52cdd0e)) * Helm chart and app version mismatch. ([#120](#120)) ([7998675](7998675)) * Make docker image to run as non-root. ([#116](#116)) ([35e06f3](35e06f3)) * Skip CQL2 filter build for OPTIONS requests ([#123](#123)) ([6ee043e](6ee043e)), closes [#110](#110) ### Documentation * temporarily disable starlette docstrings ([c4fd9e0](c4fd9e0)) ### Miscellaneous Chores * release 0.11.1 ([976dfab](976dfab)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: ds-release-bot[bot] <116609932+ds-release-bot[bot]@users.noreply.github.com>
This PR adds the following authorization options to the helm chart:
Manual configuration via environment variables and manual mount of filter files is still possible.
Moved kubernetes documentation into it's own file and added documentation for the auth options provided by the helm charts with this PR.
The PR requires #114
and #117.I open this as a draft, as I expect us to have a few iterations and conversations about this.