Compare commits
1 Commits
cetmix_tow
...
cetmix_tow
| Author | SHA1 | Date | |
|---|---|---|---|
| 5880120a84 |
263
addons/cetmix_tower_ovh/README.rst
Normal file
263
addons/cetmix_tower_ovh/README.rst
Normal file
@@ -0,0 +1,263 @@
|
||||
================
|
||||
Cetmix Tower OVH
|
||||
================
|
||||
|
||||
..
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:857636ba9899c2980b8ee24c3cf12b3854a7a31704c39395c7f81648d1b3ca57
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Beta
|
||||
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
|
||||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
||||
:alt: License: AGPL-3
|
||||
.. |badge3| image:: https://img.shields.io/badge/github-cetmix%2Fcetmix--tower-lightgray.png?logo=github
|
||||
:target: https://github.com/cetmix/cetmix-tower/tree/18.0/cetmix_tower_ovh
|
||||
:alt: cetmix/cetmix-tower
|
||||
|
||||
|badge1| |badge2| |badge3|
|
||||
|
||||
This module integrates the OVH Python client, enabling seamless
|
||||
interaction with OVH cloud services within the Cetmix Tower.
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Use Cases / Context
|
||||
===================
|
||||
|
||||
Although OVH allows API calls without using an SDK, we found that
|
||||
integrating the OVH SDK into Cetmix Tower makes provisioning,
|
||||
configuring, and maintaining OVH instances more convenient for the end
|
||||
user. However, not all Cetmix Tower users require this functionality, so
|
||||
to avoid overloading the system, we have included it in a separate
|
||||
module.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Setting up OVH Access
|
||||
=====================
|
||||
|
||||
Create OVH API Credentials
|
||||
--------------------------
|
||||
|
||||
To use the OVH integration with Cetmix Tower, you need to create OVH API
|
||||
credentials:
|
||||
|
||||
- Follow the `official OVH
|
||||
documentation <https://docs.ovh.com/gb/en/api/first-steps/>`__
|
||||
(https://docs.ovh.com/gb/en/api/first-steps/) for creating an
|
||||
application and generating API keys
|
||||
- It's recommended to create a dedicated application with appropriate
|
||||
permissions for Cetmix Tower
|
||||
- Store your Application Key, Application Secret, and Consumer Key
|
||||
securely—you'll need them in the next step
|
||||
|
||||
Configure OVH Secrets in Cetmix Tower
|
||||
-------------------------------------
|
||||
|
||||
Create three secrets in Cetmix Tower to store your OVH credentials:
|
||||
|
||||
- Navigate to ``Cetmix Tower > Settings > Keys and Secrets``
|
||||
- Create a new Secret with:
|
||||
|
||||
- Name: ``OVH Application Key``
|
||||
- Reference: ``ovh_application_key``
|
||||
- Key Type: ``Secret``
|
||||
|
||||
- Enter your OVH Application Key in the Secret Value tab
|
||||
- Similarly, create another Secret with:
|
||||
|
||||
- Name: ``OVH Application Secret``
|
||||
- Reference: ``ovh_application_secret``
|
||||
- Key Type: ``Secret``
|
||||
|
||||
- Enter your OVH Application Secret in the Secret Value tab
|
||||
- Finally, create a Secret with:
|
||||
|
||||
- Name: ``OVH Consumer Key``
|
||||
- Reference: ``ovh_consumer_key``
|
||||
- Key Type: ``Secret``
|
||||
|
||||
- Enter your OVH Consumer Key in the Secret Value tab
|
||||
|
||||
..
|
||||
|
||||
Note: These secrets will be accessible as
|
||||
``#!cxtower.secret.ovh_application_key!#``,
|
||||
``#!cxtower.secret.ovh_application_secret!#``, and
|
||||
``#!cxtower.secret.ovh_consumer_key!#`` in your commands.
|
||||
|
||||
Configure OVH Endpoint
|
||||
----------------------
|
||||
|
||||
Create a variable to define your OVH API endpoint (region):
|
||||
|
||||
- Navigate to ``Cetmix Tower > Settings > Variables``
|
||||
- Create a new Variable with:
|
||||
|
||||
- Name: ``OVH Endpoint``
|
||||
- Reference: ``ovh_endpoint``
|
||||
- Type: ``String``
|
||||
|
||||
- Set your OVH endpoint (e.g., ``ovh-eu``, ``ovh-ca``, ``ovh-us``) as
|
||||
the value
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Cetmix Tower OVHcloud Command Usage
|
||||
===================================
|
||||
|
||||
**Disclaimer**: The following example demonstrates one of many
|
||||
possible commands you can create and run with this module. The
|
||||
``ovh`` Python library provides access to the full range of OVHcloud
|
||||
APIs – this is just a starting point to help you get familiar with
|
||||
the integration.
|
||||
|
||||
Example of Cetmix Tower Python Command to Create DNS Records
|
||||
------------------------------------------------------------
|
||||
|
||||
- **Navigate to Command Creation**
|
||||
|
||||
- Go to ``Cetmix Tower > Commands > Commands``
|
||||
- Click the ``Create`` button
|
||||
|
||||
- **Configure Command Settings**
|
||||
|
||||
- Set a descriptive ``Name`` (e.g., "List OVHcloud Instances")
|
||||
- Leave ``Reference`` blank to generate automatically (or set a custom
|
||||
reference)
|
||||
- Select ``Action``: "Execute Python code"
|
||||
- Set ``Access Level``: Choose appropriate level (e.g., "Manager")
|
||||
- Optional: Set ``Default Path`` if needed
|
||||
- Optional: Add ``Tags`` (e.g., "ovh", "cloud", "instance") for better
|
||||
organization
|
||||
|
||||
- **Add Required Variables**
|
||||
|
||||
- In the ``Variables`` tab, add the previously configured variable:
|
||||
|
||||
- ``ovh_endpoint`` (e.g., "ovh-eu")
|
||||
|
||||
- **Add Required Secrets**
|
||||
|
||||
- In the ``Secrets`` field, add the previously configured secrets:
|
||||
|
||||
- ``ovh_application_key``
|
||||
- ``ovh_application_secret``
|
||||
- ``ovh_consumer_key``
|
||||
|
||||
- **Write Python Code**
|
||||
|
||||
- Go to the ``Code`` tab
|
||||
- Enter the following Python code:
|
||||
|
||||
.. code:: python
|
||||
|
||||
# List OVHcloud instances using ovh API
|
||||
result = {"exit_code": 0, "message": None}
|
||||
|
||||
client = ovh.Client(
|
||||
endpoint={{ ovh_endpoint }},
|
||||
application_key=#!cxtower.secret.ovh_application_key!#,
|
||||
application_secret=#!cxtower.secret.ovh_application_secret!#,
|
||||
consumer_key=#!cxtower.secret.ovh_consumer_key!#
|
||||
)
|
||||
|
||||
# Required variables:
|
||||
# - domain_name: The main domain (e.g., "example.com")
|
||||
# - subdomain: The subdomain to create (e.g., "test")
|
||||
|
||||
try:
|
||||
# Create a new subdomain by adding a DNS entry (A record as example)
|
||||
ip_address = "1.2.3.4" # Replace with the desired IP address
|
||||
response = client.post(
|
||||
"/domain/zone/" + domain_name + "/record",
|
||||
fieldType="A",
|
||||
subDomain=subdomain,
|
||||
target=ip_address,
|
||||
ttl=3600
|
||||
)
|
||||
# Refresh the zone to apply changes
|
||||
client.post("/domain/zone/" + domain_name + "/refresh")
|
||||
result["message"] = "Subdomain '" + subdomain + "." + domain_name + "' created and DNS zone refreshed."
|
||||
except Exception as e:
|
||||
result["exit_code"] = 1
|
||||
result["message"] = "Error: " + str(e)
|
||||
|
||||
- **Save the Command**
|
||||
|
||||
- Click the ``Save`` button to create the command
|
||||
|
||||
Running the OVHcloud Instance Command
|
||||
-------------------------------------
|
||||
|
||||
- **Navigate to Server**
|
||||
|
||||
- Go to ``Cetmix Tower > Servers > Servers``
|
||||
- Open the server where you want to run the command
|
||||
|
||||
- **Execute Command from Server**
|
||||
|
||||
- Click the ``Command`` button at the top of the server form
|
||||
- In the popup dialog:
|
||||
|
||||
- Select your OVHcloud instance command from the dropdown
|
||||
- Verify the variable values (if any need adjustment)
|
||||
- Click ``Run`` to execute
|
||||
|
||||
- **View Command Results**
|
||||
|
||||
- After execution, the command log will display showing:
|
||||
|
||||
- The command executed
|
||||
- Execution status
|
||||
- Output message containing OVHcloud instance details if successful
|
||||
|
||||
Changelog
|
||||
=========
|
||||
|
||||
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/cetmix/cetmix-tower/issues>`_.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/cetmix/cetmix-tower/issues/new?body=module:%20cetmix_tower_ovh%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
-------
|
||||
|
||||
* Cetmix
|
||||
* Giovanni Serra
|
||||
|
||||
Maintainers
|
||||
-----------
|
||||
|
||||
.. |maintainer-GSLabIt| image:: https://github.com/GSLabIt.png?size=40px
|
||||
:target: https://github.com/GSLabIt
|
||||
:alt: GSLabIt
|
||||
|
||||
Current maintainer:
|
||||
|
||||
|maintainer-GSLabIt|
|
||||
|
||||
This module is part of the `cetmix/cetmix-tower <https://github.com/cetmix/cetmix-tower/tree/18.0/cetmix_tower_ovh>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute.
|
||||
1
addons/cetmix_tower_ovh/__init__.py
Normal file
1
addons/cetmix_tower_ovh/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from . import models
|
||||
24
addons/cetmix_tower_ovh/__manifest__.py
Normal file
24
addons/cetmix_tower_ovh/__manifest__.py
Normal file
@@ -0,0 +1,24 @@
|
||||
# Copyright 2024 Cetmix OÜ
|
||||
# Copyright 2025 Giovanni Serra <giovanni@gslab.it>
|
||||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
|
||||
|
||||
{
|
||||
"name": "Cetmix Tower OVH",
|
||||
"summary": """Cetmix Tower OVH API integration""",
|
||||
"version": "18.0.1.0.1",
|
||||
"category": "Productivity",
|
||||
"license": "AGPL-3",
|
||||
"author": "Cetmix, Giovanni Serra",
|
||||
"maintainers": ["GSLabIt"],
|
||||
"website": "https://tower.cetmix.com",
|
||||
"images": ["static/description/banner.png"],
|
||||
"application": False,
|
||||
"installable": True,
|
||||
"demo": [
|
||||
"demo/demo_data.xml",
|
||||
],
|
||||
"external_dependencies": {"python": ["ovh"]},
|
||||
"depends": [
|
||||
"cetmix_tower_server",
|
||||
],
|
||||
}
|
||||
179
addons/cetmix_tower_ovh/demo/demo_data.xml
Normal file
179
addons/cetmix_tower_ovh/demo/demo_data.xml
Normal file
@@ -0,0 +1,179 @@
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<odoo noupdate="1">
|
||||
<!-- ===============================================
|
||||
Keys
|
||||
================================================ -->
|
||||
<record id="ovh_application_key" model="cx.tower.key">
|
||||
<field name="name">OVH Application Key</field>
|
||||
<field name="reference">ovh_application_key</field>
|
||||
<field name="key_type">s</field>
|
||||
<field name="secret_value" />
|
||||
</record>
|
||||
|
||||
<record id="ovh_application_secret" model="cx.tower.key">
|
||||
<field name="name">OVH Application Secret</field>
|
||||
<field name="reference">ovh_application_secret</field>
|
||||
<field name="key_type">s</field>
|
||||
<field name="secret_value" />
|
||||
</record>
|
||||
|
||||
<record id="ovh_consumer_key" model="cx.tower.key">
|
||||
<field name="name">OVH Consumer Key</field>
|
||||
<field name="reference">ovh_consumer_key</field>
|
||||
<field name="key_type">s</field>
|
||||
<field name="secret_value" />
|
||||
</record>
|
||||
|
||||
<!-- ===============================================
|
||||
Variables
|
||||
================================================ -->
|
||||
|
||||
<record id="variable_ovh_endpoint" model="cx.tower.variable">
|
||||
<field name="name">OVH Endpoint</field>
|
||||
<field name="reference">ovh_endpoint</field>
|
||||
<field name="variable_type">o</field>
|
||||
</record>
|
||||
|
||||
<record id="variable_ovh_zone_name" model="cx.tower.variable">
|
||||
<field name="name">OVH Zone Name</field>
|
||||
<field name="reference">ovh_zone_name</field>
|
||||
</record>
|
||||
|
||||
<!-- ===============================================
|
||||
Global Variable values
|
||||
================================================ -->
|
||||
|
||||
<record id="value_ovh_zone_name" model="cx.tower.variable.value">
|
||||
<field name="variable_id" ref="variable_ovh_zone_name" />
|
||||
<field name="value_char">your_zone.name</field>
|
||||
</record>
|
||||
|
||||
<record id="option_ovh_endpoint_eu" model="cx.tower.variable.option">
|
||||
<field name="variable_id" ref="variable_ovh_endpoint" />
|
||||
<field name="name">ovh-eu</field>
|
||||
<field name="reference">ovh-eu</field>
|
||||
<field name="value_char">ovh-eu</field>
|
||||
<field name="sequence">10</field>
|
||||
</record>
|
||||
<record id="option_ovh_endpoint_us" model="cx.tower.variable.option">
|
||||
<field name="variable_id" ref="variable_ovh_endpoint" />
|
||||
<field name="name">ovh-us</field>
|
||||
<field name="reference">ovh-us</field>
|
||||
<field name="value_char">ovh-us</field>
|
||||
<field name="sequence">20</field>
|
||||
</record>
|
||||
<record id="option_ovh_endpoint_ca" model="cx.tower.variable.option">
|
||||
<field name="variable_id" ref="variable_ovh_endpoint" />
|
||||
<field name="name">ovh-ca</field>
|
||||
<field name="reference">ovh-ca</field>
|
||||
<field name="value_char">ovh-ca</field>
|
||||
<field name="sequence">30</field>
|
||||
</record>
|
||||
<record id="option_ovh_endpoint_soyoustart_eu" model="cx.tower.variable.option">
|
||||
<field name="variable_id" ref="variable_ovh_endpoint" />
|
||||
<field name="name">soyoustart-eu</field>
|
||||
<field name="reference">soyoustart-eu</field>
|
||||
<field name="value_char">soyoustart-eu</field>
|
||||
<field name="sequence">40</field>
|
||||
</record>
|
||||
<record id="option_ovh_endpoint_soyoustart_ca" model="cx.tower.variable.option">
|
||||
<field name="variable_id" ref="variable_ovh_endpoint" />
|
||||
<field name="name">soyoustart-ca</field>
|
||||
<field name="reference">soyoustart-ca</field>
|
||||
<field name="value_char">soyoustart-ca</field>
|
||||
<field name="sequence">50</field>
|
||||
</record>
|
||||
<record id="option_ovh_endpoint_kimsufi_eu" model="cx.tower.variable.option">
|
||||
<field name="variable_id" ref="variable_ovh_endpoint" />
|
||||
<field name="name">kimsufi-eu</field>
|
||||
<field name="reference">kimsufi-eu</field>
|
||||
<field name="value_char">kimsufi-eu</field>
|
||||
<field name="sequence">60</field>
|
||||
</record>
|
||||
<record id="option_ovh_endpoint_kimsufi_ca" model="cx.tower.variable.option">
|
||||
<field name="variable_id" ref="variable_ovh_endpoint" />
|
||||
<field name="name">kimsufi-ca</field>
|
||||
<field name="reference">kimsufi-ca</field>
|
||||
<field name="value_char">kimsufi-ca</field>
|
||||
<field name="sequence">70</field>
|
||||
</record>
|
||||
|
||||
<!-- ===============================================
|
||||
Commands
|
||||
================================================ -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<record id="command_ovh_register_domain" model="cx.tower.command">
|
||||
<field name="name">Register OVH DNS Record</field>
|
||||
<field name="action">python_code</field>
|
||||
<field name="code">
|
||||
# ----------------
|
||||
# Tower properties
|
||||
# ----------------
|
||||
cetmix_tower = env["cetmix.tower"]
|
||||
|
||||
# Ensure the domain in your server URL matches your OVH DNS Zone name!
|
||||
# Example: If your DNS Zone is "example.com", your URL should be "*.example.com"
|
||||
|
||||
instance_url = {{ tower.server.url }}
|
||||
ovh_endpoint = env["cx.tower.variable.option"].get_by_reference("option_ovh_endpoint_eu").value_char
|
||||
ovh_application_key = #!cxtower.secret.ovh_application_key!#
|
||||
ovh_application_secret = #!cxtower.secret.ovh_application_secret!#
|
||||
ovh_consumer_key = #!cxtower.secret.ovh_consumer_key!#
|
||||
ovh_zone_name = {{ ovh_zone_name }}
|
||||
# ----------------
|
||||
# Request settings
|
||||
# ----------------
|
||||
|
||||
path = "/domain/zone/"+ovh_zone_name+"/record"
|
||||
|
||||
# Subdomain extraction with tldextract:
|
||||
sub_domain = tldextract.extract(instance_url).subdomain
|
||||
|
||||
# Send request to Ovh
|
||||
exit_code = 0
|
||||
message = ""
|
||||
|
||||
try:
|
||||
client = ovh.Client(
|
||||
endpoint=ovh_endpoint,
|
||||
application_key=ovh_application_key,
|
||||
application_secret=ovh_application_secret,
|
||||
consumer_key=ovh_consumer_key
|
||||
)
|
||||
records = client.get(path, subDomain=sub_domain, fieldType="A")
|
||||
if not records:
|
||||
records = client.post(
|
||||
path,
|
||||
fieldType="A",
|
||||
subDomain=sub_domain,
|
||||
target={{ tower.server.ipv4 }},
|
||||
ttl=3600
|
||||
)
|
||||
client.post("/domain/zone/" + ovh_zone_name + "/refresh")
|
||||
if records:
|
||||
exit_code = 0
|
||||
message = "subDomain " + sub_domain + " registered"
|
||||
else:
|
||||
exit_code = 0
|
||||
message = "subDomain " + sub_domain + " already exists"
|
||||
except Exception as e:
|
||||
exit_code = 500
|
||||
message = str(e)
|
||||
|
||||
result = {
|
||||
"exit_code": exit_code,
|
||||
"message": message,
|
||||
}
|
||||
</field>
|
||||
<!-- prettier-ignore-end -->
|
||||
<field name="user_ids" eval="[(6, 0, [ref('base.user_admin')])]" />
|
||||
<field name="manager_ids" eval="[(6, 0, [ref('base.user_admin')])]" />
|
||||
<field
|
||||
name="tag_ids"
|
||||
eval="[(6, 0, [ref('cetmix_tower_server.tag_custom')])]"
|
||||
/>
|
||||
<field
|
||||
name="note"
|
||||
>Register or check DNS A record for current server in OVH DNS zone</field>
|
||||
</record>
|
||||
</odoo>
|
||||
30
addons/cetmix_tower_ovh/i18n/cetmix_tower_ovh.pot
Normal file
30
addons/cetmix_tower_ovh/i18n/cetmix_tower_ovh.pot
Normal file
@@ -0,0 +1,30 @@
|
||||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * cetmix_tower_ovh
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 18.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
||||
#. module: cetmix_tower_ovh
|
||||
#: model:ir.model,name:cetmix_tower_ovh.model_cx_tower_command
|
||||
msgid "Cetmix Tower Command"
|
||||
msgstr ""
|
||||
|
||||
#. module: cetmix_tower_ovh
|
||||
#. odoo-python
|
||||
#: code:addons/cetmix_tower_ovh/models/cx_tower_command.py:0
|
||||
msgid ""
|
||||
"Python 'ovh' library for OVH services. Available methods: "
|
||||
"'Client'<br/>Supports OVH services<br/>Please check the <a "
|
||||
"href='https://eu.api.ovh.com/console/?section=%2FallDom&branch=v1' "
|
||||
"target='_blank'>OVH Documentation</a> for detailed information about the "
|
||||
"services and methods."
|
||||
msgstr ""
|
||||
54
addons/cetmix_tower_ovh/i18n/it.po
Normal file
54
addons/cetmix_tower_ovh/i18n/it.po
Normal file
@@ -0,0 +1,54 @@
|
||||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * cetmix_tower_ovh
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 18.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: \n"
|
||||
"PO-Revision-Date: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Language: it\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
"X-Generator: Poedit 2.3\n"
|
||||
|
||||
#. module: cetmix_tower_ovh
|
||||
#: model:ir.model,name:cetmix_tower_ovh.model_cx_tower_command
|
||||
msgid "Cetmix Tower Command"
|
||||
msgstr "Comando Cetmix Tower"
|
||||
|
||||
#. module: cetmix_tower_ovh
|
||||
#. odoo-python
|
||||
#: code:addons/cetmix_tower_ovh/models/cx_tower_command.py:0
|
||||
#, python-format
|
||||
msgid "Python 'ovh' library for OVH services. Available methods: 'Client'<br/>Supports OVH services<br/>Please check the <a href='https://eu.api.ovh.com/console/?section=%2FallDom&branch=v1' target='_blank'>OVH Documentation</a> for detailed information about the services and methods."
|
||||
msgstr "Libreria Python 'ovh' per servizi OVH. Metodi disponibili: 'Client'<br/>Supporta i servizi OVH<br/>Verificare la <a href='https://eu.api.ovh.com/console/?section=%2FallDom&branch=v1' target='_blank'>documentazione OVH</a> per informazioni dettagliate sui servizi e i metodi."
|
||||
|
||||
#~ msgid "Display Name"
|
||||
#~ msgstr "Nome visualizzato"
|
||||
|
||||
#~ msgid "ID"
|
||||
#~ msgstr "ID"
|
||||
|
||||
#~ msgid "Last Modified on"
|
||||
#~ msgstr "Ultima modifica il"
|
||||
|
||||
#~ msgid ""
|
||||
#~ "# - ovh: Python 'ovh' library for OVH services. Available methods: "
|
||||
#~ "'Client'\n"
|
||||
#~ "# Supports OVH services\n"
|
||||
#~ "# - tldextract: Python 'tldextract' library. Available methods: "
|
||||
#~ "'extract'\n"
|
||||
#~ "# Supports domain extraction"
|
||||
#~ msgstr ""
|
||||
#~ "# - ovh: libreria Python 'ovh' per i servizi OVH. Metodi disponibili: "
|
||||
#~ "'Client'\n"
|
||||
#~ "# Supporta servizi OVH\n"
|
||||
#~ "# - tldextract: libreria Python 'tldextract'. Metodi disponibili: "
|
||||
#~ "'extract'\n"
|
||||
#~ "# Supporta estrazione dominio"
|
||||
1
addons/cetmix_tower_ovh/models/__init__.py
Normal file
1
addons/cetmix_tower_ovh/models/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from . import cx_tower_command # noqa: F401
|
||||
39
addons/cetmix_tower_ovh/models/cx_tower_command.py
Normal file
39
addons/cetmix_tower_ovh/models/cx_tower_command.py
Normal file
@@ -0,0 +1,39 @@
|
||||
# Copyright 2024 Cetmix OÜ
|
||||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
|
||||
|
||||
from odoo import _, models
|
||||
from odoo.tools.safe_eval import wrap_module
|
||||
|
||||
# Wrap ovh safely
|
||||
ovh = wrap_module(__import__("ovh"), ["Client"])
|
||||
|
||||
|
||||
class CxTowerCommand(models.Model):
|
||||
"""Extends cx.tower.command to add OVH functionality."""
|
||||
|
||||
_inherit = "cx.tower.command"
|
||||
|
||||
def _custom_python_libraries(self):
|
||||
"""
|
||||
Add the ovh library to the available libraries.
|
||||
"""
|
||||
python_libraries = super()._custom_python_libraries()
|
||||
python_libraries.update(
|
||||
{
|
||||
"cetmix_tower_ovh": {
|
||||
"ovh": {
|
||||
"import": ovh,
|
||||
"help": _(
|
||||
"Python 'ovh' library for OVH services. "
|
||||
"Available methods: 'Client'<br/>"
|
||||
"Supports OVH services<br/>"
|
||||
"Please check the <a "
|
||||
"href='https://eu.api.ovh.com/console/?section=%2FallDom&branch=v1'"
|
||||
" target='_blank'>OVH Documentation</a> for detailed "
|
||||
"information about the services and methods."
|
||||
),
|
||||
}
|
||||
}
|
||||
}
|
||||
)
|
||||
return python_libraries
|
||||
3
addons/cetmix_tower_ovh/pyproject.toml
Normal file
3
addons/cetmix_tower_ovh/pyproject.toml
Normal file
@@ -0,0 +1,3 @@
|
||||
[build-system]
|
||||
requires = ["whool"]
|
||||
build-backend = "whool.buildapi"
|
||||
44
addons/cetmix_tower_ovh/readme/CONFIGURE.md
Normal file
44
addons/cetmix_tower_ovh/readme/CONFIGURE.md
Normal file
@@ -0,0 +1,44 @@
|
||||
|
||||
# Setting up OVH Access
|
||||
|
||||
## Create OVH API Credentials
|
||||
|
||||
To use the OVH integration with Cetmix Tower, you need to create OVH API credentials:
|
||||
|
||||
- Follow the [official OVH documentation](https://docs.ovh.com/gb/en/api/first-steps/) (https://docs.ovh.com/gb/en/api/first-steps/) for creating an application and generating API keys
|
||||
- It's recommended to create a dedicated application with appropriate permissions for Cetmix Tower
|
||||
- Store your Application Key, Application Secret, and Consumer Key securely—you'll need them in the next step
|
||||
|
||||
## Configure OVH Secrets in Cetmix Tower
|
||||
|
||||
Create three secrets in Cetmix Tower to store your OVH credentials:
|
||||
|
||||
- Navigate to `Cetmix Tower > Settings > Keys and Secrets`
|
||||
- Create a new Secret with:
|
||||
- Name: `OVH Application Key`
|
||||
- Reference: `ovh_application_key`
|
||||
- Key Type: `Secret`
|
||||
- Enter your OVH Application Key in the Secret Value tab
|
||||
- Similarly, create another Secret with:
|
||||
- Name: `OVH Application Secret`
|
||||
- Reference: `ovh_application_secret`
|
||||
- Key Type: `Secret`
|
||||
- Enter your OVH Application Secret in the Secret Value tab
|
||||
- Finally, create a Secret with:
|
||||
- Name: `OVH Consumer Key`
|
||||
- Reference: `ovh_consumer_key`
|
||||
- Key Type: `Secret`
|
||||
- Enter your OVH Consumer Key in the Secret Value tab
|
||||
|
||||
> Note: These secrets will be accessible as `#!cxtower.secret.ovh_application_key!#`, `#!cxtower.secret.ovh_application_secret!#`, and `#!cxtower.secret.ovh_consumer_key!#` in your commands.
|
||||
|
||||
## Configure OVH Endpoint
|
||||
|
||||
Create a variable to define your OVH API endpoint (region):
|
||||
|
||||
- Navigate to `Cetmix Tower > Settings > Variables`
|
||||
- Create a new Variable with:
|
||||
- Name: `OVH Endpoint`
|
||||
- Reference: `ovh_endpoint`
|
||||
- Type: `String`
|
||||
- Set your OVH endpoint (e.g., `ovh-eu`, `ovh-ca`, `ovh-us`) as the value
|
||||
1
addons/cetmix_tower_ovh/readme/CONTEXT.md
Normal file
1
addons/cetmix_tower_ovh/readme/CONTEXT.md
Normal file
@@ -0,0 +1 @@
|
||||
Although OVH allows API calls without using an SDK, we found that integrating the OVH SDK into Cetmix Tower makes provisioning, configuring, and maintaining OVH instances more convenient for the end user. However, not all Cetmix Tower users require this functionality, so to avoid overloading the system, we have included it in a separate module.
|
||||
1
addons/cetmix_tower_ovh/readme/DESCRIPTION.md
Normal file
1
addons/cetmix_tower_ovh/readme/DESCRIPTION.md
Normal file
@@ -0,0 +1 @@
|
||||
This module integrates the OVH Python client, enabling seamless interaction with OVH cloud services within the Cetmix Tower.
|
||||
0
addons/cetmix_tower_ovh/readme/HISTORY.md
Normal file
0
addons/cetmix_tower_ovh/readme/HISTORY.md
Normal file
86
addons/cetmix_tower_ovh/readme/USAGE.md
Normal file
86
addons/cetmix_tower_ovh/readme/USAGE.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# Cetmix Tower OVHcloud Command Usage
|
||||
|
||||
> **Disclaimer**: The following example demonstrates one of many possible commands you can create and run with this module. The `ovh` Python library provides access to the full range of OVHcloud APIs – this is just a starting point to help you get familiar with the integration.
|
||||
|
||||
## Example of Cetmix Tower Python Command to Create DNS Records
|
||||
|
||||
* **Navigate to Command Creation**
|
||||
* Go to `Cetmix Tower > Commands > Commands`
|
||||
* Click the `Create` button
|
||||
|
||||
* **Configure Command Settings**
|
||||
* Set a descriptive `Name` (e.g., "List OVHcloud Instances")
|
||||
* Leave `Reference` blank to generate automatically (or set a custom reference)
|
||||
* Select `Action`: "Execute Python code"
|
||||
* Set `Access Level`: Choose appropriate level (e.g., "Manager")
|
||||
* Optional: Set `Default Path` if needed
|
||||
* Optional: Add `Tags` (e.g., "ovh", "cloud", "instance") for better organization
|
||||
|
||||
* **Add Required Variables**
|
||||
* In the `Variables` tab, add the previously configured variable:
|
||||
* `ovh_endpoint` (e.g., "ovh-eu")
|
||||
|
||||
* **Add Required Secrets**
|
||||
* In the `Secrets` field, add the previously configured secrets:
|
||||
* `ovh_application_key`
|
||||
* `ovh_application_secret`
|
||||
* `ovh_consumer_key`
|
||||
|
||||
* **Write Python Code**
|
||||
* Go to the `Code` tab
|
||||
* Enter the following Python code:
|
||||
|
||||
```python
|
||||
# List OVHcloud instances using ovh API
|
||||
result = {"exit_code": 0, "message": None}
|
||||
|
||||
client = ovh.Client(
|
||||
endpoint={{ ovh_endpoint }},
|
||||
application_key=#!cxtower.secret.ovh_application_key!#,
|
||||
application_secret=#!cxtower.secret.ovh_application_secret!#,
|
||||
consumer_key=#!cxtower.secret.ovh_consumer_key!#
|
||||
)
|
||||
|
||||
# Required variables:
|
||||
# - domain_name: The main domain (e.g., "example.com")
|
||||
# - subdomain: The subdomain to create (e.g., "test")
|
||||
|
||||
try:
|
||||
# Create a new subdomain by adding a DNS entry (A record as example)
|
||||
ip_address = "1.2.3.4" # Replace with the desired IP address
|
||||
response = client.post(
|
||||
"/domain/zone/" + domain_name + "/record",
|
||||
fieldType="A",
|
||||
subDomain=subdomain,
|
||||
target=ip_address,
|
||||
ttl=3600
|
||||
)
|
||||
# Refresh the zone to apply changes
|
||||
client.post("/domain/zone/" + domain_name + "/refresh")
|
||||
result["message"] = "Subdomain '" + subdomain + "." + domain_name + "' created and DNS zone refreshed."
|
||||
except Exception as e:
|
||||
result["exit_code"] = 1
|
||||
result["message"] = "Error: " + str(e)
|
||||
```
|
||||
|
||||
* **Save the Command**
|
||||
* Click the `Save` button to create the command
|
||||
|
||||
## Running the OVHcloud Instance Command
|
||||
|
||||
* **Navigate to Server**
|
||||
* Go to `Cetmix Tower > Servers > Servers`
|
||||
* Open the server where you want to run the command
|
||||
|
||||
* **Execute Command from Server**
|
||||
* Click the `Command` button at the top of the server form
|
||||
* In the popup dialog:
|
||||
* Select your OVHcloud instance command from the dropdown
|
||||
* Verify the variable values (if any need adjustment)
|
||||
* Click `Run` to execute
|
||||
|
||||
* **View Command Results**
|
||||
* After execution, the command log will display showing:
|
||||
* The command executed
|
||||
* Execution status
|
||||
* Output message containing OVHcloud instance details if successful
|
||||
BIN
addons/cetmix_tower_ovh/static/description/banner.png
Normal file
BIN
addons/cetmix_tower_ovh/static/description/banner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
BIN
addons/cetmix_tower_ovh/static/description/icon.png
Normal file
BIN
addons/cetmix_tower_ovh/static/description/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
635
addons/cetmix_tower_ovh/static/description/index.html
Normal file
635
addons/cetmix_tower_ovh/static/description/index.html
Normal file
@@ -0,0 +1,635 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
||||
<title>Cetmix Tower OVH</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
Despite the name, some widely supported CSS2 features are used.
|
||||
|
||||
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: gray; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic, pre.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="cetmix-tower-ovh">
|
||||
<h1 class="title">Cetmix Tower OVH</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:857636ba9899c2980b8ee24c3cf12b3854a7a31704c39395c7f81648d1b3ca57
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/cetmix/cetmix-tower/tree/18.0/cetmix_tower_ovh"><img alt="cetmix/cetmix-tower" src="https://img.shields.io/badge/github-cetmix%2Fcetmix--tower-lightgray.png?logo=github" /></a></p>
|
||||
<p>This module integrates the OVH Python client, enabling seamless
|
||||
interaction with OVH cloud services within the Cetmix Tower.</p>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#use-cases-context" id="toc-entry-1">Use Cases / Context</a></li>
|
||||
<li><a class="reference internal" href="#configuration" id="toc-entry-2">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#setting-up-ovh-access" id="toc-entry-3">Setting up OVH Access</a><ul>
|
||||
<li><a class="reference internal" href="#create-ovh-api-credentials" id="toc-entry-4">Create OVH API Credentials</a></li>
|
||||
<li><a class="reference internal" href="#configure-ovh-secrets-in-cetmix-tower" id="toc-entry-5">Configure OVH Secrets in Cetmix Tower</a></li>
|
||||
<li><a class="reference internal" href="#configure-ovh-endpoint" id="toc-entry-6">Configure OVH Endpoint</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#usage" id="toc-entry-7">Usage</a></li>
|
||||
<li><a class="reference internal" href="#cetmix-tower-ovhcloud-command-usage" id="toc-entry-8">Cetmix Tower OVHcloud Command Usage</a><ul>
|
||||
<li><a class="reference internal" href="#example-of-cetmix-tower-python-command-to-create-dns-records" id="toc-entry-9">Example of Cetmix Tower Python Command to Create DNS Records</a></li>
|
||||
<li><a class="reference internal" href="#running-the-ovhcloud-instance-command" id="toc-entry-10">Running the OVHcloud Instance Command</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#changelog" id="toc-entry-11">Changelog</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-12">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="toc-entry-13">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="toc-entry-14">Authors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="toc-entry-15">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="use-cases-context">
|
||||
<h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
|
||||
<p>Although OVH allows API calls without using an SDK, we found that
|
||||
integrating the OVH SDK into Cetmix Tower makes provisioning,
|
||||
configuring, and maintaining OVH instances more convenient for the end
|
||||
user. However, not all Cetmix Tower users require this functionality, so
|
||||
to avoid overloading the system, we have included it in a separate
|
||||
module.</p>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
|
||||
</div>
|
||||
<div class="section" id="setting-up-ovh-access">
|
||||
<h1><a class="toc-backref" href="#toc-entry-3">Setting up OVH Access</a></h1>
|
||||
<div class="section" id="create-ovh-api-credentials">
|
||||
<h2><a class="toc-backref" href="#toc-entry-4">Create OVH API Credentials</a></h2>
|
||||
<p>To use the OVH integration with Cetmix Tower, you need to create OVH API
|
||||
credentials:</p>
|
||||
<ul class="simple">
|
||||
<li>Follow the <a class="reference external" href="https://docs.ovh.com/gb/en/api/first-steps/">official OVH
|
||||
documentation</a>
|
||||
(<a class="reference external" href="https://docs.ovh.com/gb/en/api/first-steps/">https://docs.ovh.com/gb/en/api/first-steps/</a>) for creating an
|
||||
application and generating API keys</li>
|
||||
<li>It’s recommended to create a dedicated application with appropriate
|
||||
permissions for Cetmix Tower</li>
|
||||
<li>Store your Application Key, Application Secret, and Consumer Key
|
||||
securely—you’ll need them in the next step</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="configure-ovh-secrets-in-cetmix-tower">
|
||||
<h2><a class="toc-backref" href="#toc-entry-5">Configure OVH Secrets in Cetmix Tower</a></h2>
|
||||
<p>Create three secrets in Cetmix Tower to store your OVH credentials:</p>
|
||||
<ul class="simple">
|
||||
<li>Navigate to <tt class="docutils literal">Cetmix Tower > Settings > Keys and Secrets</tt></li>
|
||||
<li>Create a new Secret with:<ul>
|
||||
<li>Name: <tt class="docutils literal">OVH Application Key</tt></li>
|
||||
<li>Reference: <tt class="docutils literal">ovh_application_key</tt></li>
|
||||
<li>Key Type: <tt class="docutils literal">Secret</tt></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Enter your OVH Application Key in the Secret Value tab</li>
|
||||
<li>Similarly, create another Secret with:<ul>
|
||||
<li>Name: <tt class="docutils literal">OVH Application Secret</tt></li>
|
||||
<li>Reference: <tt class="docutils literal">ovh_application_secret</tt></li>
|
||||
<li>Key Type: <tt class="docutils literal">Secret</tt></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Enter your OVH Application Secret in the Secret Value tab</li>
|
||||
<li>Finally, create a Secret with:<ul>
|
||||
<li>Name: <tt class="docutils literal">OVH Consumer Key</tt></li>
|
||||
<li>Reference: <tt class="docutils literal">ovh_consumer_key</tt></li>
|
||||
<li>Key Type: <tt class="docutils literal">Secret</tt></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Enter your OVH Consumer Key in the Secret Value tab</li>
|
||||
</ul>
|
||||
<!-- -->
|
||||
<blockquote>
|
||||
Note: These secrets will be accessible as
|
||||
<tt class="docutils literal">#!cxtower.secret.ovh_application_key!#</tt>,
|
||||
<tt class="docutils literal">#!cxtower.secret.ovh_application_secret!#</tt>, and
|
||||
<tt class="docutils literal">#!cxtower.secret.ovh_consumer_key!#</tt> in your commands.</blockquote>
|
||||
</div>
|
||||
<div class="section" id="configure-ovh-endpoint">
|
||||
<h2><a class="toc-backref" href="#toc-entry-6">Configure OVH Endpoint</a></h2>
|
||||
<p>Create a variable to define your OVH API endpoint (region):</p>
|
||||
<ul class="simple">
|
||||
<li>Navigate to <tt class="docutils literal">Cetmix Tower > Settings > Variables</tt></li>
|
||||
<li>Create a new Variable with:<ul>
|
||||
<li>Name: <tt class="docutils literal">OVH Endpoint</tt></li>
|
||||
<li>Reference: <tt class="docutils literal">ovh_endpoint</tt></li>
|
||||
<li>Type: <tt class="docutils literal">String</tt></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Set your OVH endpoint (e.g., <tt class="docutils literal"><span class="pre">ovh-eu</span></tt>, <tt class="docutils literal"><span class="pre">ovh-ca</span></tt>, <tt class="docutils literal"><span class="pre">ovh-us</span></tt>) as
|
||||
the value</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#toc-entry-7">Usage</a></h1>
|
||||
</div>
|
||||
<div class="section" id="cetmix-tower-ovhcloud-command-usage">
|
||||
<h1><a class="toc-backref" href="#toc-entry-8">Cetmix Tower OVHcloud Command Usage</a></h1>
|
||||
<blockquote>
|
||||
<strong>Disclaimer</strong>: The following example demonstrates one of many
|
||||
possible commands you can create and run with this module. The
|
||||
<tt class="docutils literal">ovh</tt> Python library provides access to the full range of OVHcloud
|
||||
APIs – this is just a starting point to help you get familiar with
|
||||
the integration.</blockquote>
|
||||
<div class="section" id="example-of-cetmix-tower-python-command-to-create-dns-records">
|
||||
<h2><a class="toc-backref" href="#toc-entry-9">Example of Cetmix Tower Python Command to Create DNS Records</a></h2>
|
||||
<ul>
|
||||
<li><p class="first"><strong>Navigate to Command Creation</strong></p>
|
||||
<ul class="simple">
|
||||
<li>Go to <tt class="docutils literal">Cetmix Tower > Commands > Commands</tt></li>
|
||||
<li>Click the <tt class="docutils literal">Create</tt> button</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p class="first"><strong>Configure Command Settings</strong></p>
|
||||
<ul class="simple">
|
||||
<li>Set a descriptive <tt class="docutils literal">Name</tt> (e.g., “List OVHcloud Instances”)</li>
|
||||
<li>Leave <tt class="docutils literal">Reference</tt> blank to generate automatically (or set a custom
|
||||
reference)</li>
|
||||
<li>Select <tt class="docutils literal">Action</tt>: “Execute Python code”</li>
|
||||
<li>Set <tt class="docutils literal">Access Level</tt>: Choose appropriate level (e.g., “Manager”)</li>
|
||||
<li>Optional: Set <tt class="docutils literal">Default Path</tt> if needed</li>
|
||||
<li>Optional: Add <tt class="docutils literal">Tags</tt> (e.g., “ovh”, “cloud”, “instance”) for better
|
||||
organization</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p class="first"><strong>Add Required Variables</strong></p>
|
||||
<ul class="simple">
|
||||
<li>In the <tt class="docutils literal">Variables</tt> tab, add the previously configured variable:<ul>
|
||||
<li><tt class="docutils literal">ovh_endpoint</tt> (e.g., “ovh-eu”)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p class="first"><strong>Add Required Secrets</strong></p>
|
||||
<ul class="simple">
|
||||
<li>In the <tt class="docutils literal">Secrets</tt> field, add the previously configured secrets:<ul>
|
||||
<li><tt class="docutils literal">ovh_application_key</tt></li>
|
||||
<li><tt class="docutils literal">ovh_application_secret</tt></li>
|
||||
<li><tt class="docutils literal">ovh_consumer_key</tt></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p class="first"><strong>Write Python Code</strong></p>
|
||||
<ul class="simple">
|
||||
<li>Go to the <tt class="docutils literal">Code</tt> tab</li>
|
||||
<li>Enter the following Python code:</li>
|
||||
</ul>
|
||||
<pre class="code python literal-block">
|
||||
<span class="c1"># List OVHcloud instances using ovh API</span><span class="w">
|
||||
</span> <span class="n">result</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"exit_code"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"message"</span><span class="p">:</span> <span class="kc">None</span><span class="p">}</span><span class="w">
|
||||
|
||||
</span><span class="n">client</span> <span class="o">=</span> <span class="n">ovh</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="w">
|
||||
</span> <span class="n">endpoint</span><span class="o">=</span><span class="p">{{</span> <span class="n">ovh_endpoint</span> <span class="p">}},</span><span class="w">
|
||||
</span> <span class="n">application_key</span><span class="o">=</span><span class="c1">#!cxtower.secret.ovh_application_key!#,</span><span class="w">
|
||||
</span> <span class="n">application_secret</span><span class="o">=</span><span class="c1">#!cxtower.secret.ovh_application_secret!#,</span><span class="w">
|
||||
</span> <span class="n">consumer_key</span><span class="o">=</span><span class="c1">#!cxtower.secret.ovh_consumer_key!#</span><span class="w">
|
||||
</span><span class="p">)</span><span class="w">
|
||||
|
||||
</span><span class="c1"># Required variables:</span><span class="w">
|
||||
</span><span class="c1"># - domain_name: The main domain (e.g., "example.com")</span><span class="w">
|
||||
</span><span class="c1"># - subdomain: The subdomain to create (e.g., "test")</span><span class="w">
|
||||
|
||||
</span><span class="k">try</span><span class="p">:</span><span class="w">
|
||||
</span> <span class="c1"># Create a new subdomain by adding a DNS entry (A record as example)</span><span class="w">
|
||||
</span> <span class="n">ip_address</span> <span class="o">=</span> <span class="s2">"1.2.3.4"</span> <span class="c1"># Replace with the desired IP address</span><span class="w">
|
||||
</span> <span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="w">
|
||||
</span> <span class="s2">"/domain/zone/"</span> <span class="o">+</span> <span class="n">domain_name</span> <span class="o">+</span> <span class="s2">"/record"</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="n">fieldType</span><span class="o">=</span><span class="s2">"A"</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="n">subDomain</span><span class="o">=</span><span class="n">subdomain</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="n">target</span><span class="o">=</span><span class="n">ip_address</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">3600</span><span class="w">
|
||||
</span> <span class="p">)</span><span class="w">
|
||||
</span> <span class="c1"># Refresh the zone to apply changes</span><span class="w">
|
||||
</span> <span class="n">client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">"/domain/zone/"</span> <span class="o">+</span> <span class="n">domain_name</span> <span class="o">+</span> <span class="s2">"/refresh"</span><span class="p">)</span><span class="w">
|
||||
</span> <span class="n">result</span><span class="p">[</span><span class="s2">"message"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"Subdomain '"</span> <span class="o">+</span> <span class="n">subdomain</span> <span class="o">+</span> <span class="s2">"."</span> <span class="o">+</span> <span class="n">domain_name</span> <span class="o">+</span> <span class="s2">"' created and DNS zone refreshed."</span><span class="w">
|
||||
</span><span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span><span class="w">
|
||||
</span> <span class="n">result</span><span class="p">[</span><span class="s2">"exit_code"</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span><span class="w">
|
||||
</span> <span class="n">result</span><span class="p">[</span><span class="s2">"message"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"Error: "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
||||
</pre>
|
||||
</li>
|
||||
<li><p class="first"><strong>Save the Command</strong></p>
|
||||
<ul class="simple">
|
||||
<li>Click the <tt class="docutils literal">Save</tt> button to create the command</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="running-the-ovhcloud-instance-command">
|
||||
<h2><a class="toc-backref" href="#toc-entry-10">Running the OVHcloud Instance Command</a></h2>
|
||||
<ul class="simple">
|
||||
<li><strong>Navigate to Server</strong><ul>
|
||||
<li>Go to <tt class="docutils literal">Cetmix Tower > Servers > Servers</tt></li>
|
||||
<li>Open the server where you want to run the command</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>Execute Command from Server</strong><ul>
|
||||
<li>Click the <tt class="docutils literal">Command</tt> button at the top of the server form</li>
|
||||
<li>In the popup dialog:<ul>
|
||||
<li>Select your OVHcloud instance command from the dropdown</li>
|
||||
<li>Verify the variable values (if any need adjustment)</li>
|
||||
<li>Click <tt class="docutils literal">Run</tt> to execute</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><strong>View Command Results</strong><ul>
|
||||
<li>After execution, the command log will display showing:<ul>
|
||||
<li>The command executed</li>
|
||||
<li>Execution status</li>
|
||||
<li>Output message containing OVHcloud instance details if successful</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="changelog">
|
||||
<h1><a class="toc-backref" href="#toc-entry-11">Changelog</a></h1>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#toc-entry-12">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/cetmix/cetmix-tower/issues">GitHub Issues</a>.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
<a class="reference external" href="https://github.com/cetmix/cetmix-tower/issues/new?body=module:%20cetmix_tower_ovh%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#toc-entry-13">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-14">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Cetmix</li>
|
||||
<li>Giovanni Serra</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#toc-entry-15">Maintainers</a></h2>
|
||||
<p>Current maintainer:</p>
|
||||
<p><a class="reference external image-reference" href="https://github.com/GSLabIt"><img alt="GSLabIt" src="https://github.com/GSLabIt.png?size=40px" /></a></p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/cetmix/cetmix-tower/tree/18.0/cetmix_tower_ovh">cetmix/cetmix-tower</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
1
addons/cetmix_tower_ovh/tests/__init__.py
Normal file
1
addons/cetmix_tower_ovh/tests/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
from . import test_ovh_integration
|
||||
63
addons/cetmix_tower_ovh/tests/test_ovh_integration.py
Normal file
63
addons/cetmix_tower_ovh/tests/test_ovh_integration.py
Normal file
@@ -0,0 +1,63 @@
|
||||
# Copyright 2024 Cetmix OÜ
|
||||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
|
||||
from odoo.tests import common
|
||||
|
||||
|
||||
class TestOvhIntegration(common.TransactionCase):
|
||||
"""Test OVH integration with Cetmix Tower commands."""
|
||||
|
||||
def setUp(self):
|
||||
super().setUp()
|
||||
# Create a test command
|
||||
self.command = self.env["cx.tower.command"].create(
|
||||
{
|
||||
"name": "Test OVH Command",
|
||||
"action": "python_code",
|
||||
}
|
||||
)
|
||||
self.eval_context = self.env[
|
||||
"cx.tower.command"
|
||||
]._get_python_command_eval_context()
|
||||
|
||||
def test_ovh_in_evaluation_context(self):
|
||||
"""Test that ovh is added to the evaluation context."""
|
||||
self.assertIn("ovh", self.eval_context)
|
||||
ovh_obj = self.eval_context["ovh"]
|
||||
self.assertTrue(hasattr(ovh_obj, "Client"))
|
||||
|
||||
def test_ovh_in_evaluation_context_with_server(self):
|
||||
"""Test that ovh is added to the evaluation context when server is provided."""
|
||||
test_server = self.env["cx.tower.server"].create(
|
||||
{
|
||||
"name": "Test OVH Server",
|
||||
"reference": "test_ovh_server",
|
||||
"ip_v4_address": "localhost",
|
||||
"ssh_username": "admin",
|
||||
"ssh_password": "password",
|
||||
"ssh_auth_mode": "p",
|
||||
"host_key": "test_key",
|
||||
}
|
||||
)
|
||||
eval_context = self.env["cx.tower.command"]._get_python_command_eval_context(
|
||||
server=test_server
|
||||
)
|
||||
|
||||
self.assertIn("ovh", eval_context)
|
||||
ovh_obj = eval_context["ovh"]
|
||||
self.assertTrue(hasattr(ovh_obj, "Client"))
|
||||
self.assertEqual(eval_context["server"], test_server)
|
||||
|
||||
def test_ovh_client_instantiation(self):
|
||||
"""Test that ovh.Client can be instantiated from context."""
|
||||
ovh_mod = self.eval_context["ovh"]
|
||||
# Only test instantiation, do not require credentials
|
||||
try:
|
||||
client = ovh_mod.Client(
|
||||
endpoint="ovh-eu",
|
||||
application_key="a",
|
||||
application_secret="b",
|
||||
consumer_key="c",
|
||||
)
|
||||
self.assertIsNotNone(client)
|
||||
except Exception as e:
|
||||
self.fail(f"ovh.Client instantiation failed: {e}")
|
||||
Reference in New Issue
Block a user