From 54bca38435e722bab1598c2822689b678f173fbf Mon Sep 17 00:00:00 2001 From: Dan Yishai Date: Mon, 13 Jan 2025 13:14:47 +0200 Subject: [PATCH] Changed legacy docker-compose in docs (#733) --- .../quickstart/opal-playground/overview.mdx | 2 +- .../opal-playground/run-server-and-client.mdx | 2 +- .../docs/getting-started/running-opal/overview.mdx | 2 +- documentation/docs/overview/scopes.md | 2 +- documentation/docs/tutorials/cedar.mdx | 10 +++++----- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/documentation/docs/getting-started/quickstart/opal-playground/overview.mdx b/documentation/docs/getting-started/quickstart/opal-playground/overview.mdx index 10f8d07ff..9874124dc 100644 --- a/documentation/docs/getting-started/quickstart/opal-playground/overview.mdx +++ b/documentation/docs/getting-started/quickstart/opal-playground/overview.mdx @@ -5,7 +5,7 @@ This tutorial will show you what you can do with **OPAL**, and teach you about * We built an example configuration that you can run in **docker compose**. The example was built specifically for you to **explore OPAL quickly**, understand the core features and see what OPAL can do for you. -You can get a running OPAL environment by running one `docker-compose` command. +You can get a running OPAL environment by running one `docker compose` command. Let's take OPAL for a swing! diff --git a/documentation/docs/getting-started/quickstart/opal-playground/run-server-and-client.mdx b/documentation/docs/getting-started/quickstart/opal-playground/run-server-and-client.mdx index 5b9b9c144..693a1f3cf 100644 --- a/documentation/docs/getting-started/quickstart/opal-playground/run-server-and-client.mdx +++ b/documentation/docs/getting-started/quickstart/opal-playground/run-server-and-client.mdx @@ -14,7 +14,7 @@ git clone https://github.com/permitio/opal.git cd opal -docker-compose -f docker/docker-compose-example.yml up +docker compose -f docker/docker-compose-example.yml up ``` The `docker-compose.yml` we just downloaded - [view the file here](https://github.com/permitio/opal/blob/master/docker/docker-compose-example.yml) - is **running 3 containers**: diff --git a/documentation/docs/getting-started/running-opal/overview.mdx b/documentation/docs/getting-started/running-opal/overview.mdx index 2719d8fa5..10b698613 100644 --- a/documentation/docs/getting-started/running-opal/overview.mdx +++ b/documentation/docs/getting-started/running-opal/overview.mdx @@ -31,7 +31,7 @@ This tutorial will teach you how to run OPAL using the official docker images.
  • Get a working playground with one{" "} - docker-compose command. + docker compose command.
  • Want to learn about OPAL core features and see what diff --git a/documentation/docs/overview/scopes.md b/documentation/docs/overview/scopes.md index 74af41dce..5ee53831d 100644 --- a/documentation/docs/overview/scopes.md +++ b/documentation/docs/overview/scopes.md @@ -17,7 +17,7 @@ API (`/scopes`) > #### Prerequisites > > Scopes are supported in OPAL 0.2.0 and above. Use the -> [provided docker-compose example](https://github.com/permitio/opal/blob/master/docker/docker-compose-scopes-example.yml) +> [provided docker compose example](https://github.com/permitio/opal/blob/master/docker/docker-compose-scopes-example.yml) > to quickly get started. > > The server must be started with the environment variable diff --git a/documentation/docs/tutorials/cedar.mdx b/documentation/docs/tutorials/cedar.mdx index c315e2fa2..c0d5cde74 100644 --- a/documentation/docs/tutorials/cedar.mdx +++ b/documentation/docs/tutorials/cedar.mdx @@ -8,11 +8,11 @@ Cedar agent is the easiest way to deploy and run Cedar. Check out our [demo app that uses Cedar-Agent and OPAL here](https://github.com/permitio/tinytodo). ::: -OPAL can run Cedar instead of OPA. To launch an example configuration with Docker-Compose, do: +OPAL can run Cedar instead of OPA. To launch an example configuration with Docker Compose, do: ``` git clone https://github.com/permitio/opal.git cd opal -docker-compose -f docker/docker-compose-example-cedar.yml up -d +docker compose -f docker/docker-compose-example-cedar.yml up -d ``` You'll then have Cedar's dev web interface at [http://localhost:8180/rapidoc/](http://localhost:8180/rapidoc/), where you can call Cedar-Agent's API routes. @@ -44,15 +44,15 @@ Then restore the correct policy: } ] ``` -Alternatively, you can also change the Docker-compose config and set your own policy git repo (the **OPAL_POLICY_REPO_URL** variable), and change it on the fly. +Alternatively, you can also change the Docker compose config and set your own policy git repo (the **OPAL_POLICY_REPO_URL** variable), and change it on the fly. If you want to see OPAL's logs, you can do: ``` -docker-compose -f docker/docker-compose-example-cedar.yml logs opal_server +docker compose -f docker/docker-compose-example-cedar.yml logs opal_server ``` and ``` -docker-compose -f docker/docker-compose-example-cedar.yml logs opal_client +docker compose -f docker/docker-compose-example-cedar.yml logs opal_client ``` For the server and client, respectively.