Stream: containers

Topic: tutorial for demo or eval #10238

view this post on Zulip Philip Durbin 🚀 (Jan 17 2024 at 21:27):

I turned this note we keep talking about into an issue: Tutorial for running containers as a demo or for evaluation #10238

view this post on Zulip Philip Durbin 🚀 (Jan 17 2024 at 21:27):

And I successfully got it prioritized into the current sprint, which just started (and lasts two weeks).

view this post on Zulip Philip Durbin 🚀 (Jan 17 2024 at 21:28):

Ideas are welcome!

view this post on Zulip Philip Durbin 🚀 (Jan 18 2024 at 20:19):

Nice discussion on this today: https://harvard.zoom.us/rec/share/EUOqzaq4NzsH4N8xX7kg9II8w292MEB6eqbyzPMlZOACsErKV-Z20hHBj1HerFH2.bGFh04EdU1Qnu9ic

view this post on Zulip Philip Durbin 🚀 (Jan 18 2024 at 20:19):

Here's the doc we hacked on: https://docs.google.com/document/d/16rmOV2kJSVEKj3fCnoV_YbWr-i1AZGAAuwmle3sQD_A/edit?usp=sharing

view this post on Zulip Philip Durbin 🚀 (Jan 26 2024 at 14:44):

I started a branch. Here's a preview of what I have so far: https://dataverse-guide--10273.org.readthedocs.build/en/10273/container/index.html

view this post on Zulip Philip Durbin 🚀 (Jan 26 2024 at 14:44):

Please feel free to comment here or in the pull request: #10273

view this post on Zulip Philip Durbin 🚀 (Jan 26 2024 at 16:07):

We had this idea that the person wanting to evaluate Dataverse will download a single compose file, but our current compose file relies on a .env file. Without it, you get this:

% docker compose up
WARN[0000] The "POSTGRES_VERSION" variable is not set. Defaulting to a blank string.
WARN[0000] The "DATAVERSE_DB_USER" variable is not set. Defaulting to a blank string.
WARN[0000] The "STORAGE_DIR" variable is not set. Defaulting to a blank string.
WARN[0000] The "DATAVERSE_DB_USER" variable is not set. Defaulting to a blank string.
WARN[0000] The "APP_IMAGE" variable is not set. Defaulting to a blank string.
WARN[0000] The "SOLR_VERSION" variable is not set. Defaulting to a blank string.

view this post on Zulip Philip Durbin 🚀 (Jan 26 2024 at 16:07):

Should I put define all these (SOLR_VERSION, etc) directly in the compose file?

view this post on Zulip Philip Durbin 🚀 (Jan 26 2024 at 16:15):

I think that's what I'll do for now. I tried it. Works fine.

view this post on Zulip Philip Durbin 🚀 (Jan 26 2024 at 21:40):

Ok, the PR is far from perfect but I'm ready for review. Please take a look: #10273.

view this post on Zulip Philip Durbin 🚀 (Jan 29 2024 at 20:20):

Writing docs is kind of exhausting. :sweating:

view this post on Zulip Oliver Bertuch (Jan 30 2024 at 06:16):

https://er4hn.info/blog/2023.07.22-good_docs_great_effort/ :sweat_smile:

view this post on Zulip Philip Durbin 🚀 (Jan 30 2024 at 13:16):

This effort is actually more than docs. We're starting to create a "demo" persona. But it's a bumpy road. Without --insecure, you can't easily set any database settings. So you can't set :DoiProvider to FAKE.

view this post on Zulip Philip Durbin 🚀 (Jan 30 2024 at 16:56):

I created a new topic about that: #dev > can't create dataset without :DoiProvider set to FAKE

view this post on Zulip Philip Durbin 🚀 (Jan 30 2024 at 17:15):

I guess you can set it after the fact like this:

docker exec -it dataverse curl http://localhost:8080/api/admin/settings/:DoiProvider -X PUT -d FAKE

view this post on Zulip Philip Durbin 🚀 (Jan 30 2024 at 21:52):

Ok, I just pushed a fairly big rewrite, attempting to use more of a tutorial style. Feedback is welcome! https://dataverse-guide--10273.org.readthedocs.build/en/10273/container/running/demo.html

view this post on Zulip Oliver Bertuch (Jan 30 2024 at 22:24):

I see some typos here and there, but I like the new style! I am tempted to slighty reformat a thing or two, but maybe we can leave that for later. General question: do we want asciicinema or screenshots?

view this post on Zulip Philip Durbin 🚀 (Jan 30 2024 at 22:32):

Yeah, I'm not surprised there are typos. I was in a rush to get out the door. Thanks, I'll look. :heart:

view this post on Zulip Philip Durbin 🚀 (Jan 30 2024 at 22:33):

I don't love screenshots because they're a maintenance burden. What do you want screenshots of?

view this post on Zulip Philip Durbin 🚀 (Jan 30 2024 at 22:37):

I mean, I love being on the receiving end of screenshots when I'm reading other people's docs. :grinning:

view this post on Zulip Philip Durbin 🚀 (Jan 31 2024 at 12:55):

@Johannes D thanks for all the feedback on #10273!

view this post on Zulip Philip Durbin 🚀 (Feb 01 2024 at 18:59):

@Oliver Bertuch thanks for all the ideas at the meeting. Regarding editing setup-all.sh... in order for Leonid (or anyone) to use the edited version (with a new --container flag or whatever), he'd have to wait for the next release for new alpha images to be published, right? Because setup-all is in the configbaker image. Otherwise, he'd have to rebuild the configbaker image, which is a complication I'd like to avoid for some trying to do a demo or eval. Am I thinking about this wrong? Maybe we should stick with the idea of making brief use of --insecure.

view this post on Zulip Philip Durbin 🚀 (Feb 01 2024 at 21:46):

Ok, I pushed a commit, left a comment, and moved it back to ready for review. More feedback is welcome! Thanks again for the discussion today!

view this post on Zulip Oliver Bertuch (Feb 02 2024 at 00:05):

Can't we use a ghcr.io preview image while testing the branch and switch back before merge?

view this post on Zulip Philip Durbin 🚀 (Feb 02 2024 at 12:40):

Hmm, or merge this and then make a new PR where we use the preview image technique. Good idea, thanks.

view this post on Zulip Philip Durbin 🚀 (Feb 05 2024 at 20:20):

@Jutta Schnabel not sure if your demo/eval is still going on but there's a new tutorial to try if you'd like. It hasn't been merged yet but for you can preview it at https://dataverse-guide--10273.org.readthedocs.build/en/10273/container/running/demo.html and feedback is absolutely welcome!

view this post on Zulip Philip Durbin 🚀 (Feb 07 2024 at 12:44):

@Leo Andreev is asking if he can go ahead and merge the PR. Any objections?

@Don Sizemore I didn't get around to documenting -d for detached.

@Oliver Bertuch I didn't mess with setup-all.sh. Like you said, we can try a preview image but I'm thinking in a future PR.

@Johannes D I didn't do the reorg you mentioned. Not a bad idea.

view this post on Zulip Don Sizemore (Feb 07 2024 at 13:11):

Philip Durbin said:

Don Sizemore I didn't get around to documenting -d for detached.

@Philip Durbin no objections from me, it was just a question of convenience though I understand your wanting visibility for first-timers. I vote merge!

view this post on Zulip Jutta Schnabel (Feb 07 2024 at 13:31):

Philip Durbin schrieb:

Jutta Schnabel not sure if your demo/eval is still going on but there's a new tutorial to try if you'd like. It hasn't been merged yet but for you can preview it at https://dataverse-guide--10273.org.readthedocs.build/en/10273/container/running/demo.html and feedback is absolutely welcome!

Great, thanks - yes, we are still evaluating and progressing nicely there :)

view this post on Zulip Philip Durbin 🚀 (Feb 07 2024 at 13:35):

@Jutta Schnabel great! It's not too late to give feedback on that new tutorial if you'd like!

view this post on Zulip Philip Durbin 🚀 (Feb 07 2024 at 17:18):

Merged! Now preview-able at https://preview.guides.gdcc.io/en/develop/container/running/demo.html

Last updated: Oct 30 2025 at 05:14 UTC