devopsforhumans/kumaone

Automation friendly bulk action CLI helper for Uptime Kuma.

kumaone

---

Table of Contents

• Note
• Virtualenv
• Installation

Note

kumaone's primary objective is to enable users to perform bulk action in uptime kuma server. A very special thanks to the author and contributors of the project uptime-kuma-api. kumaone is built by studying and understanding the code of uptime-kuma-api and in places I used some parts of the code as it is from uptime-kuma-api. Appreciate the outstanding work done by the author and contributors of both uptime kuma and uptime-kuma-api project.

kumaone is a CLI application. Designed for bulk operations mainly from reading configuration files. kumaone is very early in development. Contribution and constructive feedbacks are always welcome.

Virtualenv

• Install pipenv from here

• Activate virtual environment

  pipenv shell

  if there are no virtual environment available (e.g. first use), a virtual environment will be created and activated automatically.

• Install dependencies

  To install dependencies with pipenv use the following command

  pipenv install

  To install dev dependencies use --dev flag

  pipenv install --dev

Installation

pip install kumaone

Installation (Dev)

pip install -e .

To Do List

Info

• Show information about kumaone

Configuration

• Show uptime kuma configuration (default/custom paths).
• Create uptime kuma configuration (default/custom path).
• Delete uptime kuma configuration.
• Edit uptime kuma configuration.

Monitors

• Supported Monitor types (tested)
  • HTTP
  • JSON_QUERY
  • PING
• List all monitors.
• List monitor by groups and processes also.
• Show details of a monitor by ID.
• Bulk add monitors from file(s).
• Bulk delete monitors from file(s).
• Add single monitor from inline dictionary data.
• Delete single Monitor by name.
• Delete single monitor by id.

Status Page

• List all staus page(s).
• See details of a single status page.
• Add a new status page.
• Add status pages from file(s).
• Delete single status page by slug.
• Delete status page from file(s).

Notification

• Supported notification providers (tested)
  • Discord
  • Email(SMTP)
  • Opsgenie
  • PagerDuty
  • Rocket.Chat
  • Slack
  • Teams
  • Webhook
• List all notification(s).
• See details of a single notification by name/id.
• Add new notification (interactive).
• Add notifications from single file.
• Delete notification by name.
• Delete notification by id.
• Delete notifications from single file.

Maintenance

TBA

Incident

TBA

Change Password

• Change password from CLI.
• Update password in kumaone config.

Cleanup

• Clear heartbeats.
• Clear statistics.
• Clear events.

Backlog

• Don't stop the program if one monitor process runs into error.
• Add debug logs for methods.

kumaone's Issues

Add Opsgenie notification

We would like to add opsgenie notification.

Add Capability to configure notification settings while creating monitors

Currently kumaone creates monitors and notification but can not handle the following configuration and enable desired notification automatically from file(s) YAML input.

Resend Notification if Down X times consecutively (Resend disabled)

We would like to add the capability to do so via YAML file and kumaone.

Same name notification being added multiple times

📑 I have found these related issues/pull requests

None found.

Description

If we try to create notification from the same file. kumaone creates new notification settings. If ran multiple times the same command, it creates multiple notification settings.

👟 Reproduction steps

1. Install kumaone
2. Create notification config file as mentioned here
3. Run kumaone notification add --notifications /path/to/your/notification/file
4. Check the GUI for notification settings
5. Run step 3 again

👀 Expected behavior

Multiple run should be idempotent. Existing notification setting with same name should be skipped.

😓 Actual Behavior

Keeps creating more notification settings with same name.

🐻 Kumaone Version

0.0.1-alpha.6

💻 Operating System and Arch

macOS Sonoma 14.2.1

🖥️ Deployment Environment

• Python: 3.11
• Pipenv: 2023.11.15

📝 Relevant log output

No response