Velero-UI

Warning

Attention Users: This project is in active development, and certain tools or features might still be under construction. We kindly urge you to exercise caution while utilizing the tools within this environment. While every effort is being made to ensure the stability and reliability of the project, there could be unexpected behaviors or limited functionalities in some areas. We highly recommend thoroughly testing the project in non-production or sandbox environments before implementing it in critical or production systems. Your feedback is invaluable to us; if you encounter any issues or have suggestions for improvement, please feel free to report them. Your input helps us enhance the project's performance and user experience. Thank you for your understanding and cooperation.

Important

Velero-UI project is part of a project consisting of three modules:

• Velero-API
• Velero-UI
• Velero-Watchdog

Tip

Helm installation is recommended

Description

This project was created to simplify through a user interface some velero backup operations.

Some screenshots:

• dashboard
• login
• backups
• create new backup
• create restore
• schedule
• create schedule
• backup location
• storage location
• repo
• storage class map
• backup describe
• backup logs
• configuration
• watchdog configuration
• cron schedule heatmap

Features

1. Intuitive usability

2. Real-time dashboard and monitoring

3. Backups management

4. Restores management

5. Schedules management

6. Storage class map

7. Restic features (check locks, unlock, unlock --remove-all)

8. Multi cluster (Experimental feature)

see changelog for details.

Configuration

FIELD	TYPE	DEFAULT	DESCRIPTION
NEXT_PUBLIC_REFRESH_DATATABLE_AFTER	Number	1500	Milliseconds delay for datatable update after each operation.
NEXT_PUBLIC_REFRESH_RECENT	Number	5000	Polling task in progress updates in milliseconds.
NEXT_PUBLIC_VELERO_API_NAME	String		Name for cluster
NEXT_PUBLIC_VELERO_API_URL	String	http://127.0.0.1:8001	Url to http velero-api project
NEXT_PUBLIC_VELERO_API_WS	String	ws://127.0.0.1:8001	Url to ws velero-api project
NEXT_PUBLIC_LOGIN_CLUSTERS_SWITCH	Bool	false	EXPERIMENTAL: Displays or hides the cluster selection menu on the login page.
NEXT_PUBLIC_VELERO_API_NAME_1	String		EXPERIMENTAL: Name for cluster 1
NEXT_PUBLIC_VELERO_API_URL_1	String		EXPERIMENTAL: Url to http velero-api project
NEXT_PUBLIC_VELERO_API_WS_1	String		EXPERIMENTAL: Url to ws velero-api project
NEXT_PUBLIC_VELERO_API_NAME_2	String		EXPERIMENTAL: Name for cluster 2
NEXT_PUBLIC_VELERO_API_URL_2	String		EXPERIMENTAL: Url to http velero-api project
NEXT_PUBLIC_VELERO_API_WS_2	String		EXPERIMENTAL: Url to ws velero-api project

Installation

Clone the repository:

git clone https://github.com/seriohub/velero-ui.git
cd velero-ui

Run native

Requirements

• Nodejs
• YARN

1. Navigate to the src folder

2. Dependencies installation:

   yarn

3. Run development

   yarn run dev

Run in Kubernetes

Install with HELM

See helm readme

Install with Kubernetes YAML

1. Setup docker image:

   [!INFO]
   You can use skip the Setup docker image and use a deployed image published on DockerHub.
   Docker hub: https://hub.docker.com/r/dserio83/velero-ui

   1. Navigate to the root folder

   2. Build image

      docker build --target velero-ui -t <your-register>/<your-user>/velero-ui:<tag> -f ./docker/Dockerfile .

   3. Push image

      docker push <your-register>/<your-user>/velero-ui --all-tags

      [!INFO]
      In case you run the custom build of the image and use the files inside the k8s folder to deploy to kubernetes, remember to update in the 20_deployment.yaml file with references for the built image

2. Kubernetes create objects

   1. Navigate to the k8s folder

   2. Create namespace (If it does not exist, the namespace should already be created if you have installed the Velero API):

      kubectl create ns velero-ui

   3. Create the ConfigMap:

      [!WARNING]
      Set the parameters in the 10_config_map.yaml file before applying it according to your environment.
      You need to set NEXT_PUBLIC_VELERO_API_URL and NEXT_PUBLIC_VELERO_API_WS to the port of the Velero API service.

      kubectl apply -f 10_config_map.yaml -n velero-ui

   4. Create the deployment:

      kubectl apply -f 20_deployment.yaml -n velero-ui

   5. Create the service:

      [!WARNING]
      Customizes the 30_service_lb.yaml or 30_service_nodeport.yaml file before applying it according to your environment.

      kubectl apply -f 30_service_lb.yaml -n velero-ui

      or

      kubectl apply -f 30_service_nodeport.yaml -n velero-ui

Test Environment

The project is developed, tested and put into production on several clusters with the following configuration

1. Kubernetes v1.28.2
2. Velero Server 1.11.1/Client v1.11.1
3. Velero Server 1.12.1/Client v1.12.1

How to Contribute

1. Fork the project

2. Create your feature branch

   git checkout -b feature/new-feature

3. Commit your changes

   git commit -m 'Add new feature'

4. Push to the branch

   git push origin feature/new-feature

5. Create a new pull request

License

This project is licensed under the Apache 2.0 license.

---

Feel free to modify this template according to your project's specific requirements.

In case you need more functionality, create a PR. If you find a bug, open a ticket.