Skip to content

Commit

Permalink
Amend docs about macOS (#1135)
Browse files Browse the repository at this point in the history
* Amend docs about macOS

Remove misleading suggestion that it works on ARM

* update
  • Loading branch information
theosanderson authored Feb 26, 2024
1 parent a7a6228 commit b2076f6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,9 @@ Follow this guide <https://docs.github.com/en/packages/working-with-a-github-pac
1. Run `export CR_PAT=YOUR_TOKEN` (replace `YOUR_TOKEN` with the token)
1. Run `echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin` (Not sure what to put as username, just leaving it as `USERNAME` seemed to work)

### (ARM macOS only): Configure docker default architecture
### ARM macOS

If you are running on an ARM macOS machine, you need to configure docker to use the `linux/amd64` architecture by default to work with images pushed by others. To do this, run:

```bash
export DOCKER_DEFAULT_PLATFORM=linux/amd64
```
Unfortunately, local development on ARM macOS (M1 and M2 macs) is not currently possible as it requires images which are not built for ARM. You can develop in a GitHub codespace instead.

## Authorization

Expand Down
4 changes: 3 additions & 1 deletion kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,9 @@ eyXXXXXX%

This will return a base64 encoded string similar to the one you can see above that starts with `ey` that you can use as `--dockerconfigjson` argument. Make sure not to copy the trailing `%` character that is added by `zsh`.

### How to set up locally on ARM64 macOS (M1, M2, etc.)
### How to set up on ARM64 macOS (M1, M2, etc.)

**We recommend using GitHub Codespaces if you are using ARM64 macOS, as the approach below is too slow.**

Using Docker desktop as your container runtime won't work on ARM64 macOS. Instead, you will need to use `colima` to run an AMD64 VM which will host AMD64 docker containers.

Expand Down

0 comments on commit b2076f6

Please sign in to comment.