Skip to content

Commit dd8dfbe

Browse files
authored
Update sandbox README to point to the user guide. (AcademySoftwareFoundation#1009)
1 parent 87712fc commit dd8dfbe

File tree

1 file changed

+6
-21
lines changed

1 file changed

+6
-21
lines changed

sandbox/README.md

+6-21
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,16 @@
11
# OpenCue sandbox environment
22

3-
The sandbox environment provides a way to run a test OpenCue deployment. You
4-
can use the sandbox environment to run small tests or development work. The sandbox
5-
environment runs OpenCue components in separate Docker containers on your local
6-
machine.
3+
The sandbox environment provides a way to run a test OpenCue deployment. You can use the sandbox
4+
environment to run small tests or development work. The sandbox environment runs OpenCue components
5+
in separate Docker containers on your local machine.
76

87
To learn how to run the sandbox environment, see
98
https://www.opencue.io/docs/quick-starts/.
109

1110
## Monitoring
1211

13-
To get started with monitoring there is also an additional docker-compose which sets up
12+
To get started with monitoring there is also an additional Docker compose file which sets up
1413
monitoring for key services.
1514

16-
This can be started from the OpenCue root directory with:
17-
```bash
18-
docker-compose --project-directory . -f sandbox/docker-compose.yml -f sandbox/docker-compose.monitoring.yml up
19-
```
20-
21-
Spins up a monitoring stack
22-
23-
http://localhost:3000/
24-
25-
login: admin
26-
pass: admin
27-
28-
### Loki logging
29-
30-
Too use loki to store logs requires installing the docker drivers. see:
31-
https://grafana.com/docs/loki/latest/clients/docker-driver/
15+
To learn how to run the sandbox environment with monitoring,
16+
see https://www.opencue.io/docs/other-guides/monitoring-with-prometheus-loki-and-grafana/.

0 commit comments

Comments
 (0)