This is an automated email from the ASF dual-hosted git repository.
asorokoumov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/otava-website.git
The following commit(s) were added to refs/heads/master by this push:
new 263dcce Update install instructions
263dcce is described below
commit 263dcce31b7e4a31548f55dc41775a3a1c1bb0bb
Author: Alex Sorokoumov <[email protected]>
AuthorDate: Sat Jan 31 11:47:19 2026 -0800
Update install instructions
---
docs/csv.md | 2 +-
docs/getting-started.md | 10 +++++++---
docs/grafana.md | 4 ++--
docs/graphite.md | 4 ++--
docs/install.md | 12 +++++-------
docs/postgresql.md | 2 +-
6 files changed, 18 insertions(+), 16 deletions(-)
diff --git a/docs/csv.md b/docs/csv.md
index 1e23d11..c3716a2 100644
--- a/docs/csv.md
+++ b/docs/csv.md
@@ -22,7 +22,7 @@ tests:
## Example
```bash
-docker-compose -f examples/csv/docker-compose.yaml run --build otava bin/otava
analyze local.sample
+docker-compose -f examples/csv/docker-compose.yaml run --rm otava analyze
local.sample
```
Expected output:
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 2ed7035..eabc5c5 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -4,12 +4,16 @@
Otava requires Python 3.8. If you don't have Python 3.8, use pyenv to install
it.
-Use pipx to install otava:
-
-```
+```bash
pip install apache-otava
```
+or
+
+```bash
+docker pull apache/otava
+```
+
## Setup
Copy the main configuration file `resources/otava.yaml` to
`~/.otava/otava.yaml` and adjust data source configuration.
diff --git a/docs/grafana.md b/docs/grafana.md
index f48f167..e57e101 100644
--- a/docs/grafana.md
+++ b/docs/grafana.md
@@ -36,14 +36,14 @@ See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/graphite/c
Start docker-compose with Graphite in one tab:
```bash
-docker-compose -f examples/graphite/docker-compose.yaml up --force-recreate
--always-recreate-deps --renew-anon-volumes --build
+docker-compose -f examples/graphite/docker-compose.yaml up --force-recreate
--always-recreate-deps --renew-anon-volumes
````
Run otava in another tab:
```bash
-docker-compose -f examples/graphite/docker-compose.yaml run otava otava
analyze my-product.test --since=-10m --update-grafana
+docker-compose -f examples/graphite/docker-compose.yaml run --rm otava analyze
my-product.test --since=-10m --update-grafana
```
Expected output:
diff --git a/docs/graphite.md b/docs/graphite.md
index 51937cd..272f3fa 100644
--- a/docs/graphite.md
+++ b/docs/graphite.md
@@ -81,13 +81,13 @@ filter data by commit or version using `--since-commit` or
`--since-version` sel
Start docker-compose with Graphite in one tab:
```bash
-docker-compose -f examples/graphite/docker-compose.yaml up --force-recreate
--always-recreate-deps --renew-anon-volumes --build
+docker-compose -f examples/graphite/docker-compose.yaml up --force-recreate
--always-recreate-deps --renew-anon-volumes
````
Run otava in another tab:
```bash
-docker-compose -f examples/graphite/docker-compose.yaml run otava otava
analyze my-product.test --since=-10m
+docker-compose -f examples/graphite/docker-compose.yaml run --rm otava analyze
my-product.test --since=-10m
```
Expected output:
diff --git a/docs/install.md b/docs/install.md
index 0fb77f3..c68a7c5 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -1,19 +1,17 @@
# Installation
-## Install using pipx
+## Install using pip
Otava requires Python 3.8. If you don't have python 3.8, use pyenv to install
it.
-Use pip to install otava:
-
-```
+```bash
pip install apache-otava
```
-## Build Docker container
+## Install using Docker
-To build the Docker container, run the following command:
+Pull the official Docker image:
```bash
-docker build -t otava .
+docker pull apache/otava
```
diff --git a/docs/postgresql.md b/docs/postgresql.md
index 88d2138..3ba2ac9 100644
--- a/docs/postgresql.md
+++ b/docs/postgresql.md
@@ -81,7 +81,7 @@ docker-compose -f examples/postgresql/docker-compose.yaml up
--force-recreate --
Run Otava in the other tab to show results for a single test `aggregate_mem`
and update the database with newly found change points:
```bash
-docker-compose -f examples/postgresql/docker-compose.yaml run --build otava
bin/otava analyze aggregate_mem --update-postgres
+docker-compose -f examples/postgresql/docker-compose.yaml run --rm otava
analyze aggregate_mem --update-postgres
```
Expected output:
