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

Changed legacy docker-compose in docs #733

Merged
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This tutorial will teach you how to run OPAL using the official docker images.
</li>
<li>
Get a working playground with <strong>one</strong>{" "}
<code>docker-compose</code> command.
<code>docker compose</code> command.
</li>
<li>
Want to <strong>learn</strong> about OPAL core features and see what
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/overview/scopes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions documentation/docs/tutorials/cedar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Loading