diff --git a/Documentation/CAMARAaaS-Architecture.png b/Documentation/CAMARAaaS-Architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..618a1eeb77809e3e2dd5189c61764b5277c72031 Binary files /dev/null and b/Documentation/CAMARAaaS-Architecture.png differ diff --git a/Documentation/CAMARAaaS-Workflow-OSLToday.png b/Documentation/CAMARAaaS-Workflow-OSLToday.png new file mode 100644 index 0000000000000000000000000000000000000000..1f0e3c285aaec4a12d26e0acdc606be09be2a3a8 Binary files /dev/null and b/Documentation/CAMARAaaS-Workflow-OSLToday.png differ diff --git a/Documentation/CAMARAaaS-Workflow-ServiceOperation.png b/Documentation/CAMARAaaS-Workflow-ServiceOperation.png new file mode 100644 index 0000000000000000000000000000000000000000..9a451b2ecba49978c734dd05c753737889231423 Binary files /dev/null and b/Documentation/CAMARAaaS-Workflow-ServiceOperation.png differ diff --git a/Documentation/CAMARAaaS-Workflow-ServiceOrdering.png b/Documentation/CAMARAaaS-Workflow-ServiceOrdering.png new file mode 100644 index 0000000000000000000000000000000000000000..8b10df21a6eac26d73d4ab60d3c6af464b461a9f Binary files /dev/null and b/Documentation/CAMARAaaS-Workflow-ServiceOrdering.png differ diff --git a/README.md b/README.md index 8c9c9670f9726154d3b4a7cad064943bc089e72b..74f4127c0ef8eed1d6b892290348739ed36407fe 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,42 @@ -# org.etsi.osl.controllers.camara +# CAMARAaaS Add-on +The **CAMARA as a Service OSL Add-on** allows telecom operators and customer service providers to expose OSL services through CAMARA APIs. By doing so, it enables runtime operations, such as enforcing profiles on User Equipment (UEs) or updating 5G Network Slice characteristics, using standardized CAMARA API endpoints. Thus, this add-on enables the orchestration of CAMARA APIs, which will then be used to control the lifecyle and the operations that shall take place in an already existing OSL Service. -## Getting started +Therefore, these are the key features of this add-on: -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +- **Seamless Integration**: Operators can expose their existing OSL services through CAMARA APIs, maintaining consistency with the OSL framework while offering additional accessibility. +- **Dynamic Service Control**: Allows runtime updates to characteristics of 5G-related Services, such as UE profiles or Network Slices, via CAMARA REST API calls. The updated of the characteristics of a Service can then be consumed by a Kubernetes Custom Resource that will produce an operation according to the updated characteristics. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +## Architecture and Interactions -## Add your files +The add-on introduces a generic **CAMARA API Service**, which acts as a wrapper for existing (running) services. The architecture ensures: -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +1. **API Exposure**: CAMARA APIs are orchestrated by OSL (offered as a service) and their endpoints are exposed to the end clients. +2. **Service Mapping**: The CAMARA API Service references a running service (identified by a UUID), enabling targeted operations. The invoking of CAMARA API endpoints will results in updates in the running service’s characteristics. +3. **Operational Flow**: Updates triggered via CAMARA APIs are propagated to the operator's service through OSL0s message queue (Active MQ), ensuring synchronization of service characteristics. -``` -cd existing_repo -git remote add origin https://labs.etsi.org/rep/osl/code/addons/org.etsi.osl.controllers.camara.git -git branch -M main -git push -uf origin main -``` +This architecture is presented in the figure below: -## Integrate with your tools + -- [ ] [Set up project integrations](https://labs.etsi.org/rep/osl/code/addons/org.etsi.osl.controllers.camara/-/settings/integrations) +As already mentioned, the step “PATCH Characteristics†is achieved by send a message to OSL’s message bus. -## Collaborate with your team +For OSL’s community to get the full grasp of this architecture, we also make available a sequence diagram with all interactions that take place. -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) + -## Test and Deploy + -Use the built-in continuous integration in GitLab. + +## Important Considerations -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +The OSL CAMARA as a Service Add-on depends on 2 Services: -*** +- The OSL CAMARA API Service + - Is a generic CAMARA API wrapper service implemented by the OSL team + - This implementation will be publicly offered as an Addon (Helm chart) +- A custom 5G-related Service (that shall be controlled/referenced by the CAMARA API Service): + - An OSL user must implement and provide its own 5G-related Controlling Service (following OSL design patterns) + - Implementation is custom -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.