Tutorials
This section of the documentation covers all the necessary contents to interact with the BubbleRAN platforms as well as extra materials on individual use cases or applications. If you are a new user of the platform, we suggest that you follow the flow of this section until you feel confident working with the platform, specifically the CLI.
The documentation website also contains API documentation, helpful for developing on top of our products or digging in for all the detailed references, and Academia of educational material on the platform and on Cloud Native and Open RAN technologies in general. The Blog is full of relevant articles and links with recent news about the platform along with testimonials and experiences of others using the platform. Finally, FAQ brings a number of common questions and helpful bits of advice that should help make your troubleshooting and workflow that much easier.
Use the search box to search through the whole documentation for any keyword.
The documentation is provided in English (en-US) and the translations to French (fr-FR) and Chinese (zh-CN) is planned for the future. Contact us to help building this open documentation in your language!
Nomenclature
This documentation relies on several terms from the Cloud Native and Open RAN domains. In particular, you may follow the glossary from Kubernetes for the Cloud Native terms and O-RAN Specifications for the Open RAN terms.
The projects that form BubbleRAN products are organized in this tree structure:
Versioning
This documentation is versioned by the Trirematics releases. Check the Releases page for a complete list of the versions and their release dates, or use the dropdown menu to choose a specific version. Check the banner on top of the page for its release status.
Step-by-Step
1️⃣ Getting Started
After unboxing your delivery, these are the first steps that you need to take to get your system up and running. This section includes all the hardware and software setups required. Also, you will find a step-by-step sample workflow to get familiar with the platform.
Learn all about how to install, configure, and use the command system of the platform. It contains CLI, CDK, and all the other tools that you need to interact with the platform.
Guide yourself on how to use the Snap packages, Docker Compose, and Podman Play for single node deployments. These modes are useful for DevOps and onboarding new elements to the platform.
With these sample deployments, you could learn how to interact with the SMO and the RIC. For more details, check the API documentation.
5️⃣ Use Cases
In this section, we brief you on some of our demonstration use cases in several venues. It is a nice repository of ideas and inspiration for your own use cases.