Tower: upload cetmix_tower_aws 18.0.1.0.1 (was 18.0.1.0.1, via marketplace)
This commit is contained in:
308
addons/cetmix_tower_aws/README.rst
Normal file
308
addons/cetmix_tower_aws/README.rst
Normal file
@@ -0,0 +1,308 @@
|
|||||||
|
================
|
||||||
|
Cetmix Tower AWS
|
||||||
|
================
|
||||||
|
|
||||||
|
..
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
!! This file is generated by oca-gen-addon-readme !!
|
||||||
|
!! changes will be overwritten. !!
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
!! source digest: sha256:e427fa4368b78aacbc6faa6232b54496e83fbe4905ddef4cc17f3913e5ee3ee0
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
|
||||||
|
.. |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_aws
|
||||||
|
:alt: cetmix/cetmix-tower
|
||||||
|
|
||||||
|
|badge1| |badge2| |badge3|
|
||||||
|
|
||||||
|
**⚠️ DISCLAIMER: TECHNICAL MODULE**
|
||||||
|
|
||||||
|
This module integrates Boto3 library, the Amazon Web Services (AWS)
|
||||||
|
Software Development Kit (SDK) for Python, into the Cetmix Tower.
|
||||||
|
|
||||||
|
**This is a technical module intended for system administrators or
|
||||||
|
DevOps professionals.** It may involve server configuration,
|
||||||
|
infrastructure management, or advanced setup outside the standard
|
||||||
|
Odoo interface. Not intended for direct use by end users.
|
||||||
|
|
||||||
|
**Table of contents**
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
|
||||||
|
Use Cases / Context
|
||||||
|
===================
|
||||||
|
|
||||||
|
Although Amazon Web Services (AWS) allows API calls without using an
|
||||||
|
SDK, we found that integrating the Amazon SDK into Cetmix Tower makes
|
||||||
|
provisioning, configuring, and maintaining AWS 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
|
||||||
|
=============
|
||||||
|
|
||||||
|
**Prerequisites**
|
||||||
|
|
||||||
|
The module has ``boto3`` defined in its external dependencies, which
|
||||||
|
means, you should install the Python ``boto3`` package manually if you
|
||||||
|
don't have automatic package installation configured in your Odoo
|
||||||
|
environment. Run ``pip install boto3`` to install it.
|
||||||
|
|
||||||
|
**Setting up AWS Access**
|
||||||
|
|
||||||
|
1. **Create AWS Access Keys**
|
||||||
|
|
||||||
|
To use the AWS integration with Cetmix Tower, you need to create AWS
|
||||||
|
access keys:
|
||||||
|
|
||||||
|
- Follow the `official AWS
|
||||||
|
documentation <https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html>`__
|
||||||
|
(https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)
|
||||||
|
for creating IAM access keys
|
||||||
|
- It's recommended to create a dedicated IAM user with appropriate
|
||||||
|
permissions for Cetmix Tower
|
||||||
|
- Store your access key ID and secret access key securely - you'll
|
||||||
|
need them in the next step
|
||||||
|
|
||||||
|
2. **Configure AWS Secrets in Cetmix Tower**
|
||||||
|
|
||||||
|
Create two secrets in Cetmix Tower to store your AWS credentials:
|
||||||
|
|
||||||
|
- Navigate to ``Cetmix Tower > Settings > Keys and Secrets``
|
||||||
|
- Create a new Secret with:
|
||||||
|
|
||||||
|
- Name: ``AWS Access Key``
|
||||||
|
- Reference: ``aws_access_key``
|
||||||
|
- Key Type: ``Secret``
|
||||||
|
|
||||||
|
- Enter your AWS access key ID in the Secret Value tab
|
||||||
|
- Similarly, create another Secret with:
|
||||||
|
|
||||||
|
- Name: ``AWS Secret Access Key``
|
||||||
|
- Reference: ``aws_secret_access_key``
|
||||||
|
- Key Type: ``Secret``
|
||||||
|
|
||||||
|
- Enter your AWS secret access key in the Secret Value tab
|
||||||
|
|
||||||
|
..
|
||||||
|
|
||||||
|
Note: These secrets will be accessible as
|
||||||
|
``#!cxtower.secret.aws_access_key!#`` and
|
||||||
|
``#!cxtower.secret.aws_secret_access_key!#`` in your commands.
|
||||||
|
|
||||||
|
3. **Configure AWS Region**
|
||||||
|
|
||||||
|
Create a variable to define your AWS region:
|
||||||
|
|
||||||
|
- Navigate to ``Cetmix Tower > Settings > Variables``
|
||||||
|
- Create a new Variable with:
|
||||||
|
|
||||||
|
- Name: ``AWS Region Name``
|
||||||
|
- Reference: ``aws_region_name``
|
||||||
|
- Type: ``String``
|
||||||
|
|
||||||
|
- Set your AWS region (e.g., ``us-east-1``, ``eu-west-1``) as the
|
||||||
|
value
|
||||||
|
|
||||||
|
Usage
|
||||||
|
=====
|
||||||
|
|
||||||
|
Please check the `official Boto3
|
||||||
|
Documentation <https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>`__
|
||||||
|
(https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) for
|
||||||
|
the detailed information about the services and methods provided by the
|
||||||
|
Boto3 library.
|
||||||
|
|
||||||
|
**Disclaimer**: The following example demonstrates one of many
|
||||||
|
possible commands you can create and run with this module. The boto3
|
||||||
|
library provides access to the full range of AWS services and methods
|
||||||
|
- this is just a starting point to help you get familiar with the
|
||||||
|
integration.
|
||||||
|
|
||||||
|
Example of Cetmix Tower Python Command to List EC2 Instances
|
||||||
|
------------------------------------------------------------
|
||||||
|
|
||||||
|
Navigate to Command Creation
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
- Go to ``Cetmix Tower > Commands > Commands``
|
||||||
|
- Click the ``Create`` button
|
||||||
|
|
||||||
|
Configure Command Settings
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
- Set a descriptive ``Name`` (e.g., "List AWS EC2 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., "aws", "ec2") for better organization
|
||||||
|
|
||||||
|
Add Required Variables
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
- In the ``Variables`` tab, add the previously configured variable:
|
||||||
|
|
||||||
|
- ``aws_region_name``
|
||||||
|
|
||||||
|
Add Required Secrets
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
- In the ``Secrets`` field, add the previously configured secrets:
|
||||||
|
|
||||||
|
- ``aws_access_key``
|
||||||
|
- ``aws_secret_access_key``
|
||||||
|
|
||||||
|
Write Python Code
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
- Go to the ``Code`` tab
|
||||||
|
|
||||||
|
- Enter the following Python code:
|
||||||
|
|
||||||
|
.. code:: python
|
||||||
|
|
||||||
|
# List EC2 instances using boto3
|
||||||
|
result = {"exit_code": 0, "message": None}
|
||||||
|
|
||||||
|
session = boto3.Session(
|
||||||
|
aws_access_key_id=#!cxtower.secret.aws_access_key!#,
|
||||||
|
aws_secret_access_key=#!cxtower.secret.aws_secret_access_key!#,
|
||||||
|
region_name={{ aws_region_name }}
|
||||||
|
)
|
||||||
|
ec2 = session.client('ec2')
|
||||||
|
instances = ec2.describe_instances()
|
||||||
|
|
||||||
|
instance_details = []
|
||||||
|
for reservation in instances['Reservations']:
|
||||||
|
for instance in reservation['Instances']:
|
||||||
|
instance_detail = "Instance ID: " + instance['InstanceId']
|
||||||
|
instance_detail += ", Type: " + instance.get('InstanceType', 'Unknown')
|
||||||
|
instance_detail += ", State: " + instance.get('State', {}).get('Name', 'Unknown')
|
||||||
|
instance_details.append(instance_detail)
|
||||||
|
|
||||||
|
if instance_details:
|
||||||
|
result["message"] = "Found " + str(len(instance_details)) + " EC2 instances:\n" + "\n".join(instance_details)
|
||||||
|
else:
|
||||||
|
result["message"] = "No EC2 instances found"
|
||||||
|
|
||||||
|
Save the Command
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
- Click the ``Save`` button to create the command
|
||||||
|
|
||||||
|
Running the AWS EC2 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 AWS EC2 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 EC2 instance details if successful
|
||||||
|
|
||||||
|
Example Output
|
||||||
|
--------------
|
||||||
|
|
||||||
|
For a successful execution with EC2 instances:
|
||||||
|
|
||||||
|
.. code:: bash
|
||||||
|
|
||||||
|
Found 3 EC2 instances:
|
||||||
|
Instance ID: i-0abc123def456789, Type: t2.micro, State: running
|
||||||
|
Instance ID: i-0def456abc789123, Type: t3.medium, State: stopped
|
||||||
|
Instance ID: i-0789abc123def456, Type: m5.large, State: running
|
||||||
|
|
||||||
|
For a successful execution with no EC2 instances:
|
||||||
|
|
||||||
|
.. code:: bash
|
||||||
|
|
||||||
|
No EC2 instances found
|
||||||
|
|
||||||
|
Creating Additional AWS Commands
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
The cetmix_tower_aws module provides access to the boto3 Python library
|
||||||
|
for AWS service integration. Here are some common services you can use:
|
||||||
|
|
||||||
|
.. code:: python
|
||||||
|
|
||||||
|
# Standard client initialization pattern
|
||||||
|
client = boto3.client(
|
||||||
|
'service_name', # Replace with: ec2, s3, rds, cloudwatch, etc.
|
||||||
|
region_name={{ aws_region_name }},
|
||||||
|
aws_access_key_id=#!cxtower.secret.aws_access_key!#,
|
||||||
|
aws_secret_access_key=#!cxtower.secret.aws_secret_access_key!#
|
||||||
|
)
|
||||||
|
|
||||||
|
# Or use resource interface for object-oriented access
|
||||||
|
resource = boto3.resource(
|
||||||
|
'service_name', # Replace with: ec2, s3, etc.
|
||||||
|
region_name={{ aws_region_name }},
|
||||||
|
aws_access_key_id=#!cxtower.secret.aws_access_key!#,
|
||||||
|
aws_secret_access_key=#!cxtower.secret.aws_secret_access_key!#
|
||||||
|
)
|
||||||
|
|
||||||
|
Popular AWS services include: EC2 (compute), S3 (storage), RDS
|
||||||
|
(databases), and CloudWatch (monitoring).
|
||||||
|
|
||||||
|
For more details, see the `AWS Boto3
|
||||||
|
Documentation <https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>`__.
|
||||||
|
|
||||||
|
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_aws%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
|
||||||
|
|
||||||
|
Maintainers
|
||||||
|
-----------
|
||||||
|
|
||||||
|
This module is part of the `cetmix/cetmix-tower <https://github.com/cetmix/cetmix-tower/tree/18.0/cetmix_tower_aws>`_ project on GitHub.
|
||||||
|
|
||||||
|
You are welcome to contribute.
|
||||||
1
addons/cetmix_tower_aws/__init__.py
Normal file
1
addons/cetmix_tower_aws/__init__.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
from . import models
|
||||||
24
addons/cetmix_tower_aws/__manifest__.py
Normal file
24
addons/cetmix_tower_aws/__manifest__.py
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Copyright 2024 Cetmix OÜ
|
||||||
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
|
||||||
|
|
||||||
|
{
|
||||||
|
"name": "Cetmix Tower AWS",
|
||||||
|
"summary": """Cetmix Tower AWS EC2 API integration""",
|
||||||
|
"version": "18.0.1.0.1",
|
||||||
|
"category": "Productivity",
|
||||||
|
"license": "AGPL-3",
|
||||||
|
"author": "Cetmix",
|
||||||
|
"website": "https://tower.cetmix.com",
|
||||||
|
"live_test_url": "https://tower.cetmix.com/download",
|
||||||
|
"images": ["static/description/banner.png"],
|
||||||
|
"installable": True,
|
||||||
|
"external_dependencies": {
|
||||||
|
"python": ["boto3"],
|
||||||
|
},
|
||||||
|
"depends": [
|
||||||
|
"cetmix_tower_server",
|
||||||
|
],
|
||||||
|
"demo": [
|
||||||
|
"demo/demo_data.xml",
|
||||||
|
],
|
||||||
|
}
|
||||||
74
addons/cetmix_tower_aws/demo/demo_data.xml
Normal file
74
addons/cetmix_tower_aws/demo/demo_data.xml
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8" ?>
|
||||||
|
<odoo noupdate="1">
|
||||||
|
<!-- ===============================================
|
||||||
|
Keys
|
||||||
|
================================================ -->
|
||||||
|
<record id="aws_access_key" model="cx.tower.key">
|
||||||
|
<field name="name">AWS Access Key</field>
|
||||||
|
<field name="reference">aws_access_key</field>
|
||||||
|
<field name="key_type">s</field>
|
||||||
|
<field name="secret_value">AKIAIOSFODNN7EXAMPLE</field>
|
||||||
|
</record>
|
||||||
|
|
||||||
|
<record id="aws_secret_access_key" model="cx.tower.key">
|
||||||
|
<field name="name">AWS Secret Access Key</field>
|
||||||
|
<field name="reference">aws_secret_access_key</field>
|
||||||
|
<field name="key_type">s</field>
|
||||||
|
<field name="secret_value">wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY</field>
|
||||||
|
</record>
|
||||||
|
|
||||||
|
<!-- ===============================================
|
||||||
|
Variables
|
||||||
|
================================================ -->
|
||||||
|
<record id="variable_aws_region_name" model="cx.tower.variable">
|
||||||
|
<field name="name">AWS Region Name</field>
|
||||||
|
<field name="reference">aws_region_name</field>
|
||||||
|
</record>
|
||||||
|
|
||||||
|
<!-- ===============================================
|
||||||
|
Global Variable values
|
||||||
|
================================================ -->
|
||||||
|
<record id="global_value_aws_region" model="cx.tower.variable.value">
|
||||||
|
<field name="variable_id" ref="variable_aws_region_name" />
|
||||||
|
<field name="value_char">us-east-1</field>
|
||||||
|
</record>
|
||||||
|
|
||||||
|
<!-- ===============================================
|
||||||
|
Commands
|
||||||
|
================================================ -->
|
||||||
|
<record id="command_list_ec2_instances" model="cx.tower.command">
|
||||||
|
<field name="name">List AWS EC2 Instances</field>
|
||||||
|
<field name="action">python_code</field>
|
||||||
|
<field name="code">
|
||||||
|
# List EC2 instances using boto3
|
||||||
|
result = {"exit_code": 0, "message": None}
|
||||||
|
|
||||||
|
session = boto3.Session(
|
||||||
|
aws_access_key_id=#!cxtower.secret.aws_access_key!#,
|
||||||
|
aws_secret_access_key=#!cxtower.secret.aws_secret_access_key!#,
|
||||||
|
region_name={{ aws_region_name }}
|
||||||
|
)
|
||||||
|
ec2 = session.client('ec2')
|
||||||
|
instances = ec2.describe_instances()
|
||||||
|
|
||||||
|
instance_details = []
|
||||||
|
for reservation in instances['Reservations']:
|
||||||
|
for instance in reservation['Instances']:
|
||||||
|
instance_detail = "Instance ID: " + instance['InstanceId']
|
||||||
|
instance_detail += ", Type: " + instance.get('InstanceType', 'Unknown')
|
||||||
|
instance_detail += ", State: " + instance.get('State', {}).get('Name', 'Unknown')
|
||||||
|
instance_details.append(instance_detail)
|
||||||
|
|
||||||
|
if instance_details:
|
||||||
|
result["message"] = "Found " + str(len(instance_details)) + " EC2 instances:\n" + "\n".join(instance_details)
|
||||||
|
else:
|
||||||
|
result["message"] = "No EC2 instances found"
|
||||||
|
</field>
|
||||||
|
<field name="access_level">1</field>
|
||||||
|
<field
|
||||||
|
name="tag_ids"
|
||||||
|
eval="[(6, 0, [ref('cetmix_tower_server.tag_custom')])]"
|
||||||
|
/>
|
||||||
|
<field name="note">List EC2 instances using boto3 AWS SDK</field>
|
||||||
|
</record>
|
||||||
|
</odoo>
|
||||||
31
addons/cetmix_tower_aws/i18n/cetmix_tower_aws.pot
Normal file
31
addons/cetmix_tower_aws/i18n/cetmix_tower_aws.pot
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Translation of Odoo Server.
|
||||||
|
# This file contains the translation of the following modules:
|
||||||
|
# * cetmix_tower_aws
|
||||||
|
#
|
||||||
|
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_aws
|
||||||
|
#: model:ir.model,name:cetmix_tower_aws.model_cx_tower_command
|
||||||
|
msgid "Cetmix Tower Command"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. module: cetmix_tower_aws
|
||||||
|
#. odoo-python
|
||||||
|
#: code:addons/cetmix_tower_aws/models/cx_tower_command.py:0
|
||||||
|
msgid ""
|
||||||
|
"Python 'boto3' library for AWS services. Available methods: 'client', "
|
||||||
|
"'resource', 'Session'<br/>Supports AWS services like EC2, S3, RDS, Lambda, "
|
||||||
|
"CloudWatch, etc.<br/>Please check the <a "
|
||||||
|
"href='https://boto3.amazonaws.com/v1/documentation/api/latest/index.html' "
|
||||||
|
"target='_blank'>Boto3 Documentation</a> for the detailed information about "
|
||||||
|
"the services and methods."
|
||||||
|
msgstr ""
|
||||||
39
addons/cetmix_tower_aws/i18n/it.po
Normal file
39
addons/cetmix_tower_aws/i18n/it.po
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# Translation of Odoo Server.
|
||||||
|
# This file contains the translation of the following modules:
|
||||||
|
# * cetmix_tower_aws
|
||||||
|
#
|
||||||
|
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"
|
||||||
|
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||||
|
"X-Generator: Poedit 2.3\n"
|
||||||
|
"Language: it\n"
|
||||||
|
|
||||||
|
#. module: cetmix_tower_aws
|
||||||
|
#: model:ir.model,name:cetmix_tower_aws.model_cx_tower_command
|
||||||
|
msgid "Cetmix Tower Command"
|
||||||
|
msgstr "Comando Cetmix Tower"
|
||||||
|
|
||||||
|
#. module: cetmix_tower_aws
|
||||||
|
#. odoo-python
|
||||||
|
#: code:addons/cetmix_tower_aws/models/cx_tower_command.py:0
|
||||||
|
#, python-format
|
||||||
|
msgid "Python 'boto3' library for AWS services. Available methods: 'client', 'resource', 'Session'<br/>Supports AWS services like EC2, S3, RDS, Lambda, CloudWatch, etc.<br/>Please check the <a href='https://boto3.amazonaws.com/v1/documentation/api/latest/index.html' target='_blank'>Boto3 Documentation</a> for the detailed information about the services and methods."
|
||||||
|
msgstr "Libreria Python 'boto3' per servizi AWS. Metodi disponibili: 'client', 'resource', 'Session'<br/>Supporta servizi AWS come EC2, S3, RDS, Lambda, CloudWatch, ecc.<br/>Consultare la <a href='https://boto3.amazonaws.com/v1/documentation/api/latest/index.html' target='_blank'>documentazione Boto3</a> per informazioni dettagliate su servizi e metodi."
|
||||||
|
|
||||||
|
#~ msgid ""
|
||||||
|
#~ "# - boto3: Python 'boto3' library for AWS services. Available methods: "
|
||||||
|
#~ "'client', 'resource', 'Session'\n"
|
||||||
|
#~ "# Supports AWS services like EC2, S3, RDS, Lambda, CloudWatch, etc."
|
||||||
|
#~ msgstr ""
|
||||||
|
#~ "# - boto3: libreria Python 'boto3' per servizi AWS. Metodi disponibili: "
|
||||||
|
#~ "'client', 'resource', 'Session'\n"
|
||||||
|
#~ "# Supporta servizi AWS come EC2, S3, RDS, Lambda, CloudWatch, ecc."
|
||||||
1
addons/cetmix_tower_aws/models/__init__.py
Normal file
1
addons/cetmix_tower_aws/models/__init__.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
from . import cx_tower_command
|
||||||
40
addons/cetmix_tower_aws/models/cx_tower_command.py
Normal file
40
addons/cetmix_tower_aws/models/cx_tower_command.py
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# 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 boto3 safely
|
||||||
|
boto3 = wrap_module(__import__("boto3"), ["client", "resource", "Session"])
|
||||||
|
|
||||||
|
|
||||||
|
class CxTowerCommand(models.Model):
|
||||||
|
"""Extends cx.tower.command to add AWS boto3 functionality."""
|
||||||
|
|
||||||
|
_inherit = "cx.tower.command"
|
||||||
|
|
||||||
|
def _custom_python_libraries(self):
|
||||||
|
"""
|
||||||
|
Add the boto3 library to the available libraries.
|
||||||
|
"""
|
||||||
|
custom_python_libraries = super()._custom_python_libraries()
|
||||||
|
custom_python_libraries.update(
|
||||||
|
{
|
||||||
|
"cetmix_tower_aws": {
|
||||||
|
"boto3": {
|
||||||
|
"import": boto3,
|
||||||
|
"help": _(
|
||||||
|
"Python 'boto3' library for AWS services. "
|
||||||
|
"Available methods: 'client', 'resource', 'Session'<br/>"
|
||||||
|
"Supports AWS services like EC2, S3, RDS, Lambda, "
|
||||||
|
"CloudWatch, etc.<br/>"
|
||||||
|
"Please check the <a "
|
||||||
|
"href='https://boto3.amazonaws.com/v1/documentation/api/latest/index.html'"
|
||||||
|
" target='_blank'>Boto3 Documentation</a> for the detailed "
|
||||||
|
"information about the services and methods."
|
||||||
|
),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return custom_python_libraries
|
||||||
3
addons/cetmix_tower_aws/pyproject.toml
Normal file
3
addons/cetmix_tower_aws/pyproject.toml
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["whool"]
|
||||||
|
build-backend = "whool.buildapi"
|
||||||
42
addons/cetmix_tower_aws/readme/CONFIGURE.md
Normal file
42
addons/cetmix_tower_aws/readme/CONFIGURE.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
**Prerequisites**
|
||||||
|
|
||||||
|
The module has `boto3` defined in its external dependencies, which means, you should install the Python `boto3` package manually if you don't have automatic package installation configured in your Odoo environment. Run `pip install boto3` to install it.
|
||||||
|
|
||||||
|
**Setting up AWS Access**
|
||||||
|
|
||||||
|
1. **Create AWS Access Keys**
|
||||||
|
|
||||||
|
To use the AWS integration with Cetmix Tower, you need to create AWS access keys:
|
||||||
|
|
||||||
|
- Follow the [official AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html) (https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html) for creating IAM access keys
|
||||||
|
- It's recommended to create a dedicated IAM user with appropriate permissions for Cetmix Tower
|
||||||
|
- Store your access key ID and secret access key securely - you'll need them in the next step
|
||||||
|
|
||||||
|
2. **Configure AWS Secrets in Cetmix Tower**
|
||||||
|
|
||||||
|
Create two secrets in Cetmix Tower to store your AWS credentials:
|
||||||
|
|
||||||
|
- Navigate to `Cetmix Tower > Settings > Keys and Secrets`
|
||||||
|
- Create a new Secret with:
|
||||||
|
- Name: `AWS Access Key`
|
||||||
|
- Reference: `aws_access_key`
|
||||||
|
- Key Type: `Secret`
|
||||||
|
- Enter your AWS access key ID in the Secret Value tab
|
||||||
|
- Similarly, create another Secret with:
|
||||||
|
- Name: `AWS Secret Access Key`
|
||||||
|
- Reference: `aws_secret_access_key`
|
||||||
|
- Key Type: `Secret`
|
||||||
|
- Enter your AWS secret access key in the Secret Value tab
|
||||||
|
|
||||||
|
> Note: These secrets will be accessible as `#!cxtower.secret.aws_access_key!#` and `#!cxtower.secret.aws_secret_access_key!#` in your commands.
|
||||||
|
|
||||||
|
3. **Configure AWS Region**
|
||||||
|
|
||||||
|
Create a variable to define your AWS region:
|
||||||
|
|
||||||
|
- Navigate to `Cetmix Tower > Settings > Variables`
|
||||||
|
- Create a new Variable with:
|
||||||
|
- Name: `AWS Region Name`
|
||||||
|
- Reference: `aws_region_name`
|
||||||
|
- Type: `String`
|
||||||
|
- Set your AWS region (e.g., `us-east-1`, `eu-west-1`) as the value
|
||||||
5
addons/cetmix_tower_aws/readme/CONTEXT.md
Normal file
5
addons/cetmix_tower_aws/readme/CONTEXT.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
Although Amazon Web Services (AWS) allows API calls without using an SDK, we found that
|
||||||
|
integrating the Amazon SDK into Cetmix Tower makes provisioning, configuring, and
|
||||||
|
maintaining AWS 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.
|
||||||
6
addons/cetmix_tower_aws/readme/DESCRIPTION.md
Normal file
6
addons/cetmix_tower_aws/readme/DESCRIPTION.md
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
**⚠️ DISCLAIMER: TECHNICAL MODULE**
|
||||||
|
|
||||||
|
This module integrates Boto3 library, the Amazon Web Services (AWS) Software Development Kit (SDK) for Python, into the Cetmix Tower.
|
||||||
|
|
||||||
|
> **This is a technical module intended for system administrators or DevOps professionals.** It may involve server configuration, infrastructure management, or advanced setup outside the standard Odoo interface. Not intended for direct use by end users.
|
||||||
|
|
||||||
0
addons/cetmix_tower_aws/readme/HISTORY.md
Normal file
0
addons/cetmix_tower_aws/readme/HISTORY.md
Normal file
121
addons/cetmix_tower_aws/readme/USAGE.md
Normal file
121
addons/cetmix_tower_aws/readme/USAGE.md
Normal file
@@ -0,0 +1,121 @@
|
|||||||
|
Please check the [official Boto3 Documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) (https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) for the detailed information about the services and methods provided by the Boto3 library.
|
||||||
|
|
||||||
|
> **Disclaimer**: The following example demonstrates one of many possible commands you can create and run with this module. The boto3 library provides access to the full range of AWS services and methods - this is just a starting point to help you get familiar with the integration.
|
||||||
|
|
||||||
|
## Example of Cetmix Tower Python Command to List EC2 Instances
|
||||||
|
|
||||||
|
### Navigate to Command Creation
|
||||||
|
- Go to `Cetmix Tower > Commands > Commands`
|
||||||
|
- Click the `Create` button
|
||||||
|
|
||||||
|
### Configure Command Settings
|
||||||
|
- Set a descriptive `Name` (e.g., "List AWS EC2 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., "aws", "ec2") for better organization
|
||||||
|
|
||||||
|
### Add Required Variables
|
||||||
|
- In the `Variables` tab, add the previously configured variable:
|
||||||
|
- `aws_region_name`
|
||||||
|
|
||||||
|
### Add Required Secrets
|
||||||
|
- In the `Secrets` field, add the previously configured secrets:
|
||||||
|
- `aws_access_key`
|
||||||
|
- `aws_secret_access_key`
|
||||||
|
|
||||||
|
### Write Python Code
|
||||||
|
- Go to the `Code` tab
|
||||||
|
- Enter the following Python code:
|
||||||
|
|
||||||
|
```python
|
||||||
|
# List EC2 instances using boto3
|
||||||
|
result = {"exit_code": 0, "message": None}
|
||||||
|
|
||||||
|
session = boto3.Session(
|
||||||
|
aws_access_key_id=#!cxtower.secret.aws_access_key!#,
|
||||||
|
aws_secret_access_key=#!cxtower.secret.aws_secret_access_key!#,
|
||||||
|
region_name={{ aws_region_name }}
|
||||||
|
)
|
||||||
|
ec2 = session.client('ec2')
|
||||||
|
instances = ec2.describe_instances()
|
||||||
|
|
||||||
|
instance_details = []
|
||||||
|
for reservation in instances['Reservations']:
|
||||||
|
for instance in reservation['Instances']:
|
||||||
|
instance_detail = "Instance ID: " + instance['InstanceId']
|
||||||
|
instance_detail += ", Type: " + instance.get('InstanceType', 'Unknown')
|
||||||
|
instance_detail += ", State: " + instance.get('State', {}).get('Name', 'Unknown')
|
||||||
|
instance_details.append(instance_detail)
|
||||||
|
|
||||||
|
if instance_details:
|
||||||
|
result["message"] = "Found " + str(len(instance_details)) + " EC2 instances:\n" + "\n".join(instance_details)
|
||||||
|
else:
|
||||||
|
result["message"] = "No EC2 instances found"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Save the Command
|
||||||
|
- Click the `Save` button to create the command
|
||||||
|
|
||||||
|
## Running the AWS EC2 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 AWS EC2 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 EC2 instance details if successful
|
||||||
|
|
||||||
|
## Example Output
|
||||||
|
|
||||||
|
For a successful execution with EC2 instances:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
Found 3 EC2 instances:
|
||||||
|
Instance ID: i-0abc123def456789, Type: t2.micro, State: running
|
||||||
|
Instance ID: i-0def456abc789123, Type: t3.medium, State: stopped
|
||||||
|
Instance ID: i-0789abc123def456, Type: m5.large, State: running
|
||||||
|
```
|
||||||
|
|
||||||
|
For a successful execution with no EC2 instances:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
No EC2 instances found
|
||||||
|
```
|
||||||
|
|
||||||
|
## Creating Additional AWS Commands
|
||||||
|
|
||||||
|
The cetmix_tower_aws module provides access to the boto3 Python library for AWS service integration. Here are some common services you can use:
|
||||||
|
|
||||||
|
```python
|
||||||
|
# Standard client initialization pattern
|
||||||
|
client = boto3.client(
|
||||||
|
'service_name', # Replace with: ec2, s3, rds, cloudwatch, etc.
|
||||||
|
region_name={{ aws_region_name }},
|
||||||
|
aws_access_key_id=#!cxtower.secret.aws_access_key!#,
|
||||||
|
aws_secret_access_key=#!cxtower.secret.aws_secret_access_key!#
|
||||||
|
)
|
||||||
|
|
||||||
|
# Or use resource interface for object-oriented access
|
||||||
|
resource = boto3.resource(
|
||||||
|
'service_name', # Replace with: ec2, s3, etc.
|
||||||
|
region_name={{ aws_region_name }},
|
||||||
|
aws_access_key_id=#!cxtower.secret.aws_access_key!#,
|
||||||
|
aws_secret_access_key=#!cxtower.secret.aws_secret_access_key!#
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
Popular AWS services include: EC2 (compute), S3 (storage), RDS (databases), and CloudWatch (monitoring).
|
||||||
|
|
||||||
|
For more details, see the [AWS Boto3 Documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html).
|
||||||
BIN
addons/cetmix_tower_aws/static/description/banner.png
Normal file
BIN
addons/cetmix_tower_aws/static/description/banner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 91 KiB |
BIN
addons/cetmix_tower_aws/static/description/icon.png
Normal file
BIN
addons/cetmix_tower_aws/static/description/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
684
addons/cetmix_tower_aws/static/description/index.html
Normal file
684
addons/cetmix_tower_aws/static/description/index.html
Normal file
@@ -0,0 +1,684 @@
|
|||||||
|
<!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 AWS</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-aws">
|
||||||
|
<h1 class="title">Cetmix Tower AWS</h1>
|
||||||
|
|
||||||
|
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
!! This file is generated by oca-gen-addon-readme !!
|
||||||
|
!! changes will be overwritten. !!
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
!! source digest: sha256:e427fa4368b78aacbc6faa6232b54496e83fbe4905ddef4cc17f3913e5ee3ee0
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||||
|
<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_aws"><img alt="cetmix/cetmix-tower" src="https://img.shields.io/badge/github-cetmix%2Fcetmix--tower-lightgray.png?logo=github" /></a></p>
|
||||||
|
<p><strong>⚠️ DISCLAIMER: TECHNICAL MODULE</strong></p>
|
||||||
|
<p>This module integrates Boto3 library, the Amazon Web Services (AWS)
|
||||||
|
Software Development Kit (SDK) for Python, into the Cetmix Tower.</p>
|
||||||
|
<blockquote>
|
||||||
|
<strong>This is a technical module intended for system administrators or
|
||||||
|
DevOps professionals.</strong> It may involve server configuration,
|
||||||
|
infrastructure management, or advanced setup outside the standard
|
||||||
|
Odoo interface. Not intended for direct use by end users.</blockquote>
|
||||||
|
<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="#usage" id="toc-entry-3">Usage</a><ul>
|
||||||
|
<li><a class="reference internal" href="#example-of-cetmix-tower-python-command-to-list-ec2-instances" id="toc-entry-4">Example of Cetmix Tower Python Command to List EC2 Instances</a><ul>
|
||||||
|
<li><a class="reference internal" href="#navigate-to-command-creation" id="toc-entry-5">Navigate to Command Creation</a></li>
|
||||||
|
<li><a class="reference internal" href="#configure-command-settings" id="toc-entry-6">Configure Command Settings</a></li>
|
||||||
|
<li><a class="reference internal" href="#add-required-variables" id="toc-entry-7">Add Required Variables</a></li>
|
||||||
|
<li><a class="reference internal" href="#add-required-secrets" id="toc-entry-8">Add Required Secrets</a></li>
|
||||||
|
<li><a class="reference internal" href="#write-python-code" id="toc-entry-9">Write Python Code</a></li>
|
||||||
|
<li><a class="reference internal" href="#save-the-command" id="toc-entry-10">Save the Command</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a class="reference internal" href="#running-the-aws-ec2-command" id="toc-entry-11">Running the AWS EC2 Command</a><ul>
|
||||||
|
<li><a class="reference internal" href="#navigate-to-server" id="toc-entry-12">Navigate to Server</a></li>
|
||||||
|
<li><a class="reference internal" href="#execute-command-from-server" id="toc-entry-13">Execute Command from Server</a></li>
|
||||||
|
<li><a class="reference internal" href="#view-command-results" id="toc-entry-14">View Command Results</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a class="reference internal" href="#example-output" id="toc-entry-15">Example Output</a></li>
|
||||||
|
<li><a class="reference internal" href="#creating-additional-aws-commands" id="toc-entry-16">Creating Additional AWS Commands</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><a class="reference internal" href="#changelog" id="toc-entry-17">Changelog</a></li>
|
||||||
|
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-18">Bug Tracker</a></li>
|
||||||
|
<li><a class="reference internal" href="#credits" id="toc-entry-19">Credits</a><ul>
|
||||||
|
<li><a class="reference internal" href="#authors" id="toc-entry-20">Authors</a></li>
|
||||||
|
<li><a class="reference internal" href="#maintainers" id="toc-entry-21">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 Amazon Web Services (AWS) allows API calls without using an
|
||||||
|
SDK, we found that integrating the Amazon SDK into Cetmix Tower makes
|
||||||
|
provisioning, configuring, and maintaining AWS 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>
|
||||||
|
<p><strong>Prerequisites</strong></p>
|
||||||
|
<p>The module has <tt class="docutils literal">boto3</tt> defined in its external dependencies, which
|
||||||
|
means, you should install the Python <tt class="docutils literal">boto3</tt> package manually if you
|
||||||
|
don’t have automatic package installation configured in your Odoo
|
||||||
|
environment. Run <tt class="docutils literal">pip install boto3</tt> to install it.</p>
|
||||||
|
<p><strong>Setting up AWS Access</strong></p>
|
||||||
|
<ol class="arabic">
|
||||||
|
<li><p class="first"><strong>Create AWS Access Keys</strong></p>
|
||||||
|
<p>To use the AWS integration with Cetmix Tower, you need to create AWS
|
||||||
|
access keys:</p>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>Follow the <a class="reference external" href="https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html">official AWS
|
||||||
|
documentation</a>
|
||||||
|
(<a class="reference external" href="https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html">https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html</a>)
|
||||||
|
for creating IAM access keys</li>
|
||||||
|
<li>It’s recommended to create a dedicated IAM user with appropriate
|
||||||
|
permissions for Cetmix Tower</li>
|
||||||
|
<li>Store your access key ID and secret access key securely - you’ll
|
||||||
|
need them in the next step</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><p class="first"><strong>Configure AWS Secrets in Cetmix Tower</strong></p>
|
||||||
|
<p>Create two secrets in Cetmix Tower to store your AWS 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">AWS Access Key</tt></li>
|
||||||
|
<li>Reference: <tt class="docutils literal">aws_access_key</tt></li>
|
||||||
|
<li>Key Type: <tt class="docutils literal">Secret</tt></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Enter your AWS access key ID in the Secret Value tab</li>
|
||||||
|
<li>Similarly, create another Secret with:<ul>
|
||||||
|
<li>Name: <tt class="docutils literal">AWS Secret Access Key</tt></li>
|
||||||
|
<li>Reference: <tt class="docutils literal">aws_secret_access_key</tt></li>
|
||||||
|
<li>Key Type: <tt class="docutils literal">Secret</tt></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Enter your AWS secret access key in the Secret Value tab</li>
|
||||||
|
</ul>
|
||||||
|
<!-- -->
|
||||||
|
<blockquote>
|
||||||
|
<p>Note: These secrets will be accessible as
|
||||||
|
<tt class="docutils literal">#!cxtower.secret.aws_access_key!#</tt> and
|
||||||
|
<tt class="docutils literal">#!cxtower.secret.aws_secret_access_key!#</tt> in your commands.</p>
|
||||||
|
</blockquote>
|
||||||
|
</li>
|
||||||
|
<li><p class="first"><strong>Configure AWS Region</strong></p>
|
||||||
|
<p>Create a variable to define your AWS 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">AWS Region Name</tt></li>
|
||||||
|
<li>Reference: <tt class="docutils literal">aws_region_name</tt></li>
|
||||||
|
<li>Type: <tt class="docutils literal">String</tt></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Set your AWS region (e.g., <tt class="docutils literal"><span class="pre">us-east-1</span></tt>, <tt class="docutils literal"><span class="pre">eu-west-1</span></tt>) as the
|
||||||
|
value</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="usage">
|
||||||
|
<h1><a class="toc-backref" href="#toc-entry-3">Usage</a></h1>
|
||||||
|
<p>Please check the <a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/index.html">official Boto3
|
||||||
|
Documentation</a>
|
||||||
|
(<a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/index.html">https://boto3.amazonaws.com/v1/documentation/api/latest/index.html</a>) for
|
||||||
|
the detailed information about the services and methods provided by the
|
||||||
|
Boto3 library.</p>
|
||||||
|
<blockquote>
|
||||||
|
<strong>Disclaimer</strong>: The following example demonstrates one of many
|
||||||
|
possible commands you can create and run with this module. The boto3
|
||||||
|
library provides access to the full range of AWS services and methods
|
||||||
|
- 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-list-ec2-instances">
|
||||||
|
<h2><a class="toc-backref" href="#toc-entry-4">Example of Cetmix Tower Python Command to List EC2 Instances</a></h2>
|
||||||
|
<div class="section" id="navigate-to-command-creation">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-5">Navigate to Command Creation</a></h3>
|
||||||
|
<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>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="configure-command-settings">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-6">Configure Command Settings</a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>Set a descriptive <tt class="docutils literal">Name</tt> (e.g., “List AWS EC2 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., “aws”, “ec2”) for better organization</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="add-required-variables">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-7">Add Required Variables</a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>In the <tt class="docutils literal">Variables</tt> tab, add the previously configured variable:<ul>
|
||||||
|
<li><tt class="docutils literal">aws_region_name</tt></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="add-required-secrets">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-8">Add Required Secrets</a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>In the <tt class="docutils literal">Secrets</tt> field, add the previously configured secrets:<ul>
|
||||||
|
<li><tt class="docutils literal">aws_access_key</tt></li>
|
||||||
|
<li><tt class="docutils literal">aws_secret_access_key</tt></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="write-python-code">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-9">Write Python Code</a></h3>
|
||||||
|
<ul>
|
||||||
|
<li><p class="first">Go to the <tt class="docutils literal">Code</tt> tab</p>
|
||||||
|
</li>
|
||||||
|
<li><p class="first">Enter the following Python code:</p>
|
||||||
|
<pre class="code python literal-block">
|
||||||
|
<span class="c1"># List EC2 instances using boto3</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">session</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">Session</span><span class="p">(</span><span class="w">
|
||||||
|
</span> <span class="n">aws_access_key_id</span><span class="o">=</span><span class="c1">#!cxtower.secret.aws_access_key!#,</span><span class="w">
|
||||||
|
</span> <span class="n">aws_secret_access_key</span><span class="o">=</span><span class="c1">#!cxtower.secret.aws_secret_access_key!#,</span><span class="w">
|
||||||
|
</span> <span class="n">region_name</span><span class="o">=</span><span class="p">{{</span> <span class="n">aws_region_name</span> <span class="p">}}</span><span class="w">
|
||||||
|
</span><span class="p">)</span><span class="w">
|
||||||
|
</span><span class="n">ec2</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="s1">'ec2'</span><span class="p">)</span><span class="w">
|
||||||
|
</span><span class="n">instances</span> <span class="o">=</span> <span class="n">ec2</span><span class="o">.</span><span class="n">describe_instances</span><span class="p">()</span><span class="w">
|
||||||
|
|
||||||
|
</span><span class="n">instance_details</span> <span class="o">=</span> <span class="p">[]</span><span class="w">
|
||||||
|
</span><span class="k">for</span> <span class="n">reservation</span> <span class="ow">in</span> <span class="n">instances</span><span class="p">[</span><span class="s1">'Reservations'</span><span class="p">]:</span><span class="w">
|
||||||
|
</span> <span class="k">for</span> <span class="n">instance</span> <span class="ow">in</span> <span class="n">reservation</span><span class="p">[</span><span class="s1">'Instances'</span><span class="p">]:</span><span class="w">
|
||||||
|
</span> <span class="n">instance_detail</span> <span class="o">=</span> <span class="s2">"Instance ID: "</span> <span class="o">+</span> <span class="n">instance</span><span class="p">[</span><span class="s1">'InstanceId'</span><span class="p">]</span><span class="w">
|
||||||
|
</span> <span class="n">instance_detail</span> <span class="o">+=</span> <span class="s2">", Type: "</span> <span class="o">+</span> <span class="n">instance</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'InstanceType'</span><span class="p">,</span> <span class="s1">'Unknown'</span><span class="p">)</span><span class="w">
|
||||||
|
</span> <span class="n">instance_detail</span> <span class="o">+=</span> <span class="s2">", State: "</span> <span class="o">+</span> <span class="n">instance</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'State'</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Unknown'</span><span class="p">)</span><span class="w">
|
||||||
|
</span> <span class="n">instance_details</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">instance_detail</span><span class="p">)</span><span class="w">
|
||||||
|
|
||||||
|
</span><span class="k">if</span> <span class="n">instance_details</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">"Found "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">instance_details</span><span class="p">))</span> <span class="o">+</span> <span class="s2">" EC2 instances:</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">instance_details</span><span class="p">)</span><span class="w">
|
||||||
|
</span><span class="k">else</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">"No EC2 instances found"</span>
|
||||||
|
</pre>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="save-the-command">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-10">Save the Command</a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>Click the <tt class="docutils literal">Save</tt> button to create the command</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="running-the-aws-ec2-command">
|
||||||
|
<h2><a class="toc-backref" href="#toc-entry-11">Running the AWS EC2 Command</a></h2>
|
||||||
|
<div class="section" id="navigate-to-server">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-12">Navigate to Server</a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<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>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="execute-command-from-server">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-13">Execute Command from Server</a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<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 AWS EC2 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>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="view-command-results">
|
||||||
|
<h3><a class="toc-backref" href="#toc-entry-14">View Command Results</a></h3>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>After execution, the command log will display showing:<ul>
|
||||||
|
<li>The command executed</li>
|
||||||
|
<li>Execution status</li>
|
||||||
|
<li>Output message containing EC2 instance details if successful</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="example-output">
|
||||||
|
<h2><a class="toc-backref" href="#toc-entry-15">Example Output</a></h2>
|
||||||
|
<p>For a successful execution with EC2 instances:</p>
|
||||||
|
<pre class="code bash literal-block">
|
||||||
|
Found<span class="w"> </span><span class="m">3</span><span class="w"> </span>EC2<span class="w"> </span>instances:<span class="w">
|
||||||
|
</span>Instance<span class="w"> </span>ID:<span class="w"> </span>i-0abc123def456789,<span class="w"> </span>Type:<span class="w"> </span>t2.micro,<span class="w"> </span>State:<span class="w"> </span>running<span class="w">
|
||||||
|
</span>Instance<span class="w"> </span>ID:<span class="w"> </span>i-0def456abc789123,<span class="w"> </span>Type:<span class="w"> </span>t3.medium,<span class="w"> </span>State:<span class="w"> </span>stopped<span class="w">
|
||||||
|
</span>Instance<span class="w"> </span>ID:<span class="w"> </span>i-0789abc123def456,<span class="w"> </span>Type:<span class="w"> </span>m5.large,<span class="w"> </span>State:<span class="w"> </span>running
|
||||||
|
</pre>
|
||||||
|
<p>For a successful execution with no EC2 instances:</p>
|
||||||
|
<pre class="code bash literal-block">
|
||||||
|
No<span class="w"> </span>EC2<span class="w"> </span>instances<span class="w"> </span>found
|
||||||
|
</pre>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="creating-additional-aws-commands">
|
||||||
|
<h2><a class="toc-backref" href="#toc-entry-16">Creating Additional AWS Commands</a></h2>
|
||||||
|
<p>The cetmix_tower_aws module provides access to the boto3 Python library
|
||||||
|
for AWS service integration. Here are some common services you can use:</p>
|
||||||
|
<pre class="code python literal-block">
|
||||||
|
<span class="c1"># Standard client initialization pattern</span><span class="w">
|
||||||
|
</span><span class="n">client</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">client</span><span class="p">(</span><span class="w">
|
||||||
|
</span> <span class="s1">'service_name'</span><span class="p">,</span> <span class="c1"># Replace with: ec2, s3, rds, cloudwatch, etc.</span><span class="w">
|
||||||
|
</span> <span class="n">region_name</span><span class="o">=</span><span class="p">{{</span> <span class="n">aws_region_name</span> <span class="p">}},</span><span class="w">
|
||||||
|
</span> <span class="n">aws_access_key_id</span><span class="o">=</span><span class="c1">#!cxtower.secret.aws_access_key!#,</span><span class="w">
|
||||||
|
</span> <span class="n">aws_secret_access_key</span><span class="o">=</span><span class="c1">#!cxtower.secret.aws_secret_access_key!#</span><span class="w">
|
||||||
|
</span><span class="p">)</span><span class="w">
|
||||||
|
|
||||||
|
</span><span class="c1"># Or use resource interface for object-oriented access</span><span class="w">
|
||||||
|
</span><span class="n">resource</span> <span class="o">=</span> <span class="n">boto3</span><span class="o">.</span><span class="n">resource</span><span class="p">(</span><span class="w">
|
||||||
|
</span> <span class="s1">'service_name'</span><span class="p">,</span> <span class="c1"># Replace with: ec2, s3, etc.</span><span class="w">
|
||||||
|
</span> <span class="n">region_name</span><span class="o">=</span><span class="p">{{</span> <span class="n">aws_region_name</span> <span class="p">}},</span><span class="w">
|
||||||
|
</span> <span class="n">aws_access_key_id</span><span class="o">=</span><span class="c1">#!cxtower.secret.aws_access_key!#,</span><span class="w">
|
||||||
|
</span> <span class="n">aws_secret_access_key</span><span class="o">=</span><span class="c1">#!cxtower.secret.aws_secret_access_key!#</span><span class="w">
|
||||||
|
</span><span class="p">)</span>
|
||||||
|
</pre>
|
||||||
|
<p>Popular AWS services include: EC2 (compute), S3 (storage), RDS
|
||||||
|
(databases), and CloudWatch (monitoring).</p>
|
||||||
|
<p>For more details, see the <a class="reference external" href="https://boto3.amazonaws.com/v1/documentation/api/latest/index.html">AWS Boto3
|
||||||
|
Documentation</a>.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="changelog">
|
||||||
|
<h1><a class="toc-backref" href="#toc-entry-17">Changelog</a></h1>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="bug-tracker">
|
||||||
|
<h1><a class="toc-backref" href="#toc-entry-18">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_aws%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-19">Credits</a></h1>
|
||||||
|
<div class="section" id="authors">
|
||||||
|
<h2><a class="toc-backref" href="#toc-entry-20">Authors</a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>Cetmix</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="maintainers">
|
||||||
|
<h2><a class="toc-backref" href="#toc-entry-21">Maintainers</a></h2>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://github.com/cetmix/cetmix-tower/tree/18.0/cetmix_tower_aws">cetmix/cetmix-tower</a> project on GitHub.</p>
|
||||||
|
<p>You are welcome to contribute.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
1
addons/cetmix_tower_aws/tests/__init__.py
Normal file
1
addons/cetmix_tower_aws/tests/__init__.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
from . import test_boto3_integration
|
||||||
64
addons/cetmix_tower_aws/tests/test_boto3_integration.py
Normal file
64
addons/cetmix_tower_aws/tests/test_boto3_integration.py
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
# Copyright 2024 Cetmix OÜ
|
||||||
|
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
|
||||||
|
from odoo.tests import common
|
||||||
|
|
||||||
|
|
||||||
|
class TestBoto3Integration(common.TransactionCase):
|
||||||
|
"""Test boto3 integration with Cetmix Tower commands."""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
super().setUp()
|
||||||
|
# Create a test command
|
||||||
|
self.command = self.env["cx.tower.command"].create(
|
||||||
|
{
|
||||||
|
"name": "Test AWS Command",
|
||||||
|
"action": "python_code",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
self.eval_context = self.env[
|
||||||
|
"cx.tower.command"
|
||||||
|
]._get_python_command_eval_context()
|
||||||
|
|
||||||
|
def test_boto3_in_evaluation_context(self):
|
||||||
|
"""Test that boto3 is added to the evaluation context."""
|
||||||
|
# Get evaluation context
|
||||||
|
# Check if boto3 is in the evaluation context
|
||||||
|
self.assertIn("boto3", self.eval_context)
|
||||||
|
# Check available methods
|
||||||
|
boto3_obj = self.eval_context["boto3"]
|
||||||
|
self.assertTrue(hasattr(boto3_obj, "client"))
|
||||||
|
self.assertTrue(hasattr(boto3_obj, "resource"))
|
||||||
|
self.assertTrue(hasattr(boto3_obj, "Session"))
|
||||||
|
|
||||||
|
def test_boto3_in_evaluation_context_with_server(self):
|
||||||
|
"""Test that boto3 is added to the evaluation context
|
||||||
|
when server is provided."""
|
||||||
|
# Create a test server
|
||||||
|
test_server = self.env["cx.tower.server"].create(
|
||||||
|
{
|
||||||
|
"name": "Test AWS Server",
|
||||||
|
"reference": "test_aws_server",
|
||||||
|
"ip_v4_address": "localhost",
|
||||||
|
"ssh_username": "admin",
|
||||||
|
"ssh_password": "password",
|
||||||
|
"ssh_auth_mode": "p",
|
||||||
|
"host_key": "test_key",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Get evaluation context with server
|
||||||
|
eval_context = self.env["cx.tower.command"]._get_python_command_eval_context(
|
||||||
|
server=test_server
|
||||||
|
)
|
||||||
|
|
||||||
|
# Check if boto3 is in the evaluation context
|
||||||
|
self.assertIn("boto3", eval_context)
|
||||||
|
|
||||||
|
# Check available methods
|
||||||
|
boto3_obj = eval_context["boto3"]
|
||||||
|
self.assertTrue(hasattr(boto3_obj, "client"))
|
||||||
|
self.assertTrue(hasattr(boto3_obj, "resource"))
|
||||||
|
self.assertTrue(hasattr(boto3_obj, "Session"))
|
||||||
|
|
||||||
|
# Verify server is correctly passed to the context
|
||||||
|
self.assertEqual(eval_context["server"], test_server)
|
||||||
Reference in New Issue
Block a user