otwld/velero-ui repository overview

A fully realtime lightweight dashboard interface to interact with Velero (vmware-tanzu)⁠.

This dashboard implement the same functionalities as the velero CLI.

⁠⭐ Velero UI Features

⁠Interface

• 🔒 Authentication: Secure dashboard with multiple authentication methods.
• 🔍 Resource Management: Search, sort, and perform quick actions on Velero resources.
• ⚠️ Action Confirmation: Double-check confirmation modals for critical actions.
• 🧩 Intuitive Forms: Step-by-step form wizard for easy resource creation and edition.
• 📄 Detailed Resource Pages: Each resource has a dedicated page displaying specifications, status, manifests, and logs.
• 🏳️ Languages: Multi languages are available.

⁠Authentication

• 🔑 Built-in Authentication: Velero UI is secured by default with username and password credentials.
• 🌐 Federated Authentication: Supports up to five external authentication providers, including GitHub, GitLab, Google, Microsoft, and generic OAuth/OpenID.
• 📂 LDAP Integration: Configure Velero UI to integrate with your existing LDAP system.

⁠Statistics

• 📊 Global Overview: View summaries of your Velero resources (backups, schedules, restores, etc.).
• 📈 Charts and Visualizations: Track resource status and success rates with visual metrics.

⁠Advanced Settings

• 🖥️ Cluster Info: Access basic information about the cluster running the Velero Server.
• 📝 Logs: Real-time log monitoring for Velero Server and Node Agents.

⁠Technical

• ⚡ Optimized Performance: Velero UI leverages caching for fast performance and quick rendering.
• 📱 Responsive Design: Fully functional on mobile devices and tablets.

⁠📋 Requirements

• Velero server >= 1.13.0

⁠📚 Documentation

Want to learn more about Velero UI's features? Check out Velero UI documentation⁠ for a comprehensive overview!

⁠🚀 Deployments

⁠⚙️ Installation

1. Locate the path of your Kube Config. The default location is in ~/.kube/config.

2. Run this Docker command with your Kube config path. You can also specify the context using the environment variables⁠ KUBE_CONTEXT:

   docker run --name velero-ui -v ~/.kube/config:/app/.kube/config -e KUBE_CONFIG_PATH=/app/.kube/config -d -p 3333:3000 otwld/velero-ui:latest
   

   Copy

   Where:

   • ~/.kube/config:/app/.kube/config links the Kube Config as a volume from the host to the container.
   • KUBE_CONFIG_PATH=/app/.kube/config is the path in the container to the Kube Config.