Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for MacOS local setup #454

Merged
merged 2 commits into from
Aug 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion docs/docs/how-tos/nebari-local.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The advantages of using kind are:
Nebari integrates kind under the hood by using its Terraform provider and a proper `local` deployment method, which grants native OS compatibility with Linux.

:::warning
Currently, Nebari does not support local mode on Windows and macOS.
Currently, Nebari does not support local mode on Windows.
:::

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

:::

### Exposing container network (for MacOS)

Docker for macOS does not expose container networks directly on the MacOS host, for this we will use
[docker-mac-net-connect](https://github.com/chipmk/docker-mac-net-connect), which lets you connect directly
to Docker-for-Mac containers via IP address. You can install and start it with following command:

```bash
# Install via Homebrew
$ brew install chipmk/tap/docker-mac-net-connect

# Run the service and register it to launch at boot
$ sudo brew services start chipmk/tap/docker-mac-net-connect
```

### Docker Images

You can skip this section if you have an x86_64 machine. If you're using Mac M1, then the x86_64 docker images
will not work out of the box. You would need to use images that are built with support for arm as well.

We're building all the docker images for both platforms except external images. The only external image relevant
here is keycloak. You'd need to update the keycloak image for the deployment, which can be done by adding the
override for the keycloak deployment to update the image:

```yaml
security:
keycloak:
initial_root_password: <SANITIZED>
overrides:
image:
repository: quay.io/nebari/keycloak
tag: sha-b4a2d1e
```

## Deploying Nebari

With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time with:
Expand Down
Loading