mirror of
https://github.com/akvorado/akvorado.git
synced 2025-12-11 22:14:02 +01:00
docs: mention "docker compose" instead of "docker-compose"
The later has been deprecated.
This commit is contained in:
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@@ -259,7 +259,7 @@ jobs:
|
||||
with:
|
||||
name: binary
|
||||
|
||||
# Build tarball for docker-compose
|
||||
# Build tarball for docker compose
|
||||
- name: Build docker-compose "quick start"
|
||||
run: |
|
||||
sed -i s,akvorado:latest,akvorado:${GITHUB_REF_NAME#v}, docker-compose*.yml
|
||||
|
||||
@@ -14,7 +14,7 @@ and is licensed under the [AGPLv3 license](LICENSE.txt).
|
||||
|
||||
A demo site using fake data and running the latest stable version is
|
||||
available on [demo.akvorado.net](https://demo.akvorado.net). It is the
|
||||
direct result of running `docker-compose up` on a fresh checkout but
|
||||
direct result of running `docker compose up` on a fresh checkout but
|
||||
port 2055 is not accessible (you cannot send you own flows). Please,
|
||||
be gentle with this resource. The demo site also enables you to browse
|
||||
the [documentation](https://demo.akvorado.net/docs) (which is also
|
||||
|
||||
@@ -20,7 +20,7 @@ import (
|
||||
// as a named service or on a specific port on localhost. This applies
|
||||
// for example for Kafka and ClickHouse. The timeouts are quite short,
|
||||
// but we suppose that either the services are run through
|
||||
// docker-compose manually and ready, either through CI and they are
|
||||
// docker compose manually and ready, either through CI and they are
|
||||
// checked for readiness.
|
||||
func CheckExternalService(t *testing.T, name string, dnsCandidates []string, port string) string {
|
||||
t.Helper()
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
# This configuration file is documented in docs/02-configuration.md.
|
||||
# You can get all default values with `akvorado orchestrator /dev/null
|
||||
# --dump --check` or `docker-compose run akvorado-orchestrator
|
||||
# --dump --check` or `docker compose run akvorado-orchestrator
|
||||
# orchestrator /dev/null --dump --check`.
|
||||
|
||||
kafka:
|
||||
|
||||
@@ -13,15 +13,15 @@ ClickHouse. It also exposes a web interface to browse the result.
|
||||
|
||||
The easiest way to get started is with
|
||||
[Docker](https://docs.docker.com/get-docker) and [Docker
|
||||
Compose](https://docs.docker.com/compose/install/). Depending on your
|
||||
version of *Docker Compose*, you may need to use `docker-compose` or
|
||||
`docker compose`.
|
||||
Compose](https://docs.docker.com/compose/install/). Depending on your version of
|
||||
*Docker Compose*, you may need to use `docker-compose` instead of `docker
|
||||
compose`.
|
||||
|
||||
```console
|
||||
# mkdir akvorado
|
||||
# cd akvorado
|
||||
# curl -sL https://github.com/akvorado/akvorado/releases/latest/download/docker-compose-quickstart.tar.gz | tar zxvf -
|
||||
# docker-compose up -d
|
||||
# docker compose up -d
|
||||
```
|
||||
|
||||
Once running, *Akvorado* web interface should be running on port 8081. A few
|
||||
@@ -29,7 +29,7 @@ synthetic flows are generated in the background. To disable them:
|
||||
|
||||
1. Remove `:docker-compose-demo.yml` from `.env`,
|
||||
2. Comment the last line of `akvorado.yaml`, and
|
||||
3. Run `docker-compose up -d --remove-orphans`.
|
||||
3. Run `docker compose up -d --remove-orphans`.
|
||||
|
||||
If you want to send you own flows, the inlet is accepting both NetFlow
|
||||
(port 2055) and sFlow (port 6343). You should also customize some
|
||||
@@ -48,11 +48,11 @@ documentation.
|
||||
which is used by default by the web interface)
|
||||
|
||||
You can get all the expanded configuration (with default values) with
|
||||
`docker-compose exec akvorado-orchestrator akvorado orchestrator
|
||||
`docker compose exec akvorado-orchestrator akvorado orchestrator
|
||||
--check --dump /etc/akvorado/akvorado.yaml`.
|
||||
|
||||
Once you are ready, you can run everything in the background with
|
||||
`docker-compose up -d`.
|
||||
`docker compose up -d`.
|
||||
|
||||
## Big picture
|
||||
|
||||
|
||||
@@ -18,9 +18,9 @@ You can get *Akvorado* as a
|
||||
```
|
||||
|
||||
Check the `docker-compose.yml` file for an example on how to deploy *Akvorado*
|
||||
using containers. If you want to use `docker-compose`, have a look at the [quick
|
||||
using containers. If you want to use `docker compose`, have a look at the [quick
|
||||
start procedure](00-intro.md#quick-start). This documentation assumes you are
|
||||
running the `docker-compose` setup.
|
||||
running the `docker compose` setup.
|
||||
|
||||
If you want to compile the Docker image yourself, you can use `docker build -t
|
||||
akvorado:latest .`. Then, in `docker-compose.yml`, replace
|
||||
@@ -96,17 +96,17 @@ Be sure to read the [changelog](99-changelog.md) before attempting an upgrade.
|
||||
Upgrade the orchestrator first. This will update the ClickHouse database if
|
||||
needed. Then, upgrade all inlets. Then the console.
|
||||
|
||||
When using `docker-compose`, use the following commands to fetch an updated
|
||||
When using `docker compose`, use the following commands to fetch an updated
|
||||
`docker-compose.yml` file and update your installation.
|
||||
|
||||
```console
|
||||
# cd akvorado
|
||||
# curl -sL https://github.com/akvorado/akvorado/releases/latest/download/docker-compose-quickstart.tar.gz | tar zxvf - docker-compose.yml
|
||||
# docker-compose pull
|
||||
# docker-compose stop akvorado-orchestrator
|
||||
# docker-compose up -d
|
||||
# docker compose pull
|
||||
# docker compose stop akvorado-orchestrator
|
||||
# docker compose up -d
|
||||
```
|
||||
|
||||
Note that if Zookeeper or Kakfa gets upgraded in the process, this can be
|
||||
disruptive. Feel free to only use `docker-compose pull akvorado-orchestrator` to
|
||||
disruptive. Feel free to only use `docker compose pull akvorado-orchestrator` to
|
||||
only update Akvorado image.
|
||||
|
||||
@@ -386,7 +386,7 @@ snmp-server vrf VRF-MANAGEMENT
|
||||
|
||||
## Kafka
|
||||
|
||||
When using `docker-compose`, there is a Kafka UI running at
|
||||
When using `docker compose`, there is a Kafka UI running at
|
||||
`http://127.0.0.1:8080/kafka-ui/`. It provides various operational
|
||||
metrics you can check, notably the space used by each topic.
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ $ curl -s http://akvorado/api/v0/inlet/flows\?limit=1
|
||||
```
|
||||
|
||||
Be sure to replace `http://akvorado` with the URL to your *Akvorado*
|
||||
setup. If you are running `docker-compose` locally, this is
|
||||
setup. If you are running `docker compose` locally, this is
|
||||
`http://127.0.0.1:8080`.
|
||||
|
||||
This returns the next flow. The same information is exported to Kafka.
|
||||
@@ -292,7 +292,7 @@ Metadata for flows-ZUYGDTE3EBIXX352XPM3YEEFV4 (from broker -1: kafka:9092/bootst
|
||||
$ kcat -b kafka:9092 -C -t flows-ZUYGDTE3EBIXX352XPM3YEEFV4 -f 'Topic %t [%p] at offset %o: key %k: %T\n' -o -1
|
||||
```
|
||||
|
||||
Alternatively, when using `docker-compose`, there is a Kafka UI
|
||||
Alternatively, when using `docker compose`, there is a Kafka UI
|
||||
running at `http://127.0.0.1:8080/kafka-ui/`. You can do the following
|
||||
checks:
|
||||
|
||||
@@ -303,8 +303,8 @@ checks:
|
||||
## ClickHouse
|
||||
|
||||
First, check that all the tables are present using the following SQL
|
||||
query through `clickhouse client` (when running with `docker-compose`,
|
||||
you can use `docker-compose exec clickhouse clickhouse-client`) :
|
||||
query through `clickhouse client` (when running with `docker compose`,
|
||||
you can use `docker compose exec clickhouse clickhouse-client`) :
|
||||
|
||||
```sql
|
||||
SHOW tables
|
||||
@@ -365,7 +365,7 @@ FORMAT Vertical
|
||||
|
||||
Notably, it may complain about a missing schema for a received
|
||||
message. In this case, you need to ensure the schemas used by
|
||||
*Akvorado* are available. When using `docker-compose`, you can restart
|
||||
*Akvorado* are available. When using `docker compose`, you can restart
|
||||
the orchestrator and ClickHouse to ensure it downloads the latest
|
||||
schemas. Otherwise, you can manually execute the script installing the
|
||||
schemas on your ClickHouse server and restart:
|
||||
|
||||
Reference in New Issue
Block a user