Skip to content

Commit

Permalink
Merge pull request #288 from levoai/satellite-docker
Browse files Browse the repository at this point in the history
Upgrade satellite docker instructions.
  • Loading branch information
gannaraputeja authored Nov 18, 2024
2 parents 52afbd1 + 090c376 commit 2f4e4ce
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions docs/install-satellite/satellite-docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,13 @@ Please proceed to [install traffic capture sensors](/install-traffic-capture-sen

## Satellite Lifecycle Management


### Upgrade the Satellite
1. Navigate to directory where you have the Docker Compose file.
2. [Reinstall](#2-install-satellite) the Satellite. The install always *pulls* the latest Docker images for the Satellite.

> **Note**: If the re-installation fails, please [Uninstall](#uninstall-the-satellite) the Satellite and then reinstall.

### Uninstall the Satellite

Ensure you are in the same directory where you downloaded the <DownloadDockerComposeLink/>.
Expand All @@ -106,22 +113,6 @@ Execute the below command:
docker compose down --remove-orphans -v
```

### Upgrade the Satellite
1. [Uninstall](#uninstall-the-satellite) the Satellite
2. [Reinstall](#2-install-satellite) the Satellite. The install always *pulls* the latest Docker images for the Satellite.


### Change the `minimum number of URLs` that the satellite needs to observe to detect an API endpoint.
To detect an API endpoint, Satellite waits for at least '10' URLs to match that endpoint URL pattern.
This number may cause delays in detecting API endpoints when there is not enough load.

If you want to change this number to suit your environment:
- export the environment variable `LEVOAI_MIN_URLS_PER_PATTERN` - for example :
`export LEVOAI_MIN_URLS_PER_PATTERN=3`

- Reinstall the Satellite to pickup the new configuration


### List Satellite's containers
```bash
docker ps | grep -E 'levoai/collector|bitnami/rabbitmq|levoai/satellite|levoai/tagger'
Expand All @@ -142,6 +133,19 @@ docker logs -f <container id>
docker logs <container id> --since 1m
```

----

## Configuration

### Change the `minimum number of URLs` that the satellite needs to observe to detect an API endpoint.
To detect an API endpoint, Satellite waits for at least '10' URLs to match that endpoint URL pattern.
This number may cause delays in detecting API endpoints when there is not enough load.

If you want to change this number to suit your environment:
- Export the environment variable `LEVOAI_MIN_URLS_PER_PATTERN` - for example : `export LEVOAI_MIN_URLS_PER_PATTERN=3`

- Reinstall the Satellite to pickup the new configuration

------------------------------------------------------------------

### Troubleshooting
Expand Down

0 comments on commit 2f4e4ce

Please sign in to comment.