-
Notifications
You must be signed in to change notification settings - Fork 506
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
remove hardcoded rootPath values #1874
Conversation
6b9ddb8
to
afc374f
Compare
I believe the install shell script can be much more robust in some places and some variables could be extracted to the top. Currently, the scrip also expects some files in the right place, instead of being relative to its location. I'll do that cleanup work in another PR. This PR's sole purpose is to remove the hard-coded values. One step at a time ;-) |
sudo chown www-data $ATHENS_DISK_STORAGE_ROOT | ||
sudo chgrp www-data $ATHENS_DISK_STORAGE_ROOT |
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.
Shouldn't the chown
and chgrp
commands be kept in order to still make sure www-data
owns the ReadWritePaths
?
Hi @Jeansen ! Are you still interested in getting this merged? |
Hi @Ullaakut. Yes, I am. But I am not sure, how to proceed... |
Heya! Do you mind ELI5'ing these changes as well as your long term plan? I'm actually pretty unsure of how all of this should work. It might also be helpful to have a main issue for the long term plan as well as some sub-issues since you want to tackle this in phases. |
I'll try! This PR removes hard-coded values. The only place of truth should the the config TOML file. If this is in agreement with you (all), then that's what this PR is about. To make things more robust, I see some more possible improvements in the install script. But since this is my first PR in the project, I first wanted to get some idea of how this project "ticks". Anyway, if you think my ideas are worth a shot, I could create another PR so you see, where I'd like to go. But as it stands, it is all about having as much hard-coded values removed or extracted to only one place and making the installation follow Postel's Law. |
That makes sense! Thanks for the breakdown. Does it make sense to ensure whatever directory the user has supplied that it fits the permissions we need and that it actually exists? I'm referring to this being removed: |
I think users should be aware of the fact that they are missing the right permissions and be forced to set them explicitly. Convention over configuration is a great concept. But with respect to permissions I'd be careful ;-) |
Thanks for that bit of wisdom. Last thing, do you think anything here needs changing? |
@matt0x6F I'll have a look at it this WE and give you my feedback then. |
I checked the helm repo. It looks fine to me, so far. But I did not dive into details too far, to be honest. Anyway, there you have it, too. The user ist set to 1000 if not run as root. And the Also, helm templates kind of serve as a on-the-fly config file by creating all the relevant environment variables which - if applicable - overwrite settings from the config file. Regarding this I'd strongly advice against being able to set a user/group through environment variables. But I would put the I also saw the issue requesting an option to add a custom |
That makes sense. I've got a couple PRs to merge later today so this one's on my list! |
I'll go for the next phase then, do some more improvements, cleanup etc - if that's OK? |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [gomods/athens](https://github.com/gomods/athens) | patch | `v0.13.1` -> `v0.13.3` | --- ### Release Notes <details> <summary>gomods/athens (gomods/athens)</summary> ### [`v0.13.3`](https://github.com/gomods/athens/releases/tag/v0.13.3) [Compare Source](https://github.com/gomods/athens/compare/v0.13.2...v0.13.3) #### What's Changed - Update README.md by [@​computerscienceiscool](https://github.com/computerscienceiscool) in [https://github.com/gomods/athens/pull/1932](https://github.com/gomods/athens/pull/1932) - update-go-pkg(deps): bump github.com/stretchr/testify from 1.8.4 to 1.9.0 by [@​dependabot](https://github.com/dependabot) in [https://github.com/gomods/athens/pull/1933](https://github.com/gomods/athens/pull/1933) - Upgrade logrus from 1.7.0 => 1.9.3 by [@​matt0x6F](https://github.com/matt0x6F) in [https://github.com/gomods/athens/pull/1934](https://github.com/gomods/athens/pull/1934) - should use errors.AsErr to extract and detect errors.Error by [@​kkHAIKE](https://github.com/kkHAIKE) in [https://github.com/gomods/athens/pull/1936](https://github.com/gomods/athens/pull/1936) - correcting the misuse of the context in the copyContextWithCustomTime… by [@​kkHAIKE](https://github.com/kkHAIKE) in [https://github.com/gomods/athens/pull/1941](https://github.com/gomods/athens/pull/1941) - remove hardcoded rootPath values by [@​Jeansen](https://github.com/Jeansen) in [https://github.com/gomods/athens/pull/1874](https://github.com/gomods/athens/pull/1874) #### New Contributors - [@​computerscienceiscool](https://github.com/computerscienceiscool) made their first contribution in [https://github.com/gomods/athens/pull/1932](https://github.com/gomods/athens/pull/1932) - [@​kkHAIKE](https://github.com/kkHAIKE) made their first contribution in [https://github.com/gomods/athens/pull/1936](https://github.com/gomods/athens/pull/1936) - [@​Jeansen](https://github.com/Jeansen) made their first contribution in [https://github.com/gomods/athens/pull/1874](https://github.com/gomods/athens/pull/1874) **Full Changelog**: gomods/athens@v0.13.2...v0.13.3 ### [`v0.13.2`](https://github.com/gomods/athens/releases/tag/v0.13.2) [Compare Source](https://github.com/gomods/athens/compare/v0.13.1...v0.13.2) #### What's Changed - Send standard logger's output to logrus by [@​mikesep](https://github.com/mikesep) in [https://github.com/gomods/athens/pull/1912](https://github.com/gomods/athens/pull/1912) - chore: fix broken links to 'absolutely everybody' blog post by [@​darrylblake](https://github.com/darrylblake) in [https://github.com/gomods/athens/pull/1914](https://github.com/gomods/athens/pull/1914) - update-github-action(deps): bump golangci/golangci-lint-action from 3 to 4 by [@​dependabot](https://github.com/dependabot) in [https://github.com/gomods/athens/pull/1915](https://github.com/gomods/athens/pull/1915) - update-go-pkg(deps): bump github.com/gorilla/mux from 1.6.2 to 1.8.1 by [@​dependabot](https://github.com/dependabot) in [https://github.com/gomods/athens/pull/1917](https://github.com/gomods/athens/pull/1917) - update-go-pkg(deps): bump github.com/stretchr/testify from 1.8.1 to 1.8.4 by [@​dependabot](https://github.com/dependabot) in [https://github.com/gomods/athens/pull/1918](https://github.com/gomods/athens/pull/1918) - update-go-pkg(deps): bump go.etcd.io/etcd/api/v3 from 3.5.9 to 3.5.12 by [@​dependabot](https://github.com/dependabot) in [https://github.com/gomods/athens/pull/1919](https://github.com/gomods/athens/pull/1919) - Fix Markdown link in Storage docs by [@​chriskuehl](https://github.com/chriskuehl) in [https://github.com/gomods/athens/pull/1922](https://github.com/gomods/athens/pull/1922) - Use quotes for args by [@​matt0x6F](https://github.com/matt0x6F) in [https://github.com/gomods/athens/pull/1925](https://github.com/gomods/athens/pull/1925) - Add log formatting settings by [@​matt0x6F](https://github.com/matt0x6F) in [https://github.com/gomods/athens/pull/1926](https://github.com/gomods/athens/pull/1926) - upgrade mongodb driver by [@​xytan0056](https://github.com/xytan0056) in [https://github.com/gomods/athens/pull/1928](https://github.com/gomods/athens/pull/1928) - update-go-pkg(deps): bump github.com/lib/pq from 1.10.7 to 1.10.9 by [@​dependabot](https://github.com/dependabot) in [https://github.com/gomods/athens/pull/1923](https://github.com/gomods/athens/pull/1923) - Rework logging defaults by [@​matt0x6F](https://github.com/matt0x6F) in [https://github.com/gomods/athens/pull/1927](https://github.com/gomods/athens/pull/1927) #### New Contributors - [@​darrylblake](https://github.com/darrylblake) made their first contribution in [https://github.com/gomods/athens/pull/1914](https://github.com/gomods/athens/pull/1914) - [@​chriskuehl](https://github.com/chriskuehl) made their first contribution in [https://github.com/gomods/athens/pull/1922](https://github.com/gomods/athens/pull/1922) - [@​matt0x6F](https://github.com/matt0x6F) made their first contribution in [https://github.com/gomods/athens/pull/1925](https://github.com/gomods/athens/pull/1925) **Full Changelog**: gomods/athens@v0.13.1...v0.13.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/gomods/athens-charts). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMDEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjMwMS40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
What is the problem I am trying to address?
Systemd script had some hard-coded values overwriting the config.toml settings. I've removed them and added some dynamic replacements in the athens.service
How is the fix applied?
?
What GitHub issue(s) does this PR fix or close?
Fixes #1798