Skip to content

Commit a589ed3

Browse files
authored
Update docker compose commands to docker commands (#9227)
Signed-off-by: Fanit Kolchina <[email protected]>
1 parent 4c3ad11 commit a589ed3

File tree

13 files changed

+24
-26
lines changed

13 files changed

+24
-26
lines changed

_getting-started/quickstart.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ To quickly get started using OpenSearch and OpenSearch Dashboards, deploy your c
1414

1515
Before proceeding, you need to install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://github.com/docker/compose) on your local machine.
1616

17-
The Docker Compose commands used in this guide are written with a hyphen (for example, `docker-compose`). If you installed Docker Desktop on your machine, which automatically installs a bundled version of Docker Compose, then you should remove the hyphen. For example, change `docker-compose` to `docker compose`.
18-
{: .note}
1917

2018
## Starting your cluster
2119

@@ -72,14 +70,14 @@ You'll need a special file, called a Compose file, that Docker Compose uses to d
7270
1. In your terminal application, navigate to the directory containing the `docker-compose.yml` file you downloaded, [set up a custom admin password]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#setting-a-custom-admin-password), and run the following command to create and start the cluster as a background process:
7371
7472
```bash
75-
docker-compose up -d
73+
docker compose up -d
7674
```
7775
{% include copy.html %}
7876
79-
1. Confirm that the containers are running with the command `docker-compose ps`. You should see an output like the following:
77+
1. Confirm that the containers are running with the command `docker compose ps`. You should see an output like the following:
8078
8179
```bash
82-
$ docker-compose ps
80+
$ docker compose ps
8381
NAME COMMAND SERVICE STATUS PORTS
8482
opensearch-dashboards "./opensearch-dashbo…" opensearch-dashboards running 0.0.0.0:5601->5601/tcp
8583
opensearch-node1 "./opensearch-docker…" opensearch-node1 running 0.0.0.0:9200->9200/tcp, 9300/tcp, 0.0.0.0:9600->9600/tcp, 9650/tcp

_install-and-configure/install-dashboards/docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ You *can* start OpenSearch Dashboards using `docker run` after [creating a Docke
1919
Just like `opensearch.yml`, you can pass a custom `opensearch_dashboards.yml` to the container in the Docker Compose file.
2020
{: .tip }
2121

22-
1. Run `docker-compose up`.
22+
1. Run `docker compose up`.
2323

2424
Wait for the containers to start. Then see the [OpenSearch Dashboards documentation]({{site.url}}{{site.baseurl}}/dashboards/index/).
2525

26-
1. When finished, run `docker-compose down`.
26+
1. When finished, run `docker compose down`.

_install-and-configure/install-opensearch/docker.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ If none of those files exist in your current directory, the `docker-compose` com
161161
You can specify a custom file location and name when invoking `docker-compose` with the `-f` flag:
162162
```bash
163163
# Use a relative or absolute path to the file.
164-
docker-compose -f /path/to/your-file.yml up
164+
docker compose -f /path/to/your-file.yml up
165165
```
166166

167167
If this is your first time launching an OpenSearch cluster using Docker Compose, use the following example `docker-compose.yml` file. Save it in the home directory of your host and name it `docker-compose.yml`. This file creates a cluster that contains three containers: two containers running the OpenSearch service and a single container running OpenSearch Dashboards. These containers communicate over a bridge network called `opensearch-net` and use two volumes, one for each OpenSearch node. Because this file does not explicitly disable the demo security configuration, self-signed TLS certificates are installed and internal users with default names and passwords are created.
@@ -256,20 +256,20 @@ If you override `opensearch_dashboards.yml` settings using environment variables
256256

257257
From the home directory of your host (containing `docker-compose.yml`), create and start the containers in detached mode:
258258
```bash
259-
docker-compose up -d
259+
docker compose up -d
260260
```
261261
{% include copy.html %}
262262

263263
Verify that the service containers started correctly:
264264
```bash
265-
docker-compose ps
265+
docker compose ps
266266
```
267267
{% include copy.html %}
268268

269269
If a container failed to start, you can review the service logs:
270270
```bash
271-
# If you don't pass a service name, docker-compose will show you logs from all of the nodes
272-
docker-compose logs <serviceName>
271+
# If you don't pass a service name, docker compose will show you logs from all of the nodes
272+
docker compose logs <serviceName>
273273
```
274274
{% include copy.html %}
275275

@@ -280,11 +280,11 @@ Remember that `localhost` cannot be accessed remotely. If you are deploying thes
280280

281281
Stop the running containers in your cluster:
282282
```bash
283-
docker-compose down
283+
docker compose down
284284
```
285285
{% include copy.html %}
286286

287-
`docker-compose down` will stop the running containers, but it will not remove the Docker volumes that exist on the host. If you don't care about the contents of these volumes, use the `-v` option to delete all volumes, for example, `docker-compose down -v`.
287+
`docker compose down` will stop the running containers, but it will not remove the Docker volumes that exist on the host. If you don't care about the contents of these volumes, use the `-v` option to delete all volumes, for example, `docker compose down -v`.
288288
{: .tip}
289289
290290
## Configure OpenSearch
@@ -476,7 +476,7 @@ Use the same process to specify a [Backend configuration]({{site.url}}{{site.bas
476476

477477
After replacing the certificates and creating your own internal users, roles, mappings, action groups, and tenants, use Docker Compose to start the cluster:
478478
```bash
479-
docker-compose up -d
479+
docker compose up -d
480480
```
481481
{% include copy.html %}
482482

_observing-your-data/log-ingestion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Download or clone the [Data Prepper repository](https://github.com/opensearch-pr
3737
- A single-node OpenSearch cluster (`opensearch`)
3838
- OpenSearch Dashboards (`opensearch-dashboards`).
3939

40-
Close the file and run `docker-compose up --build` to start the containers.
40+
Close the file and run `docker compose up --build` to start the containers.
4141

4242
After the containers start, your ingestion pipeline is set up and ready to ingest log data. The `fluent-bit` container is configured to read log data from `test.log`. Run the following command to generate log data to send to the log ingestion pipeline.
4343

_observing-your-data/trace/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Download or clone the [Data Prepper repository](https://github.com/opensearch-pr
3838
- A single-node OpenSearch cluster (`opensearch`)
3939
- OpenSearch Dashboards (`opensearch-dashboards`).
4040

41-
Close the file and run `docker-compose up --build`. After the containers start, navigate to `http://localhost:8080` in a web browser.
41+
Close the file and run `docker compose up --build`. After the containers start, navigate to `http://localhost:8080` in a web browser.
4242

4343
![HotROD web interface]({{site.url}}{{site.baseurl}}/images/hot-rod.png)
4444

_search-plugins/cross-cluster-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ humanresources:
6161
6262
## Sample Docker setup
6363
64-
To define Docker permissions, save the following sample file as `docker-compose.yml` and run `docker-compose up` to start two single-node clusters on the same network:
64+
To define Docker permissions, save the following sample file as `docker-compose.yml` and run `docker compose up` to start two single-node clusters on the same network:
6565

6666
```yml
6767
version: '3'

_security/authentication-backends/ldap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ We provide a fully functional example that can help you understand how to use an
2121

2222
1. Download and unzip [the example zip file]({{site.url}}{{site.baseurl}}/assets/examples/ldap-example-v2.13.zip).
2323
1. Update the `.env` file with a strong password for `admin` user.
24-
1. At the command line, run `docker-compose up`.
24+
1. At the command line, run `docker compose up`.
2525
1. Review the files:
2626

2727
* `docker-compose.yml` defines a single OpenSearch node, an LDAP server, and a PHP administration tool for the LDAP server.

_security/authentication-backends/openid-connect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ The following steps use Docker and [Keycloak IdP](https://www.keycloak.org/) to
427427
- `new-realm.json` specifies the details of the [realm](https://www.keycloak.org/docs/latest/server_admin/#core-concepts-and-terms). In this example, the realm is named `new`.
428428
- `config.yml` configures `basic_internal_auth_domain` and `oidc_auth_domain`.
429429
- `opensearch_dashboards.yml` should point to Keycloak for authentication. Make sure that the `opensearch_security.openid.connect_url` setting points to the URL of the realm.
430-
5. At the command line, run `docker-compose up`.
430+
5. At the command line, run `docker compose up`.
431431
6. Access OpenSearch Dashboards at `http://localhost:5601` and log in with username `testuser` and password `testpassword` configured in the `new-realm.json` file.
432432

433433
After logging in, the `testuser` receives the backend role `admin` from Keycloak, which is mapped to the `all_access` OpenSearch role. These backend roles can be managed using the Keycloak Administrative Console at http://localhost:8080, using username `admin` and password `admin`.

_security/authentication-backends/saml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ We provide a fully functional example that can help you understand how to use SA
3838

3939
1. From the command line, run:
4040
```zsh
41-
$ docker-compose up.
41+
$ docker compose up.
4242
```
4343

4444
1. Access OpenSearch Dashboards at [http://localhost:5601](http://localhost:5601){:target='\_blank'}.

_security/configuration/demo-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Use the following steps to set up the Security plugin using Docker:
2929
2. Run the following command:
3030

3131
```bash
32-
docker-compose up
32+
docker compose up
3333
```
3434
{% include copy.html %}
3535

@@ -49,7 +49,7 @@ If you want to disable the Security plugin when using Docker, set the `DISABLE_S
4949
- One special character
5050

5151
4. Make sure that Docker is running on your local machine
52-
5. Run `docker-compose up` from the file directory where your `docker-compose.yml` file and `.env` file are located.
52+
5. Run `docker compose up` from the file directory where your `docker-compose.yml` file and `.env` file are located.
5353

5454
### TAR (Linux) and Mac OS
5555

0 commit comments

Comments
 (0)