tasking-manager icon indicating copy to clipboard operation
tasking-manager copied to clipboard

Make docker defaults more useful for local testing setup and update documentation

Open SlowMo24 opened this issue 3 years ago • 10 comments

This PR updates the docker documentation that seems to lag behind the docker setup development. It does so by adapting the docker-compose defaults as well as the settings (.env) defaults.

In addition it updates and extends the documentation. This documentation update is quite brisk, so feel free to adapt anything where you don't agree. Especially I was not sure what would be the 'best-practice' to get administrator privileges on the self hosted Tasking Manager and how detailed to describe the procedure.

closes #5008

SlowMo24 avatar Apr 09 '22 19:04 SlowMo24

~sorry created this PR prematurely. Will rework and eventually reopen~ -> adapted and reopened

SlowMo24 avatar Apr 09 '22 21:04 SlowMo24

Please retry analysis of this Pull-Request directly on SonarCloud.

sonarqubecloud[bot] avatar Apr 15 '22 22:04 sonarqubecloud[bot]

Hi, @SlowMo24 we are working to implement OAuth2.0 for OSM login on #5029 which will have some changes to setup TM. Will review it as soon as #5029 is merged.

Aadesh-Baral avatar Jun 16 '22 05:06 Aadesh-Baral

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

sonarqubecloud[bot] avatar Sep 13 '22 12:09 sonarqubecloud[bot]

Thank you @Aadesh-Baral for reviewing. I have updated the config and docker-compose so it uses the same ports as the local development setup. I have also addressed #5313 and simplified the whole docker configuration. Feel free to comment.

SlowMo24 avatar Sep 13 '22 12:09 SlowMo24

Hey, thanks for approving. I think there has been a rework of the documentation (there is now a docs-old folder in main) and there are merge-conflicts. Is there any action required from my side (i.e. should I have a look at the new docs?) or are you in the middle of a process there?

SlowMo24 avatar Dec 19 '22 10:12 SlowMo24

Hi @SlowMo24 , I've picked a commit from this PR to #5463 and planning to work on that PR itself.

Aadesh-Baral avatar Dec 19 '22 10:12 Aadesh-Baral

Related to #5705

eternaltyro avatar Apr 14 '23 11:04 eternaltyro

Seems like there are some conflicts after-all. I will review this tomorrow and see how we can incorporate these changes into the new docs hierarchy.

eternaltyro avatar May 10 '23 22:05 eternaltyro

This looks good to be merged. cc : @Aadesh-Baral this seems to only affect docker-compose setups and might not interfere with other merge requests in queue. Can we proceed?

LGTM. Please go ahead.

Aadesh-Baral avatar May 15 '23 10:05 Aadesh-Baral

@mahesh-naxa - could you please verify if some of these issues have been fixed with the recent docker PRs? cc @spwoodcock @dakotabenjamin

ramyaragupathy avatar Apr 11 '24 14:04 ramyaragupathy

The actual config changes aren't required anymore - they have since been updated.

The docs in the PR were definitely useful at the time too, but I think the docs and config have changed since then, so it's hard to reconcile.

Unfortunately, it may be best to close this PR. So sorry @SlowMo24, I think this fell through the cracks! The contribution was good 🙏

spwoodcock avatar Apr 11 '24 14:04 spwoodcock

His docs specifically on how to generate OSM Auth client/secret with screenshots are helpful imo. Others have been addressed.

mahesh-naxa avatar Apr 12 '24 05:04 mahesh-naxa

This MR was the result of me setting up my own tasking manager instance for a research project that I presented at SotM2022: https://gitlab.gistools.geog.uni-heidelberg.de/giscience/ideal-vgi/osm-multitag . At that time I struggled quite a bit with the documentation but especially with Traefik (see #5313 ). The project is since completed and I currently don't work with it any more (:thinking: should take down that server I set up back then). So I am out of date with your code-base on the topic.

Things happen, let's move forward: I am happy to support you (I also gained a bit more knowledge on Docker and Traefik since then ;-) )

Please tell me where you could use support and I will see what I can do. For example I could run the setup procedure again with the current documentation and create issues or MRs where I fail. Yet, I would need some info on who you actually target with the documentation and the docker setup. If it is meant to be your team-documentation and should limit the lottery factor we might think differently about it than if it was meant for what I did: random humans set up their own instance. Or I could see If I can rebase this MR and reduce it the the parts that are still missing, if you think that is helpful.

SlowMo24 avatar Apr 12 '24 07:04 SlowMo24

Thanks so much for the offer @SlowMo24, very kind of you 😄

Testing our current setup and providing feedback on the config or documentation around it would be a huge help 🙏

Feel free to rebase this or create a new MR/PR as needed & we will be much quicker to review next time!

spwoodcock avatar Apr 12 '24 08:04 spwoodcock