Skip to content

Commit

Permalink
docs: Note on Docker images for Apple Silicon
Browse files Browse the repository at this point in the history
  • Loading branch information
igorlukanin committed Jul 16, 2024
1 parent 3632180 commit 1161716
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ Finally, add a `docker-compose.yml` file alongside the `cube.js` configuration
file:

```yaml
version: "2.2"

services:
cube:
image: cubejs/cube:latest
Expand Down
2 changes: 0 additions & 2 deletions docs/pages/product/apis-integrations/sql-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,6 @@ port 15432, accessible using `user` as the user name, `password` as the password
and any string as the database name:

```yaml filename="docker-compose.yml"
version: "2.2"

services:
cube:
image: cubejs/cube:latest
Expand Down
4 changes: 0 additions & 4 deletions docs/pages/product/caching/running-in-production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ where Cube Store is running.
You can also use Docker Compose to achieve the same:

```yaml
version: "2.2"
services:
cubestore:
image: cubejs/cubestore:latest
Expand Down Expand Up @@ -154,7 +153,6 @@ A sample Docker Compose stack for the single machine setting this up might look
like:

```yaml
version: "2.2"
services:
cubestore_router:
restart: always
Expand Down Expand Up @@ -247,8 +245,6 @@ data corruption errors.
A simplified example using AWS S3 might look like:

```yaml
version: "2.2"
services:
cubestore_router:
image: cubejs/cubestore:latest
Expand Down
2 changes: 0 additions & 2 deletions docs/pages/product/configuration/data-sources/questdb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ their [Slack][questdb-slack].
Create a dockerfile within the project directory:

```yaml title=docker-compose.yml
version: "2.2"

services:
cube:
environment:
Expand Down
3 changes: 0 additions & 3 deletions docs/pages/product/deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,6 @@ concurrency as you require.
A sample Docker Compose stack setting Cube Store cluster up might look like:

```yaml
version: "2.2"

services:
cubestore_router:
image: cubejs/cubestore:latest
Expand Down Expand Up @@ -220,7 +218,6 @@ cluster run on a single machine.
A simplified example using AWS S3 might look like:
```yaml
version: "2.2"
services:
cubestore_router:
image: cubejs/cubestore:latest
Expand Down
16 changes: 9 additions & 7 deletions docs/pages/product/deployment/core.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,27 @@ An example stack using BigQuery as a data source is provided below:

<InfoBox>

Using macOS or Windows? Use `CUBEJS_DB_HOST=host.docker.internal` instead of
**Using macOS or Windows?** Use `CUBEJS_DB_HOST=host.docker.internal` instead of
`localhost` if your database is on the same machine.

</InfoBox>

<InfoBox>

**Using macOS on Apple Silicon (arm64)?** Use the `arm64v8` tag for Cube Store
[Docker images](https://hub.docker.com/r/cubejs/cubestore/tags?page=&page_size=&ordering=&name=arm64v8),
e.g., `cubejs/cubestore:arm64v8`.

</InfoBox>

<InfoBox>

Note that it's a best practice to use specific locked versions, e.g.,
`cubejs/cube:v0.34.56`, instead of `cubejs/cube:latest` in production.

</InfoBox>

```yaml
version: "2.2"

services:
cube_api:
restart: always
Expand Down Expand Up @@ -276,8 +282,6 @@ Docker Hub][link-cubejs-docker]. Then update your `docker-compose.yml` to use
a specific tag instead of `latest`:

```yaml
version: "2.2"

services:
cube_api:
image: cubejs/cube:v0.34.56
Expand Down Expand Up @@ -342,8 +346,6 @@ docker build -t <YOUR-USERNAME>/cube-custom-image .
Finally, update your `docker-compose.yml` to use your newly-built image:

```yaml
version: "2.2"

services:
cube_api:
image: <YOUR-USERNAME>/cube-custom-image
Expand Down
2 changes: 0 additions & 2 deletions docs/pages/product/getting-started/core/create-a-project.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ touch docker-compose.yml
Open the `docker-compose.yml` file and add the following content:

```yaml
version: "2.2"

services:
cube:
image: cubejs/cube:latest
Expand Down

0 comments on commit 1161716

Please sign in to comment.