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.24.post3.tar.gz (238.5 kB view details)

Uploaded Source

Built Distribution

ansibleguy_webui-0.0.24.post3-py3-none-any.whl (285.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for ansibleguy_webui-0.0.24.post3.tar.gz
Algorithm Hash digest
SHA256 269b61518de040e352d11513bab2526cfdfd0538f519f5e0cded13b8f4797f4d
MD5 1b95d6e9d886f8b1e29490c14c85b458
BLAKE2b-256 6dc4fbf399c970ddda20410c7c026a6398394f067e48f1288eede881e0de937a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ansibleguy_webui-0.0.24.post3-py3-none-any.whl
Algorithm Hash digest
SHA256 63fad42c899cc256be5c2fd85a8d072edb4fad665caf179afc4255e4fa8ffc9c
MD5 0a0cc4824d56239464075a96f903d066
BLAKE2b-256 4df5964df18930e702936cb05e780f9bbc93f55cb270a1c1392da9b26e10a0a0

See more details on using hashes here.

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