Skip to content

Commit

Permalink
disclose metrics collection in readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
dwelch-spike committed Dec 10, 2024
1 parent e5648b2 commit 325450f
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ This is a companion repo for scripts and examples that are helpful to AVS users.
This repo contains scripts and configuration details for installing AVS.
For more information about AVS, see our [install documentation](https://aerospike.com/docs/vector/install). This repo contains the following:

**Note**
This repo contains examples that collects basic usage data about the product including network information. You can opt out of this by disabling Prometheus in any of the install instructions. For example, to disable metrics collection through docker compose, remove the prometheus service from the example docker compose file.

* [Kubernetes install script](./kubernetes) - A bash script and configuration details for [Installing on Kubernetes](https://aerospike.com/docs/vector/install/kubernetes).
* [Docker-compose files](./docker) - The `./docker` folder contains a docker-compose file for deploying Aerospike and AVS as containers. Additionally, each example app has a docker-compose file that deploys Aerospike, AVS, and the application itself.

Expand Down
4 changes: 4 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Locate valid `features.conf` in the `./config` directory:
> port 5002 in your docker compose file and aerospike-vector-search.yml file.
## Installation Aerospike and AVS Clusters (docker-compose)

**Note**
The docker compose in this folder collects basic AVS usage metrics including network information. To disable metrics collection, remove the prometheus service from the example docker compose file.

```shell
docker compose -f docker-compose.yaml up -d
```
Expand Down
4 changes: 4 additions & 0 deletions prism-image-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ description.


## Install using docker compose

**Note**
The docker compose in this folder collects basic AVS usage metrics including network information. To disable metrics collection, remove the prometheus service from the example docker compose file.

If you have a license key, you can easily setup Aerospike, AVS, and the prism-image-search
app using docker-compose. When using docker-compose, you'll need to place your images in `container-volumes/prism/images/static/data`

Expand Down
4 changes: 4 additions & 0 deletions quote-semantic-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ Navigate to http://127.0.0.1:8080/search and perform a search for quotes based o


## Install using docker compose

**Note**
The docker compose in this folder collects basic AVS usage metrics including network information. To disable metrics collection, remove the prometheus service from the example docker compose file.

If you have a license key, you can easily set up Aerospike, AVS, and the quote-semantic-search
app using docker-compose.

Expand Down

0 comments on commit 325450f

Please sign in to comment.