Skip to main content

Basic WebUI for using Ansible

Project description

Basic WebUI for using Ansible

Buy me a coffee

Documentation Lint Test

DISCLAIMER: This is an unofficial community project! Do not confuse it with the vanilla Ansible product!

The goal is to allow users to quickly install & run a WebUI for using Ansible locally.

Keep it simple.


Setup

Local - PIP

Requires Python >=3.10

# install
python3 -m pip install ansibleguy-webui

# run
python3 -m ansibleguy-webui

Docker

Images: webui, webui-unprivileged, webui-aws

docker image pull ansible0guy/webui:latest
docker run -d --name ansible-webui --publish 127.0.0.1:8000:8000 ansible0guy/webui:latest

# or with persistent data (volumes: /data = storage for logs & DB, /play = ansible playbook base-directory)
docker run -d --name ansible-webui --publish 127.0.0.1:8000:8000 --volume $(pwd)/ansible/data:/data --volume $(pwd)/ansible/play:/play ansible0guy/webui:latest

Demo

Check out the demo at: demo.webui.ansibleguy.net

Login: User demo, Password Ansible1337


Usage

Documentation


Contribute

Feel free to contribute to this project using pull-requests, issues and discussions!

Testers are also very welcome! Please give feedback

See also: Contributing


Roadmap

  • Ansible Config

    • Static Playbook-Directory

    • Git Repository support

  • Users

  • Jobs

    • Execute Ansible using ansible-runner

    • Job Logging

      • Write job metadata to database

      • Write full job-logs to Filesystem

    • Secret handling (Connect, Become, Vault)

      • User-specific job credentials
    • Alerting on Failure

      • E-Mail

      • Support for external Plugins (simple Interface for Scripts)

  • WebUI

    • Job Dashboard

      Status, Execute, Time of last & next execution, Last run User, Links to Warnings/Errors

    • Job Output

      Follow the jobs output in realtime

    • Job Errors

      UI that allows for easy error analysis. Access to logs and provide links to possible solutions

    • Show Ansible Running-Config

    • Show Ansible Collections

      • Check Collections for available updates (Galaxy + GitHub releases)
    • Mobile Support

    • Multi-Language Support

  • API

    • Manage and execute Jobs
  • Database

    • Support for MySQL
  • Testing

    • Unit Tests

    • Integration Tests

      • Basic WebUI checks

      • API Endpoints

      • Permission system

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansibleguy_webui-0.0.23.post3.tar.gz (236.6 kB view details)

Uploaded Source

Built Distribution

ansibleguy_webui-0.0.23.post3-py3-none-any.whl (282.9 kB view details)

Uploaded Python 3

File details

Details for the file ansibleguy_webui-0.0.23.post3.tar.gz.

File metadata

File hashes

Hashes for ansibleguy_webui-0.0.23.post3.tar.gz
Algorithm Hash digest
SHA256 c20090a81d0d49abe54533506ca1902a7e17caa6b235f1d4b87b3a02c59c7e38
MD5 49cb921fabb5486bec1edc6a5ffca480
BLAKE2b-256 07938ba7ffc23a8a47efdc0c761e202540c95e0f94b254086508e59fd4a1012a

See more details on using hashes here.

Provenance

File details

Details for the file ansibleguy_webui-0.0.23.post3-py3-none-any.whl.

File metadata

File hashes

Hashes for ansibleguy_webui-0.0.23.post3-py3-none-any.whl
Algorithm Hash digest
SHA256 38b36267bb87a392033bc20d32522f0816fb6dca5fce9580e101bac0d2537064
MD5 a4b922142831cd1cd3b7622a84cc238c
BLAKE2b-256 8998ef05429570493f8206170b204b86b7bd46873d9104407f099b223cbd5225

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page