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.16.tar.gz (129.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ansibleguy_webui-0.0.16-py3-none-any.whl (163.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansibleguy-webui-0.0.16.tar.gz
  • Upload date:
  • Size: 129.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for ansibleguy-webui-0.0.16.tar.gz
Algorithm Hash digest
SHA256 07613859828e3a0ab9c4b214491e6a8d84df1ca86285c99acba1430f72782e09
MD5 d8404bab86b719c9cbc80344bbf7d7f6
BLAKE2b-256 40ee0b6cb97d37f10efb9884ee823eb679b944cca37f982271b99294e5e20cc6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ansibleguy_webui-0.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 ed80ac1db40e6860383e48838e545961d7ceddaf7b12efc63a3b78f855a4c253
MD5 c9f0167dbf4ee5c914e0d4a59ee0726a
BLAKE2b-256 8f56b098532d69e3fb9b4892d87e4790f3b6edf3dd27484c6207c3ae266bdd29

See more details on using hashes here.

Supported by

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