Installation

[faizanars]

Hello there!

I am very pleased to see that Openstack-Handler has been published, and will be deploying it soon enough. I have some minor questions, because the documentation is a little vague. Kindly answer this:

1. Deployed Openstack using microstack on Ubuntu22,04, is it necessary to use devstack for OCR?
2. This module deploys Ranger, it seems. To make this work, is it necessary to deploy Deputy and SDL-Parser before setting this up or not?
3. It is highlighted that builder is required before running the handlers, kindly elaborate a little on how to build?

In the past, I have successfully deployed the Deputy and SDL-Parser and I believe that if I deploy Ranger, I will be done with the installation. Kindly answer these questions to clear out my confusion.

Warm Regards!

[mipeal]

Hello there,

Thank you for reaching out and for your interest in Openstack-Handler! We appreciate your enthusiasm and are happy to assist with your queries.

1. Microstack vs. Devstack:
   While we have not explicitly tested Openstack-Handler with Microstack, the key requirement for its functionality is having valid OpenStack application credentials and access to a QEMU/KVM hypervisor over TCP. If Microstack meets these criteria, it should work, but we recommend testing in your environment to confirm compatibility.

2. Ranger, Deputy, and SDL-Parser Dependencies:
   Yes, deploying Ranger requires Deputy as well as Handlers with support of SDL-Parser. This is by design, as SDL (Scenario Definition Language) is the orchestrating language used within the OCR ecosystem. Additionally, Ranger-Web includes a built-in SDL editor, making the integration seamless.

3. Building the Openstack-Handler Module:
   You can install Openstack-Handler using pip directly from the repository and then the entrypoint should be available(we highly recommend using a virtual environment for the python packages):

   pip install git+https://github.com/Open-Cyber-Range/Openstack-Handler.git

   Please note that Openstack-Handler is built over uv, so all dependencies required by uv must be installed for proper functionality.

4. Next Steps for Deployment:
   Since you have previously deployed Deputy and SDL-Parser, setting up Ranger should complete the installation. If you encounter any specific issues or require further assistance, we recommend reaching out to our OCR product owner at: 📧 developers@cr14.ee

We appreciate your engagement with Openstack-Handler and look forward to your feedback on the deployment process. Let us know if you need any additional clarifications!

Best regards,
Md Mujahid Islam Peal
Open Cyber Range Team