wexample-wex-addon-services-platform 0.0.3__py3-none-any.whl

wexample_wex_addon_services_platform/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from wexample_wex_addon_services_platform.services_platform_addon_manager import (
+    ServicesPlatformAddonManager,
+)
+
+__all__ = ["ServicesPlatformAddonManager"]

wexample_wex_addon_services_platform/services/gitlab/app_service.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from wexample_wex_addon_app.service.app_service import AppService as BaseAppService
+
+
+class AppService(BaseAppService):
+    def get_workdir_contribution(self) -> dict:
+        from wexample_filestate.const.disk import DiskItemType
+
+        # Gitlab-ce manages its own internal permissions (runs as root),
+        # we just ensure the host directories exist before first docker up.
+        def _dir(name: str) -> dict:
+            return {"name": name, "type": DiskItemType.DIRECTORY, "should_exist": True}
+
+        return {
+            "children": [
+                {
+                    "name": "gitlab",
+                    "type": DiskItemType.DIRECTORY,
+                    "should_exist": True,
+                    "children": [
+                        _dir("config"),
+                        _dir("logs"),
+                        _dir("data"),
+                        _dir("backups"),
+                    ],
+                }
+            ]
+        }

wexample_wex_addon_services_platform/services/gitlab/commands/service/install.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE, description="Configure gitlab service in app config"
+)
+def gitlab__service__install(
+    context: ExecutionContext,
+    service: AppService,
+) -> None:
+    app_name = service.app_workdir.get_config().search("global.name").get_str()
+    config_file = service.app_workdir.get_config_file()
+    config = config_file.read_config()
+
+    config.set_by_path(f"service.{service.name}.host", f"{app_name}_{service.name}")
+    config.set_by_path(f"service.{service.name}.port", 80)
+    config.set_by_path(f"service.{service.name}.port_ssh", 4567)
+
+    config_file.write_config(config)
+    service.app_workdir.get_runtime_config(rebuild=True)
+
+    context.io.log(f"Configured gitlab service for app '{app_name}'")

wexample_wex_addon_services_platform/services/gitlab/commands/service/ready.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_app.response.boolean_response import BooleanResponse
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(type=COMMAND_TYPE_SERVICE, description="Check if gitlab service is ready")
+def gitlab__service__ready(
+    context: ExecutionContext,
+    service: AppService,
+) -> BooleanResponse:
+    import subprocess
+
+    from wexample_app.response.boolean_response import BooleanResponse
+
+    runtime = service.app_workdir.get_runtime_config()
+    app_project_name = runtime.search("app.project_name").get_str()
+    container_name = f"{app_project_name}_{service.name}"
+
+    result = subprocess.run(
+        ["docker", "exec", container_name, "gitlab-healthcheck"],
+        capture_output=True,
+    )
+
+    return BooleanResponse(kernel=context.kernel, content=result.returncode == 0)

wexample_wex_addon_services_platform/services/gitlab/docker/docker-compose.yml

@@ -0,0 +1,20 @@
+services:
+  gitlab:
+    container_name: ${APP_PROJECT_NAME}_gitlab
+    image: gitlab/gitlab-ce:16.4.1-ce.0
+    hostname: ${APP_DOMAIN}
+    ports:
+      - "4567:22"
+    volumes:
+      - ${APP_PATH}gitlab/backups:/var/opt/gitlab/backups
+      - ${APP_PATH}gitlab/config:/etc/gitlab
+      - ${APP_PATH}gitlab/logs:/var/log/gitlab
+      - ${APP_PATH}gitlab/data:/var/opt/gitlab
+    environment:
+      - VIRTUAL_HOST=${APP_DOMAINS_STRING}
+      - SMTP_DOMAIN=${APP_DOMAIN}
+      - VIRTUAL_PORT=80
+      - GITLAB_SHELL_SSH_PORT=4567
+    extends:
+      file: ${SERVICE_DEFAULT_COMPOSE}
+      service: default

wexample_wex_addon_services_platform/services/gitlab/samples/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  gitlab:
+    extends:
+      file: ${SERVICE_GITLAB_COMPOSE}
+      service: gitlab

wexample_wex_addon_services_platform/services/gitlab/samples/env/prod/docker/docker-compose.yml

@@ -0,0 +1,6 @@
+services:
+  gitlab:
+    environment:
+      - LETSENCRYPT_EMAIL=${APP_EMAIL}
+      - LETSENCRYPT_HOST=${APP_DOMAINS_STRING}
+      - VIRTUAL_PROTO=https

wexample_wex_addon_services_platform/services/gitlab/samples/gitlab/backups/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/gitlab/samples/gitlab/config/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/gitlab/samples/gitlab/data/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/gitlab/samples/gitlab/logs/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/gitlab/service.yml

@@ -0,0 +1,8 @@
+name: gitlab
+tags:
+  - platform
+  - scm
+dependencies:
+  - proxy
+docker:
+  compose: docker/docker-compose.yml

wexample_wex_addon_services_platform/services/jenkins/docker/docker-compose.yml

@@ -0,0 +1,15 @@
+services:
+  jenkins:
+    extends:
+      file: ${SERVICE_DEFAULT_COMPOSE}
+      service: default
+    container_name: ${APP_PROJECT_NAME}_jenkins
+    image: jenkins/jenkins:2.60.3
+    ports:
+      - "50000:50000"
+    environment:
+      - VIRTUAL_HOST=${APP_DOMAINS_STRING}
+      - VIRTUAL_PORT=8080
+    volumes:
+      - ${APP_PATH}jenkins/config:/jenkins_config
+      - ${APP_PATH}jenkins/home:/var/jenkins_home

wexample_wex_addon_services_platform/services/jenkins/samples/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  jenkins:
+    extends:
+      file: ${SERVICE_JENKINS_COMPOSE}
+      service: jenkins

wexample_wex_addon_services_platform/services/jenkins/samples/env/prod/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  jenkins:
+    environment:
+      - LETSENCRYPT_HOST=${APP_DOMAINS_STRING}
+      - LETSENCRYPT_EMAIL=${APP_EMAIL}

wexample_wex_addon_services_platform/services/jenkins/samples/jenkins/config/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/jenkins/samples/jenkins/home/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/jenkins/service.yml

@@ -0,0 +1,8 @@
+name: jenkins
+tags:
+  - platform
+  - ci
+dependencies:
+  - proxy
+docker:
+  compose: docker/docker-compose.yml

wexample_wex_addon_services_platform/services/listmonk/docker/docker-compose.yml

@@ -0,0 +1,21 @@
+services:
+  listmonk:
+    container_name: ${APP_PROJECT_NAME}_listmonk
+    image: listmonk/listmonk:v2.5.1
+    ports:
+      - 9000:9000
+    environment:
+      - VIRTUAL_HOST=${APP_DOMAINS_STRING}
+      - TZ=Europe/Paris
+      - LISTMONK_app__address=:9000
+      - LISTMONK_db__host=${SERVICE_POSTGRES_HOST}
+      - LISTMONK_db__port=${SERVICE_POSTGRES_PORT}
+      - LISTMONK_db__user=${SERVICE_POSTGRES_USER}
+      - LISTMONK_db__password=${SERVICE_POSTGRES_PASSWORD}
+      - LISTMONK_db__database=${SERVICE_POSTGRES_NAME}
+    volumes:
+      - ${APP_PATH}config.toml:/listmonk/config.toml
+    extends:
+      file: ${SERVICE_DEFAULT_COMPOSE}
+      service: default
+    command: [sh, -c, "yes | ./listmonk --install && ./listmonk"]

wexample_wex_addon_services_platform/services/listmonk/samples/config.toml

@@ -0,0 +1,2 @@
+[db]
+ssl_mode = "disable"

wexample_wex_addon_services_platform/services/listmonk/samples/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  listmonk:
+    extends:
+      file: ${SERVICE_LISTMONK_COMPOSE}
+      service: listmonk

wexample_wex_addon_services_platform/services/listmonk/samples/env/dev/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  listmonk:
+    environment:
+      - LETSENCRYPT_HOST=${APP_DOMAINS_STRING}
+      - LETSENCRYPT_EMAIL=${APP_EMAIL}

wexample_wex_addon_services_platform/services/listmonk/samples/env/prod/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  listmonk:
+    environment:
+      - LETSENCRYPT_HOST=${APP_DOMAINS_STRING}
+      - LETSENCRYPT_EMAIL=${APP_EMAIL}

wexample_wex_addon_services_platform/services/listmonk/service.yml

@@ -0,0 +1,9 @@
+name: listmonk
+tags:
+  - platform
+  - marketing
+dependencies:
+  - postgres
+  - proxy
+docker:
+  compose: docker/docker-compose.yml

wexample_wex_addon_services_platform/services/n8n/app_service.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from wexample_wex_addon_app.service.app_service import AppService as BaseAppService
+
+
+class AppService(BaseAppService):
+    def get_workdir_contribution(self) -> dict:
+        from wexample_filestate.const.disk import DiskItemType
+
+        # n8n container runs as uid 1000 (node user)
+        return {
+            "children": [
+                {
+                    "name": "n8n",
+                    "type": DiskItemType.DIRECTORY,
+                    "should_exist": True,
+                    "mode": {
+                        "owner": "1000:1000",
+                        "permissions": "750",
+                        "recursive": True,
+                    },
+                },
+            ]
+        }

wexample_wex_addon_services_platform/services/n8n/commands/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/n8n/commands/service/__init__.py

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/n8n/commands/service/install.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(
+    type=COMMAND_TYPE_SERVICE,
+    description="Configure n8n service in app config",
+)
+def n8n__service__install(
+    context: ExecutionContext,
+    service: AppService,
+) -> None:
+    from wexample_helpers.helpers.string import string_random_password
+
+    config_file = service.app_workdir.get_config_file()
+    config = config_file.read_config()
+
+    config.set_by_path(f"service.{service.name}.basic_auth.user", "admin")
+    config.set_by_path(
+        f"service.{service.name}.basic_auth.password",
+        string_random_password(),
+    )
+
+    config_file.write_config(config)
+    service.app_workdir.get_runtime_config(rebuild=True)
+
+    context.io.log("Configured n8n service defaults")

wexample_wex_addon_services_platform/services/n8n/commands/service/ready.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_app.response.boolean_response import BooleanResponse
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(type=COMMAND_TYPE_SERVICE, description="Check if n8n service is ready")
+def n8n__service__ready(
+    context: ExecutionContext,
+    service: AppService,
+) -> BooleanResponse:
+    import subprocess
+
+    from wexample_app.response.boolean_response import BooleanResponse
+
+    runtime = service.app_workdir.get_runtime_config()
+    app_project_name = runtime.search("app.project_name").get_str()
+    container_name = f"{app_project_name}_{service.name}"
+
+    result = subprocess.run(
+        [
+            "docker",
+            "exec",
+            container_name,
+            "curl",
+            "-sf",
+            "http://localhost:5678/healthz",
+        ],
+        capture_output=True,
+    )
+
+    return BooleanResponse(kernel=context.kernel, content=result.returncode == 0)

wexample_wex_addon_services_platform/services/n8n/docker/docker-compose.yml

@@ -0,0 +1,21 @@
+services:
+  n8n:
+    container_name: ${APP_PROJECT_NAME}_n8n
+    image: n8nio/n8n:1.113.3
+    ports:
+      - 5678:5678
+    environment:
+      - VIRTUAL_HOST=${APP_DOMAINS_STRING}
+      - VIRTUAL_PORT=5678
+      - N8N_BASIC_AUTH_ACTIVE=true
+      - N8N_BASIC_AUTH_USER=${SERVICE_N8N_BASIC_AUTH_USER}
+      - N8N_BASIC_AUTH_PASSWORD=${SERVICE_N8N_BASIC_AUTH_PASSWORD}
+      - N8N_HOST=${APP_DOMAIN}
+      - N8N_PROTOCOL=https
+      - NODE_ENV=production
+      - WEBHOOK_TUNNEL_URL=https://${APP_DOMAIN}/
+      - GENERIC_TIMEZONE=Europe/Paris
+    volumes:
+      - ${APP_PATH}n8n:/home/node/.n8n
+    networks:
+      - wex_net

wexample_wex_addon_services_platform/services/n8n/samples/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  n8n:
+    extends:
+      file: ${SERVICE_N8N_COMPOSE}
+      service: n8n

wexample_wex_addon_services_platform/services/n8n/samples/env/dev/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  n8n:
+    environment:
+      - LETSENCRYPT_HOST=${APP_DOMAINS_STRING}
+      - LETSENCRYPT_EMAIL=${APP_EMAIL}

wexample_wex_addon_services_platform/services/n8n/samples/env/prod/docker/docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  n8n:
+    environment:
+      - N8N_PORT=443
+      - LETSENCRYPT_HOST=${APP_DOMAINS_STRING}
+      - LETSENCRYPT_EMAIL=${APP_EMAIL}
+    ports:
+      - 5678:443

wexample_wex_addon_services_platform/services/n8n/samples/n8n/.gitkeep

@@ -0,0 +1 @@
+

wexample_wex_addon_services_platform/services/n8n/service.yml

@@ -0,0 +1,8 @@
+name: n8n
+tags:
+  - platform
+  - automation
+dependencies:
+  - proxy
+docker:
+  compose: docker/docker-compose.yml

wexample_wex_addon_services_platform/services/nextcloud/app_service.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from wexample_wex_addon_app.service.app_service import AppService as BaseAppService
+
+
+class AppService(BaseAppService):
+    def get_workdir_contribution(self) -> dict:
+        from wexample_filestate.const.disk import DiskItemType
+
+        # Nextcloud container runs as uid 33 (www-data)
+        nc_mode = {"owner": "33:33", "permissions": "750", "recursive": True}
+
+        return {
+            "children": [
+                {
+                    "name": "nextcloud",
+                    "type": DiskItemType.DIRECTORY,
+                    "should_exist": True,
+                    "children": [
+                        {
+                            "name": "data",
+                            "type": DiskItemType.DIRECTORY,
+                            "should_exist": True,
+                            "mode": nc_mode,
+                        },
+                    ],
+                },
+            ]
+        }

wexample_wex_addon_services_platform/services/nextcloud/commands/service/ready.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_wex_core.const.globals import COMMAND_TYPE_SERVICE
+from wexample_wex_core.decorator.command import command
+
+if TYPE_CHECKING:
+    from wexample_app.response.boolean_response import BooleanResponse
+    from wexample_wex_addon_app.service.app_service import AppService
+    from wexample_wex_core.context.execution_context import ExecutionContext
+
+
+@command(type=COMMAND_TYPE_SERVICE, description="Check if nextcloud service is ready")
+def nextcloud__service__ready(
+    context: ExecutionContext,
+    service: AppService,
+) -> BooleanResponse:
+    import subprocess
+
+    from wexample_app.response.boolean_response import BooleanResponse
+
+    runtime = service.app_workdir.get_runtime_config()
+    app_project_name = runtime.search("app.project_name").get_str()
+    container_name = f"{app_project_name}_{service.name}"
+
+    result = subprocess.run(
+        [
+            "docker",
+            "exec",
+            container_name,
+            "curl",
+            "-sf",
+            "http://localhost/status.php",
+        ],
+        capture_output=True,
+    )
+
+    return BooleanResponse(kernel=context.kernel, content=result.returncode == 0)