Skip to content

Commit

Permalink
Remove Docker compose v1 references
Browse files Browse the repository at this point in the history
  • Loading branch information
trallard committed Aug 9, 2024
1 parent de01dc2 commit 85d7885
Show file tree
Hide file tree
Showing 10 changed files with 29 additions and 29 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/test_conda_store.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ jobs:
run: |
hatch env run -e lint lint
- name: "Deploy docker-compose 🏗️"
- name: "Deploy docker compose 🏗️"
run: |
docker-compose up -d
docker compose up -d
docker ps
wait-for-it localhost:5432 # postgresql
Expand All @@ -83,4 +83,4 @@ jobs:
- name: "Get Docker logs 🔍"
if: ${{ failure() }}
run: |
docker-compose logs
docker compose logs
6 changes: 3 additions & 3 deletions .github/workflows/test_conda_store_server_integration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ jobs:
# install conda-store-server
python -m pip install .
- name: "Deploy docker-compose 🏗️"
- name: "Deploy docker compose 🏗️"
run: |
docker-compose up -d
docker compose up -d
docker ps
wait-for-it localhost:5432 # postgresql
Expand Down Expand Up @@ -94,4 +94,4 @@ jobs:
- name: "Get Docker logs 🔍"
if: ${{ failure() }}
run: |
docker-compose logs
docker compose logs
2 changes: 1 addition & 1 deletion conda-store-server/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# conda-store-server Dockerfile
# the generated Docker image is used with docker-compose to run the conda-store
# the generated Docker image is used with docker compose to run the conda-store
# server and public conda-store Docker images

FROM condaforge/miniforge3:24.3.0-0 AS base
Expand Down
2 changes: 1 addition & 1 deletion conda-store-server/environment-dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ dependencies:
- pytest-celery
- pytest-mock
- docker-py<=7
- docker-compose
- docker compose
# build dependencies
- hatch
- build
Expand Down
2 changes: 1 addition & 1 deletion conda-store/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# conda-store (core) Dockerfile
# the generated Docker image is used with docker-compose to run the conda-store
# the generated Docker image is used with docker compose to run the conda-store
# worker and public conda-store Docker images

FROM condaforge/miniforge3:24.3.0-0 AS base
Expand Down
24 changes: 12 additions & 12 deletions docusaurus-docs/community/contribute/contribute-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ If you are a first-time contributor:
Once you have a local copy of the `conda-store` repository, you can set up your development environment.
There are two main ways to set up your local environment for development:

- Using [Docker and docker-compose(recommended)](#docker-based-development---conda-store-core)
- Using [Docker and Docker compose(recommended)](#docker-based-development---conda-store-core)
- Local development [without Docker](#local-development-without-docker---conda-store-core)

### Docker-based development - conda-store-core

Install the following dependencies before developing on `conda-store`.

- [Docker](https://docs.docker.com/engine/install/)
- [docker-compose](https://docs.docker.com/compose/install/)
- [Docker compose](https://docs.docker.com/compose/install/)

To deploy `conda-store` run the following command:

```bash
docker-compose up --build -d
docker compose up --build -d
```

:::important
Expand All @@ -48,7 +48,7 @@ Otherwise, this workflow has been shown to run and build on OSX.
**Notice** the `architecture: amd64` within the `docker-compose.yaml` files.
:::

After running the `docker-compose` command, the following resources will be available:
After running the `docker compose` command, the following resources will be available:

| Resource | Localhost port | username | password |
|----------|----------------|----------|----------|
Expand All @@ -65,17 +65,17 @@ If you are making any changes to `conda-store-server` and would like to see
those changes in the deployment, run:

```shell
docker-compose down -v # not always necessary
docker-compose up --build
docker compose down -v # not always necessary
docker compose up --build
```

To stop the deployment, run:

```bash
docker-compose stop
docker compose stop

# optional to remove the containers
docker-compose rm -f
docker compose rm -f
```

### Local development without Docker - conda-store-core
Expand Down Expand Up @@ -125,7 +125,7 @@ If you are a first-time contributor:
Once you have a local copy of the `conda-store` repository, you can set up your development environment.
There are two main ways to set up your local environment for development:

- Using [Docker and docker-compose(recommended)](#docker-based-development---conda-store-ui)
- Using [Docker and Docker compose(recommended)](#docker-based-development---conda-store-ui)
- Local development [without Docker](#local-development-without-docker---conda-store-ui)

### Pre-requisites
Expand All @@ -137,9 +137,9 @@ There are two main ways to set up your local environment for development:

Running conda-store-ui in Docker is the simplest way to set up your local development environment.

We use [docker-compose](https://docs.docker.com/compose/) to set up the infrastructure before starting,
you must ensure you have docker-compose installed.
If you need to install docker-compose, please see their [installation documentation](https://docs.docker.com/compose/install/).
We use [Docker compose](https://docs.docker.com/compose/) to set up the infrastructure before starting,
you must ensure you have Docker compose installed.
If you need to install Docker compose, please see their [installation documentation](https://docs.docker.com/compose/install/).

1. After cloning the repository change to the project directory:

Expand Down
8 changes: 4 additions & 4 deletions docusaurus-docs/community/contribute/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ docker.

```shell
$ cd conda-store
$ docker-compose down -v # ensure you've cleared state
$ docker-compose up --build
$ docker compose down -v # ensure you've cleared state
$ docker compose up --build
# wait until the conda-store-server is running check by visiting localhost:8080

$ pip install -e .
Expand Down Expand Up @@ -66,8 +66,8 @@ docker.

```shell
$ cd conda-store-server
$ docker-compose down -v # ensure you've cleared state
$ docker-compose up --build
$ docker compose down -v # ensure you've cleared state
$ docker compose up --build
# wait until the conda-store-server is running check by visiting localhos:8080
$ hatch env run -e dev playwright-test
$ hatch env run -e dev integration-test
Expand Down
4 changes: 2 additions & 2 deletions docusaurus-docs/conda-store-ui/how-tos/configure-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ In your HTML file, add the following **before** loading the react app :
</script>
```

## Docker-compose configuration
## Docker compose configuration

By default, docker-compose uses the latest release of conda-store-server, but there could be cases where a devloper wishes to test against a different versions, such as a release candidate.
By default, Docker compose uses the latest release of conda-store-server, but there could be cases where a devloper wishes to test against a different versions, such as a release candidate.

Adding the `CONDA_STORE_SERVER_VERSION` variable to the `.env` file will allow overriding this default and setting whichever version of conda-store-server is desired.

Expand Down
2 changes: 1 addition & 1 deletion docusaurus-docs/conda-store/how-tos/install-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To install on a local docker daemon there is an existing `docker-compose.yaml` f
The example files required are in `examples/docker`:

```shell
docker-compose up --build
docker compose up --build
```

On your web browser, visit: [https://conda-store.localhost/conda-store](https://conda-store.localhost/conda-store).
Expand Down
2 changes: 1 addition & 1 deletion docusaurus-docs/conda-store/references/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The procedure to modify the database is the following :
- First, modify [the ORM Model](https://github.com/conda-incubator/conda-store/blob/main/conda-store-server/conda_store_server/orm.py) according to the changes you want to make
- edit the file `conda-store-server/alembic.ini` and replace the value for entry `sqlalchemy.url` to match the connection URL of your database.

For example (when postgres was started via docker-compose):
For example (when postgres was started via Docker compose):
```
script_location = alembic
sqlalchemy.url = postgresql+psycopg2://postgres:password@localhost:5432/conda-store
Expand Down

0 comments on commit 85d7885

Please sign in to comment.