diff --git a/.github/workflows/test_conda_store.yaml b/.github/workflows/test_conda_store.yaml index 30d6988bd..67269811d 100644 --- a/.github/workflows/test_conda_store.yaml +++ b/.github/workflows/test_conda_store.yaml @@ -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 @@ -83,4 +83,4 @@ jobs: - name: "Get Docker logs 🔍" if: ${{ failure() }} run: | - docker-compose logs + docker compose logs diff --git a/.github/workflows/test_conda_store_server_integration.yaml b/.github/workflows/test_conda_store_server_integration.yaml index ea327ddbe..4edc6645d 100644 --- a/.github/workflows/test_conda_store_server_integration.yaml +++ b/.github/workflows/test_conda_store_server_integration.yaml @@ -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 @@ -94,4 +94,4 @@ jobs: - name: "Get Docker logs 🔍" if: ${{ failure() }} run: | - docker-compose logs + docker compose logs diff --git a/conda-store-server/Dockerfile b/conda-store-server/Dockerfile index 74f5cf8dc..ae5c6da9a 100644 --- a/conda-store-server/Dockerfile +++ b/conda-store-server/Dockerfile @@ -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 diff --git a/conda-store-server/environment-dev.yaml b/conda-store-server/environment-dev.yaml index 0ef1e428f..c28d1548e 100644 --- a/conda-store-server/environment-dev.yaml +++ b/conda-store-server/environment-dev.yaml @@ -19,7 +19,7 @@ dependencies: - pytest-celery - pytest-mock - docker-py<=7 - - docker-compose + - docker compose # build dependencies - hatch - build diff --git a/conda-store/Dockerfile b/conda-store/Dockerfile index abe89747e..3a807874e 100644 --- a/conda-store/Dockerfile +++ b/conda-store/Dockerfile @@ -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 diff --git a/docusaurus-docs/community/contribute/contribute-code.md b/docusaurus-docs/community/contribute/contribute-code.md index f881a23ed..28820abc3 100644 --- a/docusaurus-docs/community/contribute/contribute-code.md +++ b/docusaurus-docs/community/contribute/contribute-code.md @@ -24,7 +24,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-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 @@ -32,12 +32,12 @@ There are two main ways to set up your local environment for development: 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 @@ -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 | |----------|----------------|----------|----------| @@ -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 @@ -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 @@ -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: diff --git a/docusaurus-docs/community/contribute/testing.md b/docusaurus-docs/community/contribute/testing.md index 10596b735..c4cede077 100644 --- a/docusaurus-docs/community/contribute/testing.md +++ b/docusaurus-docs/community/contribute/testing.md @@ -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 . @@ -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 diff --git a/docusaurus-docs/conda-store-ui/how-tos/configure-ui.md b/docusaurus-docs/conda-store-ui/how-tos/configure-ui.md index 6de5011ec..5d1d71670 100644 --- a/docusaurus-docs/conda-store-ui/how-tos/configure-ui.md +++ b/docusaurus-docs/conda-store-ui/how-tos/configure-ui.md @@ -44,9 +44,9 @@ In your HTML file, add the following **before** loading the react app : ``` -## 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. diff --git a/docusaurus-docs/conda-store/how-tos/install-docker.md b/docusaurus-docs/conda-store/how-tos/install-docker.md index 6febce5c1..63c660c5e 100644 --- a/docusaurus-docs/conda-store/how-tos/install-docker.md +++ b/docusaurus-docs/conda-store/how-tos/install-docker.md @@ -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). diff --git a/docusaurus-docs/conda-store/references/database.md b/docusaurus-docs/conda-store/references/database.md index 0eb347fb0..a9f4d0a90 100644 --- a/docusaurus-docs/conda-store/references/database.md +++ b/docusaurus-docs/conda-store/references/database.md @@ -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