Skip to content

Commit 2656ab7

Browse files
authored
Merge pull request #454 from nebari-dev/mac-m1-local-deploy-docs
Add docs for MacOS local setup
2 parents abbd38e + 16fa986 commit 2656ab7

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

docs/docs/how-tos/nebari-local.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The advantages of using kind are:
3434
Nebari integrates kind under the hood by using its Terraform provider and a proper `local` deployment method, which grants native OS compatibility with Linux.
3535

3636
:::warning
37-
Currently, Nebari does not support local mode on Windows and macOS.
37+
Currently, Nebari does not support local mode on Windows.
3838
:::
3939

4040
To use kind, you will also need to install [docker engine](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository).
@@ -126,6 +126,39 @@ sudo echo "172.18.1.100 <domain>" | sudo tee -a /etc/hosts
126126

127127
:::
128128

129+
### Exposing container network (for MacOS)
130+
131+
Docker for macOS does not expose container networks directly on the MacOS host, for this we will use
132+
[docker-mac-net-connect](https://github.com/chipmk/docker-mac-net-connect), which lets you connect directly
133+
to Docker-for-Mac containers via IP address. You can install and start it with following command:
134+
135+
```bash
136+
# Install via Homebrew
137+
$ brew install chipmk/tap/docker-mac-net-connect
138+
139+
# Run the service and register it to launch at boot
140+
$ sudo brew services start chipmk/tap/docker-mac-net-connect
141+
```
142+
143+
### Docker Images
144+
145+
You can skip this section if you have an x86_64 machine. If you're using Mac M1, then the x86_64 docker images
146+
will not work out of the box. You would need to use images that are built with support for arm as well.
147+
148+
We're building all the docker images for both platforms except external images. The only external image relevant
149+
here is keycloak. You'd need to update the keycloak image for the deployment, which can be done by adding the
150+
override for the keycloak deployment to update the image:
151+
152+
```yaml
153+
security:
154+
keycloak:
155+
initial_root_password: <SANITIZED>
156+
overrides:
157+
image:
158+
repository: quay.io/nebari/keycloak
159+
tag: sha-b4a2d1e
160+
```
161+
129162
## Deploying Nebari
130163
131164
With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time with:

0 commit comments

Comments
 (0)