Salt Extension for Andrisoft WANGuard

Manage Andrisoft WANGuard from Salt, through its REST API.

Provides:

• an execution module and a runner for reading and manipulating roles, users, IP zones, threshold templates, responses, whitelist templates, BGP connectors, servers, sensors, filters, decoders, anomalies and more, plus generic verbs and a query escape hatch for any endpoint without a dedicated wrapper;
• states for the configuration objects that make sense to manage declaratively, all supporting test=True.

salt '*' wanguard.list_roles
salt '*' wanguard.get_role role_name=Guest

Wanguard Guest role:
  wanguard.role_present:
    - name: Guest
    - description: Read-only access

Requires the wanrestapi package on the WANGuard Console and an account with REST API access enabled. See the User Documentation for setup.

Security

If you discover a security vulnerability, please refer to Salt's security guide.

User Documentation

For setup and usage instructions, please refer to the User Documentation.

Contributing

The saltext-wanguard project welcomes contributions from anyone!

The Salt Extensions guide provides comprehensive instructions on all aspects of Salt extension development, including writing tests, running tests, writing documentation and rendering the docs.

Quickstart

To get started contributing, first clone this repository (or your fork):

# Clone the repo
git clone --origin upstream git@gitlab.com:ggiesen/saltext-wanguard.git

# Change to the repo dir
cd saltext-wanguard

Automatic

If you have installed direnv, copying the included .envrc.example to .envrc and allowing it to run ensures a proper development environment is present and the virtual environment is active.

Without direnv, you can still run the automation explicitly:

make dev  # or python3 tools/initialize.py
source .venv/bin/activate

Manual

Please follow the first steps, skipping the repository initialization and first commit.

Ways to contribute

Contributions come in many forms, and they're all valuable! Here are some ways you can help without writing code:

• Documentation: Especially examples showing how to use this project to solve specific problems.
• Triaging issues: Help manage issues.

You can also contribute by:

• Writing blog posts
• Sharing your experiences using Salt + Andrisoft WANGuard on social media
• Giving talks at conferences
• Publishing videos
• Engaging in IRC, Discord or email groups

Any of these things are super valuable to our community, and we sincerely appreciate every contribution!