sunrise6g-opensdk 0.0.1

Open source SDK to abstract CAMARA/GSMA Transformation Functions (TFs) for Edge Cloud platforms, 5G network cores and Open RAN solutions.

OpenSDK

Open source SDK to abstract CAMARA/GSMA Transformation Functions (TFs) for Edge Cloud platforms & 5G network cores

Contributing Guidelines

Thank you for contributing to this project. Please follow the guidelines below to ensure a smooth collaboration.

Directory Structure

Each contribution should be made in the appropriate directory:

• EdgeCloud Adapters → src/sunrise6g-opendk/edgecloud/clients/
• Network Adapters → src/sunrise6g-opendk/network/clients/
• O-RAN Adapters → src/sunrise6g-opendk/oran/clients/

Testing (Mandatory)

To merge a feature branch into main, the adapter must pass the unit tests. Instructions to do so available at TESTING.md

Contributing

1. Check Guidelines at CONTRIBUTING.md.
2. Create a New Branch following the naming convention.
3. Develop Your Feature inside the correct directory.
4. Ensure All Tests Pass before the merge.
5. Submit a Merge Request (MR) to the main branch.

Branch Naming Convention

Each partner should create a feature branch following the naming convention based on the type of adapter they are contributing:

☁️ EdgeCloud Adapters

Branch Name Format:

feature/add-edgecloud-<EDGE_CLOUD_PLATFORM_NAME>

Example:

feature/add-edgecloud-i2edge

🌐 Network Adapters

Branch Name Format:

feature/add-network-<5G_CORE_NAME>

Example:

feature/add-network-open5gs

📶 O-RAN Adapters

Branch Name Format:

feature/add-oran-<SOLUTION_NAME>

Example:

feature/add-oran-juniper

Sequence Diagram Example

Refer to the sequence diagram example from docs/workflows/edgecloud/get_av_zones.md for guidance on workflow structure:

sequenceDiagram
title Retrieve Edge Cloud Zones
actor AP as App Vertical Provider
participant CE as Capabilities Exposure
box Service Resource Manager
    participant API
    participant SDK as EdgeCloudSDK
end
participant i2Edge
participant PiEdge

note over AP,CE: CAMARA EdgeCloud API
AP ->> CE: GET /edge-cloud-zones
CE ->> API: GET /av. zones
API ->> SDK: sbi = EdgeCloudFactory.create_edgecloud_client(i2Edge)
API ->> SDK: sbi.get_edge_cloud_zones()
SDK ->> i2Edge: GET /zones/list
API ->> SDK: sbi = EdgeCloudFactory.create_edgecloud_client(PiEdge)
API ->> SDK: sbi.get_edge_cloud_zones()
SDK ->> PiEdge: GET /nodes