Skip to main content

Basic WebUI for using Ansible

Project description

Basic WebUI for using Ansible

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.

This project is still in early development! DO NOT USE IN PRODUCTION!


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

      • Scheduled execution (Cron-Format)

      • Manual/immediate execution

      • Support for ad-hoc commands

    • 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

  • 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.18.tar.gz (133.6 kB view details)

Uploaded Source

Built Distribution

ansibleguy_webui-0.0.18-py3-none-any.whl (171.2 kB view details)

Uploaded Python 3

File details

Details for the file ansibleguy-webui-0.0.18.tar.gz.

File metadata

  • Download URL: ansibleguy-webui-0.0.18.tar.gz
  • Upload date:
  • Size: 133.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for ansibleguy-webui-0.0.18.tar.gz
Algorithm Hash digest
SHA256 25dc70b28cadba7db56b8ba743abc84eb1424c7738261b238c61da6cee4b470c
MD5 27764b80e171821062192935d0574ad2
BLAKE2b-256 37333a09e00de29ed397e2228974c22ddf058dc3a8632fe68d6017b2847fa752

See more details on using hashes here.

Provenance

File details

Details for the file ansibleguy_webui-0.0.18-py3-none-any.whl.

File metadata

File hashes

Hashes for ansibleguy_webui-0.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 75927b22a39a1b456fba27d52dd2f256ad5171e709d31bc2ee9cdcd7aff0ba9c
MD5 bd98f46528ca64b8428806be81742577
BLAKE2b-256 cfa17e028a6be15ea4926d346b9b5b279192b54412b6a38f9fecdfec114564ff

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