Manage script including arm virtualisation

[H4LL]

I made a PR the other dayh about mac virtualisation: #1371 (review)

I ended up turning it into a ./manage file. I hadn't originally included signoffs in my previous PR so I thought I'd amend it but I ended up touching a bunch of commits which were nothing to do with me. I thought it would be simpler to create a fresh PR here.

I tested this by removing all images then running through ./manage build, stop, start, restart.

[WadeBarnes]

I'm assuming #1371 can be closed in favor of this PR. Is that correct?

[H4LL]

Thanks for the feedback, I went ahead and closed that other PR. I've also added a UI to the manage script to make it a little nicer in db33f52

[WadeBarnes]

Nice work! In addition to the stop, I would recommend including a down | rm command to allow a user to reset their environment. My previous comment regarding the the down and stop options was meant to recommend the addition of the stop command.

No a show stopper, it could be added later.

[loneil]

This looks great, my one thing with the ./manage scripts (which we do use in plenty of our projects so is a good idea to match in Traction here) is that if I'm on Windows and just pull the repo and follow the instructions nothing will happen so it can look like it's broken. I can use Git Bash or WSL. But with docker compose build/up I can just run in powershell/cmd.

Probably just best to cover that with some notes in the Readme, unless anyone else has other thoughts on using Unix-style scripts for starting up here?

[esune]

I agree with @loneil about providing a little bit more detail on the fact that the script needs to be run in a bash-compatible shell as it might not be obvious for everyone running the project for the first time. Other than that this looks great!

I'd rather have it added in this PR than a follow-up just so that the changes are self-contained (and since we already tweaked the instructions in the readme file).

[H4LL]

Hey @esune @loneil @WadeBarnes,

Thanks, I've updated the manage script to have a down option and I've reworded the instruction in the README to be explicit about using a bash shell. The updates are in 344346a and 31edeb6 respectively.

Let me know if there's anything else you'd like!

[loneil]

Works for me, used Win11 and Git Bash, ran with ./manage no args and used prompts to build and start.

I usually check logs outside of the terminal I would use to start up so not a big difference to me, but noticed in the older docker compose up instructions you would see the logs for all the containers tailing out, whereas with manage the way I ran it it sits like this

when we use the manage script on VCAuthN for example we have logs tail out

if anyone else has thoughts on if keeping that pattern is important?

[H4LL]

Hey @loneil,

I could explore a 'logs' option which could potentially overwrite the default behavior of the terminal for easier debugging. I'm sure it wont take too long (famous last words). If we want to go deep with that option I could also try a logs dir where the logs from each container are directed into their own file. I've not seen that design pattern in any other Aries adjacent repos but I feel like it'd be useful.

[loneil]

Hey @loneil,

I could explore a 'logs' option which could potentially overwrite the default behavior of the terminal for easier debugging. I'm sure it wont take too long (famous last words). If we want to go deep with that option I could also try a logs dir where the logs from each container are directed into their own file. I've not seen that design pattern in any other Aries adjacent repos but I feel like it'd be useful.

Hi @H4LL I think it's useful enough to get what we have here in and look at logging enhancement as a separate issue. I'll create one for that later and link it back. So going to approve this and merge it shortly unless anyone else has any thoughts.

Other ones we use on our team that just tail to the terminal are
https://github.com/bcgov/vc-authn-oidc/blob/main/docker/manage
https://github.com/hyperledger/aries-endorser-service/blob/main/docker/manage

but yeah I think there's some other patterns around other Aries apps as well.

Thanks!

[loneil]

Issue to look into log output created: #1401