Document helpful tips for dev on Apple-silicon/ARM

[tarilabs]

Resolves #214

Description

bootstrap documentation as discussed.
Follows-up also on:

• refactor: updated makefile and docker to allow development for apple silicon caikit-tgis-serving#171 (comment)
• Investigate the use of dev containers as mechanism for supporting development on Apple silicon caikit-tgis-serving#172 (comment).

How Has This Been Tested?

n/a

Merge criteria:

• The commits and have meaningful messages; the author will squash them after approval or will ask to merge with squash.
• Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
• The developer has manually tested the changes and verified that the changes work

[spolti]

A small change that I do when something fails on apple, is to force podman to use amd64 in the build commands.
podman build --arch=amd64.

works pretty nice.

We could have in the Makefile a if to append args, e.g. when using podman && arm, appends args.

[tarilabs]

Ciao @spolti !! 👋

I've tried Podman, but for some reasons it didn't work well on Mac (at least I've installed all necessary Mac-helpers) specifically when using TestContainers for Go it required code-changes (beyond config changes) unfortunately.
It's a bit sad because I really preferred to use Podman if possible.

I'm not against using it, but at least when developing for this project, so far the best experience was with Colima.

Always happy to hear if anyone can report difference experiences!

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (da35fd3) 74.52% compared to head (a127c05) 74.52%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #215   +/-   ##
=======================================
  Coverage   74.52%   74.52%           
=======================================
  Files          17       17           
  Lines        2296     2296           
  Branches       73       73           
=======================================
  Hits         1711     1711           
  Misses        420      420           
  Partials      165      165           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[spolti]

Thanks for the explanation @tarilabs, how did you install podman?
I didn't install any helper, it works ok (also exposes the podman registry for docker so docker understand that it does have a registry).

All I did was install podman and podman-desktop.

[tarilabs]

Thanks for the explanation @tarilabs, how did you install podman?

Homebrew, as instructed here: https://podman.io/docs/installation#macos:~:text=to%20install%20Podman%3A-,brew%20install%20podman,-Next%2C%20create%20and

The thing is I would like to be sure to leverage Rosetta more than just plain qemu, especially for the DevContainer (per this doc shows). But maybe I misunderstood qemu on Mac...

DevContainer part aside; additionally, I was not able for Testcontainers for Go, to reckon Podman was installed, hence I needed to modify lines such as this one:

https://github.com/opendatahub-io/model-registry/blob/ee6455355f140e3843b56bd17e4185a4e7551b7a/internal/testutils/test_container_utils.go#L18

to specify explicitly podman to be used.
It's not an impossible task, but I needed to make sure each time not-to-commit that change, or to reperform the change locally each time I checkout a PR 😞

Always happy to hear if anyone get different experience (I'm on Apple-silicon Mac OSX)

[spolti]

For that line in specific, maybe not hardcode it?
Instead, use a env, and default to that value if the given env is not set :)

[tarilabs]

Instead, use a env, and default to that value if the given env is not set :)

that is clearly an option, but somehow according to Testcontainers that should not even be needed; unfortunately I didn't have bandwidth to look further into this, given using alternative docker-engine managers just worked

[spolti]

isn't better to use just make as stated in the comment? :)

[tarilabs]

you mean to adopt the caveat instructions per homebrew install log? :)
that is optional, so I want to keep it same options for our readers (personally I'm just using gmake)