Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Overhauled the entire application
  • Loading branch information
bufanoc authored Dec 23, 2024
1 parent 2c9bfeb commit c41ed98
Showing 1 changed file with 102 additions and 6 deletions.
108 changes: 102 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,108 @@
OVN Web Application
========================================
# OVN Web Manager

This application provides a web interface for OVN (Open Virtual Network)
A modern web application for managing Open Virtual Network (OVN) through a beautiful and intuitive interface, designed to run on Ubuntu Server.

Dependencies
------------
## Features

The following Python packages are required to run the application:
- Logical Switch Management
- Logical Router Management
- ACL Management
- Load Balancer Configuration
- Security Groups
- Port Management
- DHCP Configuration
- NAT Configuration
- Real-time Network Visualization
- Multi-tenant Support

## System Requirements

- Ubuntu Server 22.04 LTS (minimal installation)
- Internet connection for package installation
- Minimum 2GB RAM
- 20GB disk space

## Quick Start

1. Clone the repository:
```bash
git clone https://github.com/yourusername/ovn-web-manager.git
cd ovn-web-manager
```

2. Make the installation script executable:
```bash
chmod +x start.sh
```

3. Run the installation script:
```bash
./start.sh
```

The script will automatically:
- Install all required system packages
- Set up OVN and its dependencies
- Configure the Python backend environment
- Build and serve the React frontend
- Start all necessary services

Once completed, the application will be accessible at:
- Frontend: `http://<server-ip>:3000`
- Backend API: `http://<server-ip>:5000`

## Components Installed

- **System Packages**: git, curl, python3, nodejs, jq, and other dependencies
- **OVN**: Latest version from Ubuntu repositories
- **Frontend**: React-based web interface
- **Backend**: Flask API server
- **Database**: OVN native databases

## Architecture

- Frontend: React with Material-UI
- Backend: Python Flask REST API
- Network: OVN (Open Virtual Network)
- Database: OVN native databases (northbound and southbound)

## Security Notes

- The application runs services on ports 3000 (frontend) and 5000 (backend)
- Make sure to configure your firewall to allow access to these ports
- Consider setting up HTTPS for production use
- Default configuration listens on all network interfaces

## Troubleshooting

If you encounter issues:

1. Check service status:
```bash
systemctl status openvswitch-switch
systemctl status ovn-northd
systemctl status ovn-controller
```

2. View application logs:
```bash
tail -f frontend.log
tail -f backend.log
```

3. Check OVN database connectivity:
```bash
sudo ovn-nbctl show
sudo ovn-sbctl show
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

MIT License



Expand Down

0 comments on commit c41ed98

Please sign in to comment.