Skip to content

Commit f359578

Browse files
doc changes
1 parent b6c1e13 commit f359578

File tree

9 files changed

+84
-0
lines changed

9 files changed

+84
-0
lines changed
64.9 KB
Loading
162 KB
Loading
48.3 KB
Loading
127 KB
Loading
44.1 KB
Loading
115 KB
Loading
60.6 KB
Loading
64.6 KB
Loading

source/adminguide/extensions/inbuilt_extensions.rst

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,18 @@ Existing `MAAS consumer` token can be used or a new API key can be generated by
285285

286286
Note down the **key** value.
287287

288+
Install required Python libraries
289+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
290+
291+
The MAAS Orchestrator Extension uses OAuth1 for API authentication.
292+
293+
Ensure the required Python libraries are installed on the CloudStack Management Server before using this extension.
294+
The following command is provided as an example, package installation steps may vary depending on the host operating system:
295+
296+
.. code-block:: bash
297+
298+
pip3 install requests requests_oauthlib
299+
288300
Adding MaaS to CloudStack
289301
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
290302

@@ -331,6 +343,70 @@ To set up the MaaS Extension, follow these steps in CloudStack:
331343

332344
Operations **Start**, **Stop**, **Reboot**, and **Delete** can be performed on the Instance from CloudStack.
333345

346+
Additional Notes and Tested Scenarios
347+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
348+
349+
The MaaS scenarios have been tested and verified with a Shared Network setup in CloudStack, using the MAAS Orchestrator Extension.
350+
Please find some additional notes with respect to the networking and access related configuration as below,
351+
352+
#. **Using CloudStack Virtual Router (VR) as an External DHCP Server**
353+
354+
If the end user wants the **CloudStack Virtual Router (VR)** to act as the external DHCP server for instances provisioned through MAAS, the following configuration steps must be performed.
355+
356+
**In CloudStack**
357+
358+
1. Navigate to **Networks → Add Shared Network**.
359+
2. Create a Shared Network using the **DefaultSharedNetworkOffering**, and define an appropriate **Guest IP range**.
360+
361+
|CloudStack-shared-network.png|
362+
363+
**In MAAS**
364+
365+
1. Navigate to **Networking → Subnets → Add Subnet** and create a subnet corresponding to the same IP range used in CloudStack.
366+
367+
|MaaS-add-subnet-1.png|
368+
|MaaS-add-subnet-2.png|
369+
370+
2. Once the subnet is added:
371+
- Ensure **Managed allocation** is **disabled**.
372+
- Ensure **Active discovery** is **enabled**.
373+
374+
|MaaS-subnet-configuration.png|
375+
376+
3. Add a **Reserved IP range** that matches the CloudStack Guest range (optional, for clarity).
377+
378+
|MaaS-add-reserve-iprange.png|
379+
380+
4. Disable the DHCP service in MAAS:
381+
- Navigate to **Subnets → VLAN → Edit VLAN**.
382+
- Ensure the **DHCP service** is **disabled**.
383+
384+
|MaaS-disable-dhcp.png|
385+
386+
This configuration allows the CloudStack Virtual Router (VR) to provide IP address allocation and DHCP services for the baremetal instances managed through MAAS.
387+
388+
#. **Using CloudStack-Generated SSH Keys for Baremetal Access**
389+
390+
If the user wants to use the **SSH key pair generated in CloudStack** to log into the baremetal server provisioned by MAAS, perform the following steps.
391+
392+
**In CloudStack**
393+
394+
1. Navigate to **Compute → SSH Keypairs → Create SSH Keypair**.
395+
2. Save the generated **private key** for later use (CloudStack stores only the public key).
396+
397+
|Cloudstack-create-sshkeypair.png|
398+
399+
**In MAAS**
400+
401+
1. Navigate to **Admin → SSH Keys → Import**.
402+
2. Paste the **public key** from the CloudStack-generated SSH key pair.
403+
3. Save the changes.
404+
405+
|MaaS-add-sshkeypair.png|
406+
407+
408+
After these steps, any baremetal node deployed via the MAAS Extension can be accessed using the **private key** from CloudStack.
409+
334410
.. Images
335411
336412
@@ -351,3 +427,11 @@ To set up the MaaS Extension, follow these steps in CloudStack:
351427
.. |MaaS-add-host.png| image:: /_static/images/MaaS-add-host.png
352428
.. |MaaS-add-template.png| image:: /_static/images/MaaS-add-template.png
353429
.. |MaaS-deploy-instance.png| image:: /_static/images/MaaS-deploy-instance.png
430+
.. |CloudStack-shared-network.png| image:: /_static/images/CloudStack-shared-network.png
431+
.. |MaaS-add-subnet-1.png| image:: /_static/images/MaaS-add-subnet-1.png
432+
.. |MaaS-add-subnet-2.png| image:: /_static/images/MaaS-add-subnet-2.png
433+
.. |MaaS-subnet-configuration.png| image:: /_static/images/MaaS-subnet-configuration.png
434+
.. |MaaS-add-reserve-iprange.png| image:: /_static/images/MaaS-add-reserve-iprange.png
435+
.. |MaaS-disable-dhcp.png| image:: /_static/images/MaaS-disable-dhcp.png
436+
.. |Cloudstack-create-sshkeypair.png| image:: /_static/images/Cloudstack-create-sshkeypair.png
437+
.. |MaaS-add-sshkeypair.png| image:: /_static/images/MaaS-add-sshkeypair.png

0 commit comments

Comments
 (0)