sim-autostore/README.md

AutoStore Simulator

Dieses Projekt ist ein Simulator für das Logistiksystem "AutoStore", entwickelt in Python. Der Simulator bildet die Kernfunktionalitäten eines AutoStore-Lagers nach und wird über eine HTTP-API gesteuert, die sich an der offiziellen Schnittstellenspezifikation orientiert.

🚀 Features

• HTTP-API: Steuerung und Überwachung des Simulators über eine RESTful API.
• Port-Management: Simulation von Ein- und Auslagerungs-Ports.
• Behälter-Management (BINs): Dynamische Erstellung, Import und Generierung von Lagerbehältern.
• Task-Management: Verwaltung von Lageraufgaben (Tasks) und Auftragsgruppen (TaskGroups).
• Datenpersistenz: Speicherung des Systemzustands in einer Datenbank.

🛠️ Technologie-Stack

• Sprache: Python 3.13
• Betriebsumgebung: Docker
• Entwicklung: VS Code Dev Container

🏁 Getting Started

Voraussetzungen

• Docker Desktop
• Visual Studio Code
• Dev Containers Extension für VS Code

Installation & Start

1. Klone dieses Repository.
2. Öffne den Projektordner in Visual Studio Code.
3. Wenn du dazu aufgefordert wirst, klicke auf "Reopen in Container". VS Code wird die Entwicklungsumgebung automatisch aufsetzen.
4. Nach dem Start des Containers kann die Anwendung ausgeführt werden.

🐳 Container Deployment

Docker Image Build & Push

Das Projekt enthält CI/CD Workflows für GitHub und Gitea Actions:

• GitHub: .github/workflows/docker-build-push.yml
• Gitea: .gitea/workflows/docker-build-push.yml

Benötigte Secrets:

• REGISTRY_URL - URL der privaten Container Registry
• REGISTRY_USER - Benutzername für Registry-Zugriff
• REGISTRY_PASSWORD - Passwort für Registry-Zugriff

Ausführung:

# Manuell über GitHub/Gitea UI (workflow_dispatch)
# oder über CLI (GitHub):
gh workflow run docker-build-push.yml

Ansible Deployment

Beispiel einer Ansible-Rolle für das Deployment:

Verzeichnisstruktur

roles/
  autostore-simulator/
    tasks/
      main.yml
    templates/
      docker-compose.yml.j2
    vars/
      main.yml
    defaults/
      main.yml

roles/autostore-simulator/defaults/main.yml

---
# Container Konfiguration
autostore_image: "{{ registry_url }}/rs-sim-autostore"
autostore_tag: "latest"
autostore_container_name: "autostore-simulator"
autostore_port: 8000
autostore_network: "autostore-net"

# Registry Konfiguration
registry_url: "registry.example.com"
registry_user: "deployment"
registry_password: "{{ vault_registry_password }}"

# Datenbank Konfiguration  
autostore_db_file: "/app/data/autostore.db"
autostore_data_volume: "autostore-data"

# Systemkonfiguration
autostore_restart_policy: "unless-stopped"
autostore_log_driver: "json-file"
autostore_log_max_size: "10m"
autostore_log_max_file: "3"

roles/autostore-simulator/vars/main.yml

---
# Interne Variablen
autostore_full_image: "{{ autostore_image }}:{{ autostore_tag }}"
autostore_compose_file: "/opt/autostore/docker-compose.yml"
autostore_app_dir: "/opt/autostore"

roles/autostore-simulator/tasks/main.yml

---
- name: Create AutoStore application directory
  file:
    path: "{{ autostore_app_dir }}"
    state: directory
    mode: '0755'
    owner: root
    group: root

- name: Create AutoStore data volume
  docker_volume:
    name: "{{ autostore_data_volume }}"
    state: present

- name: Create AutoStore network
  docker_network:
    name: "{{ autostore_network }}"
    state: present

- name: Login to container registry
  docker_login:
    registry_url: "{{ registry_url }}"
    username: "{{ registry_user }}"
    password: "{{ registry_password }}"
  when: registry_url is defined

- name: Pull AutoStore image
  docker_image:
    name: "{{ autostore_full_image }}"
    source: pull
    force_source: yes

- name: Generate docker-compose.yml
  template:
    src: docker-compose.yml.j2
    dest: "{{ autostore_compose_file }}"
    mode: '0644'
  notify: restart autostore

- name: Start AutoStore service
  docker_compose:
    project_src: "{{ autostore_app_dir }}"
    state: present
    recreate: smart

- name: Wait for AutoStore to be ready
  uri:
    url: "http://localhost:{{ autostore_port }}/health"
    method: GET
    status_code: 200
  register: autostore_health
  until: autostore_health.status == 200
  retries: 30
  delay: 2

roles/autostore-simulator/templates/docker-compose.yml.j2

version: '3.8'

services:
  autostore-simulator:
    image: {{ autostore_full_image }}
    container_name: {{ autostore_container_name }}
    restart: {{ autostore_restart_policy }}
    ports:
      - "{{ autostore_port }}:8000"
    volumes:
      - {{ autostore_data_volume }}:/app/data
    environment:
      - DATABASE_URL=sqlite:///{{ autostore_db_file }}
    networks:
      - {{ autostore_network }}
    logging:
      driver: "{{ autostore_log_driver }}"
      options:
        max-size: "{{ autostore_log_max_size }}"
        max-file: "{{ autostore_log_max_file }}"
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 40s

volumes:
  {{ autostore_data_volume }}:
    external: true

networks:
  {{ autostore_network }}:
    external: true

roles/autostore-simulator/handlers/main.yml

---
- name: restart autostore
  docker_compose:
    project_src: "{{ autostore_app_dir }}"
    restarted: yes

Playbook Beispiel

---
- hosts: autostore_servers
  become: yes
  vars:
    registry_url: "my-registry.example.com"
    autostore_tag: "v1.0.0"
    vault_registry_password: !vault |
      $ANSIBLE_VAULT;1.1;AES256
      66633...encrypted...66633
  
  roles:
    - autostore-simulator

  post_tasks:
    - name: Verify AutoStore API is accessible
      uri:
        url: "http://{{ inventory_hostname }}:{{ autostore_port }}/health"
        method: GET
      delegate_to: localhost

Deployment ausführen

# Inventory und Vault-Passwort vorbereiten
ansible-playbook -i inventory/production autostore-deploy.yml --ask-vault-pass

# Mit spezifischem Tag
ansible-playbook -i inventory/production autostore-deploy.yml \
  --ask-vault-pass \
  -e "autostore_tag=latest"

---

Dieses Projekt wurde mit Unterstützung von GitHub Copilot erstellt.