Skip to content

KB-104 – Deployment Procedure

Knowledge Base ID: KB-104 Project: BLACK ERP Version: 1.0 Status: Certified Last Update: 2026-06-26

Change History

Version Date Description
1.0 2026-06-26 Initial deployment procedure.

1. Objective

Define the official deployment procedure for the BLACK ERP platform.

This document establishes the required activities before, during, and after every infrastructure or application deployment to ensure system stability, traceability, and recoverability.

2. Deployment Philosophy

Every deployment shall be:

  • Planned
  • Backed up
  • Traceable
  • Validated
  • Documented

A deployment is considered complete only after successful functional validation and Knowledge Base documentation.

3. Deployment Scope

This procedure applies to:

  • ADempiere Java source code
  • Core libraries
  • WAR applications
  • Tomcat Runtime
  • Application Dictionary updates
  • Database structural changes
  • Infrastructure configuration
  • Nginx configuration
  • Java Runtime updates

4. Deployment Lifecycle

Every deployment shall follow the same engineering workflow.

Planning
    │
    ▼
Impact Analysis
    │
    ▼
Certified Backup
    │
    ▼
Deployment
    │
    ▼
Service Restart
    │
    ▼
Validation
    │
    ▼
Knowledge Base Update

No deployment may skip any stage.

5. Pre-Deployment Checklist

Before beginning any deployment:

  • Review implementation scope.
  • Review related Knowledge Base documents.
  • Identify affected components.
  • Confirm maintenance window.
  • Notify stakeholders if required.
  • Generate certified backups.
  • Verify available disk space.
  • Verify PostgreSQL status.
  • Verify Tomcat status.

Deployment shall not begin if any prerequisite is incomplete.

6. Backup Requirements

Before every deployment the following backups shall exist:

Component Required
Database ✅
Application Runtime ✅
Configuration Recommended

Reference:

KB-103 – Backup Strategy

7. Deployment Activities

Typical deployment activities may include:

  • Compile ADempiere source code.
  • Generate updated Adempiere.jar.
  • Deploy updated libraries.
  • Deploy updated WAR files.
  • Apply database migrations.
  • Update configuration files.
  • Restart application services.

The exact activities depend on the deployment scope.

8. Service Validation

After deployment, verify at minimum:

Component Expected Result
WebUI HTTP 200
Admin HTTP 200
WStore HTTP 200
REST API Operational
PostgreSQL Connected
Nginx Operational

Functional validation shall also include application login and execution of critical business processes when applicable.

9. Rollback Strategy

If validation fails:

  1. Stop services.
  2. Restore certified backups.
  3. Clear Tomcat temporary directories.
  4. Restart services.
  5. Validate recovery.
  6. Document the incident.

Rollback shall always use certified backups.

10. Deployment Certification

A deployment is considered certified only when:

  • Deployment completed successfully.
  • Services started correctly.
  • Functional validation completed.
  • No blocking issues detected.
  • Knowledge Base updated.

11. Engineering Principles

BLACK ERP follows the following deployment principles:

  1. Backup before change.
  2. Validate before release.
  3. Document before closing.
  4. Rollback must always be possible.
  5. Infrastructure documentation is part of the deployment.

12. Related Knowledge Base

  • KB-101 – Infrastructure
  • KB-102 – Disaster Recovery
  • KB-103 – Backup Strategy
  • KB-106 – PostgreSQL Administration

Revision History

Version Date Description
1.0 2026-06-26 Initial document.