Module Architecture

flowchart TD
    BASE["sadeem_saas_base\nSAAS Base"]
    NPM["sadeem_nginx_proxy_manager\nNginx Proxy Manager"]
    CF["sadeem_cloudflare\nCloudflare"]

    RS["sadeem.root.server (inherit)\ninstall Portainer via SSH\ncreate admin + API key"]
    P["sadeem.portainer\nServer URL · API key\nstack & container operations"]
    ENV["sadeem.portainer.environment\nDocker host · capacity tracking\nNginx · Cloudflare defaults"]
    IMG["sadeem.portainer.image\nDocker image config\nenvironment assignment strategy"]
    IMGTAG["sadeem.portainer.image.tag\nversion tags per image"]
    IMGENV["sadeem.portainer.image.environment\nimage to environment mapping"]
    PG["sadeem.postgresql.server\nPostgres server config\nadded by portainer module"]
    EXT[/Portainer API\nAPI key auth/]

    BASE --> RS
    NPM --> P
    CF --> P

    RS --> A1([action_install_portainer\ndeploy via SSH + create admin + API key])
    RS --> A2([action_install_portainer_master\ndeploy as Portainer master node])

    P --> A3([action_confirm\nvalidate API key → active])
    P --> A4([action_open_portainer_panel\nopen Portainer web UI])
    P --> A5([action_create_stack\ndeploy new Docker stack])
    P --> A6([action_update_stack\nredeploy with new compose config])
    P --> A7([action_stack_actions\nstart or stop stack])
    P --> A8([action_delete_stack\nremove stack from Docker host])
    P --> A9([action_check_stack_status\nGET stack + container states → chatter])
    P --> A10([action_docker_actions\nrestart / start / stop container])
    P --> A11([action_docker_exec\nexecute command in container])

    ENV --> A12([get_best_environment\npick env by sequence or lowest usage])
    ENV --> A13([get_environment_info\nsync live capacity from Portainer])

    IMG --> IMGTAG
    IMG --> IMGENV
    IMGENV --> ENV
    P --> ENV
    P --> PG

    A3 --> EXT
    A5 --> EXT
    A6 --> EXT
    A7 --> EXT
    A8 --> EXT
    A9 --> EXT
    A10 --> EXT
    A11 --> EXT

Module Description

Integrates Odoo with the Portainer API for Docker infrastructure orchestration.

Dependencies

• mail
• sadeem_saas_base
• sadeem_nginx_proxy_manager
• sadeem_cloudflare

Menus

SAAS Management
└─ Infrastructure
    └─ Portainer
        ├─ Portainer Servers
        ├─ Environments
        ├─ Image Config
        └─ Image Tags

Key Fields

Portainer Server (sadeem.portainer)

Portainer Environment (sadeem.portainer.environment)

Docker Image Config (sadeem.portainer.image)

Image Environment Mapping (sadeem.portainer.image.environment)

Lifecycle & States

Portainer Server States

Transitions: - draft → confirm: action_confirm — validates portainer_link and portainer_access_token are set - confirm → draft: action_reset_draft - Any → cancel: action_cancel

Environment Capacity States

Updated automatically when get_environment_info syncs container counts from Portainer.

Key Actions

Warnings & Important Notes

• Missing API credentials: action_confirm raises UserError('Missing required data') if portainer_link or portainer_access_token is not set.
• SSL verification skipped by default: skip_ssl_verify=True on the portainer server — change this in production if using valid certs.
• Port tracking: next_port on the environment is incremented each time a subscription is provisioned; it must be initialized correctly to avoid port conflicts.
• Capacity tracking: available_container_capacity is computed as max_running_container_count − container_run; the environment moves to over state when this reaches zero.
• Environment selection strategy: select_environment_by = 'sequence' picks the first available environment in order; 'used' picks the one with lowest running container count.
• PostgreSQL server inheritance: Fields on sadeem.postgresql.server are extended by this module (added portainer_id linking).