Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust doc #571

Merged
merged 1 commit into from
Feb 12, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 1 addition & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,7 @@ Swagger UI is available at [trento-project.io/wanda/swaggerui](https://trento-pr

# Developing Checks

Wanda architecture aims to simplify [testing Checks Executions](#testing-executions) and [adding new ones](#adding-new-checks).

## Infrastructure

For development purposes, a [docker-compose file](https://github.com/trento-project/wanda/blob/main/docker-compose.yaml) is provided.
The [docker-compose.checks.yaml](https://github.com/trento-project/wanda/blob/main/docker-compose.checks.yaml) provides additional configuration to start an environment for Checks development.

### Starting a local environment

Start the environment with:

```bash
$ docker-compose -f docker-compose.checks.yaml up -d
```

Wanda is exposed on port `4000` and the API documentation is available at http://localhost:4000/swaggerui

**Note** that the [message broker](https://www.rabbitmq.com/) **must** be reachable by Wanda and all the targets.
Please refer to [Trento Checks](https://github.com/trento-project/checks) and [testing Checks Executions](#testing-executions).

## Testing Executions

Expand Down Expand Up @@ -225,16 +208,6 @@ Which would return the next where the `Value` is the available value in the writ
}
```

## Adding new Checks

Built-in Checks can be found in the Catalog directory at `./priv/catalog/`

To implement new checks and test them:

- write a new [Check Specification](./guides/specification.md) file
- locate the newly created Check in the Catalog directory `./priv/catalog/`
- test the execution as [previously described](#testing-executions)

# Running a local Wanda instance

## Running a Development Environment
Expand Down