traction icon indicating copy to clipboard operation
traction copied to clipboard

Manage script including arm virtualisation

Open H4LL opened this issue 1 year ago • 3 comments

I made a PR the other dayh about mac virtualisation: https://github.com/bcgov/traction/pull/1371#pullrequestreview-2352541904

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.

H4LL avatar Oct 10 '24 05:10 H4LL

I'm assuming https://github.com/bcgov/traction/pull/1371 can be closed in favor of this PR. Is that correct?

WadeBarnes avatar Oct 10 '24 12:10 WadeBarnes

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 https://github.com/bcgov/traction/pull/1388/commits/db33f52e235babd2f506d32a0389960d00eaeae6

Screenshot 2024-10-11 at 11 00 45 AM

H4LL avatar Oct 11 '24 04:10 H4LL

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?

loneil avatar Oct 11 '24 18:10 loneil

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 https://github.com/bcgov/traction/pull/1388/commits/344346a1b34f5b83fddcf2df1032bc27f552e2e1 and https://github.com/bcgov/traction/pull/1388/commits/31edeb6681f0f5e5a47ab700601c6191fe69aa43 respectively.

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

H4LL avatar Oct 14 '24 04:10 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.

H4LL avatar Oct 16 '24 00:10 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.

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 avatar Oct 16 '24 00:10 loneil

Issue to look into log output created: https://github.com/bcgov/traction/issues/1401

loneil avatar Oct 16 '24 14:10 loneil