README.md

CheckList

• BackEnd Docs
• FrontEnd Docs
• Database Layer
• Test Report

Requirements

IPAM - IP Address Management System

Table of Contents

• 1. Introduction

  • 1.1 Purpose
  • 1.2 Scope
  • 1.3 References

• 2. Functional Requirements

  • 2.1 Tracking Individual IP Addresses
  • 2.2 Managing IP Address Ranges
  • 2.3 Reserving IP Addresses
  • 2.4 Freeing Reserved IP Addresses

• 3. Non-Functional Requirements

  • 3.1 Technology Stack
  • 3.2 User Interface
  • 3.3 Swagger Documentation

• 4. System Architecture

• 5. User Interface

• 6. Data Models

• 7. Business Logic

• 8. Security

1. Introduction

1.1 Purpose

The purpose of the IPAM (IP Address Management) project is to develop a Java application for tracking and managing IP addresses, including both individual addresses and address ranges. The system aims to efficiently allocate, reserve, and free up IP addresses while providing a user-friendly interface.

1.2 Scope

The scope of this project includes the development of a Java application using Java 17 and Spring Boot 3 for the backend, and a React-based user interface for the frontend. The application will allow users to manage individual IP addresses and IP address ranges, track their status (assigned, free, reserved), and enforce business logic for freeing up reserved addresses.

1.3 References

• What is IPAM? | IP Address Management Solutions - ManageEngine OpManager

2. Functional Requirements

2.1 Tracking Individual IP Addresses

• The system should maintain a database table to track individual IP addresses.
• Each IP address should have a status, which can be "assigned," "free," or "reserved."

2.2 Managing IP Address Ranges

• The system should support the management of IP address ranges.
• Users should be able to reserve a range of IP addresses if needed.

2.3 Reserving IP Addresses

• Users should be able to reserve individual IP addresses.
• Reserved IP addresses should be automatically freed up based on predefined business logic.

2.4 Freeing Reserved IP Addresses

• The system should automatically free up reserved IP addresses based on business logic.
• Reserved IP addresses should not be reserved indefinitely.

3. Non-Functional Requirements

3.1 Technology Stack

• Backend: Java 17, Spring Boot 3
• Frontend: React, Material UI
• Database: MySQL
• Testing: Mockito, selenium

3.2 User Interface

• The system must provide a user-friendly React-based UI for interacting with IP address management functionalities.

3.3 Swagger Documentation

• The system should include Swagger documentation for API endpoints.