Docs updates

Author: alvagante

Dockerfile

@@ -133,7 +133,11 @@ ENV NODE_ENV=production \
     PORT=3000 \
     HOST=0.0.0.0 \
     DATABASE_PATH=/data/executions.db \
-    BOLT_PROJECT_PATH=/bolt-project
+    BOLT_PROJECT_PATH=/bolt-project \
+    # Integration settings (disabled by default)
+    PUPPETDB_ENABLED=false \
+    PUPPETSERVER_ENABLED=false \
+    HIERA_ENABLED=false
 
 # Health check
 HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \

Dockerfile.alpine

@@ -150,7 +150,11 @@ ENV NODE_ENV=production \
     FACTER_operatingsystem=Alpine \
     FACTER_osfamily=Linux \
     FACTER_kernel=Linux \
-    PUPPET_SKIP_OS_CHECK=true
+    PUPPET_SKIP_OS_CHECK=true \
+    # Integration settings (disabled by default)
+    PUPPETDB_ENABLED=false \
+    PUPPETSERVER_ENABLED=false \
+    HIERA_ENABLED=false
 
 # Health check
 HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \

Dockerfile.ubuntu

@@ -144,7 +144,11 @@ ENV NODE_ENV=production \
     PORT=3000 \
     HOST=0.0.0.0 \
     DATABASE_PATH=/data/executions.db \
-    BOLT_PROJECT_PATH=/bolt-project
+    BOLT_PROJECT_PATH=/bolt-project \
+    # Integration settings (disabled by default)
+    PUPPETDB_ENABLED=false \
+    PUPPETSERVER_ENABLED=false \
+    HIERA_ENABLED=false
 
 # Health check
 HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \

README.md

@@ -283,13 +283,11 @@ git commit --no-verify -m "message"
 
 ## Docker Deployment
 
-### Building the Docker Image
+For comprehensive Docker deployment instructions including all integrations, see the [Docker Deployment Guide](docs/docker-deployment.md).
 
-```bash
-docker build -t padawi:latest .
-```
+### Quick Start
 
-### Running with Docker
+### Building the Docker Image
 
 ```bash
 # Using the provided script
@@ -346,8 +344,14 @@ Access the application at <http://localhost:3000>
 ssh -L 3000:localhost:3000 user@your-workstation
 ```
 
+```bash
+docker build -t pabawi:latest .
+```
+
 ### Running with Docker Compose
 
+The docker-compose.yml file includes comprehensive configuration for all integrations:
+
 ```bash
 # Start the service
 docker-compose up -d
@@ -359,6 +363,54 @@ docker-compose logs -f
 docker-compose down
 ```
 
+#### Enabling Integrations
+
+To enable integrations, create a `.env` file in the project root with your configuration:
+
+```env
+# PuppetDB Integration
+PUPPETDB_ENABLED=true
+PUPPETDB_SERVER_URL=https://puppetdb.example.com
+PUPPETDB_PORT=8081
+PUPPETDB_TOKEN=your-token-here
+PUPPETDB_SSL_ENABLED=true
+PUPPETDB_SSL_CA=/ssl-certs/ca.pem
+PUPPETDB_SSL_CERT=/ssl-certs/client.pem
+PUPPETDB_SSL_KEY=/ssl-certs/client-key.pem
+
+# Puppetserver Integration
+PUPPETSERVER_ENABLED=true
+PUPPETSERVER_SERVER_URL=https://puppet.example.com
+PUPPETSERVER_PORT=8140
+PUPPETSERVER_SSL_ENABLED=true
+PUPPETSERVER_SSL_CA=/ssl-certs/ca.pem
+PUPPETSERVER_SSL_CERT=/ssl-certs/client.pem
+PUPPETSERVER_SSL_KEY=/ssl-certs/client-key.pem
+
+# Hiera Integration
+HIERA_ENABLED=true
+HIERA_CONTROL_REPO_PATH=/control-repo
+HIERA_ENVIRONMENTS=["production","staging"]
+HIERA_FACT_SOURCE_PREFER_PUPPETDB=true
+```
+
+#### Volume Mounts for Integrations
+
+Update the docker-compose.yml volumes section to include your SSL certificates and control repository:
+
+```yaml
+volumes:
+  # Existing mounts
+  - ./bolt-project:/bolt-project:ro
+  - ./data:/data
+  
+  # SSL certificates for PuppetDB/Puppetserver
+  - /path/to/ssl/certs:/ssl-certs:ro
+  
+  # Hiera control repository
+  - /path/to/control-repo:/control-repo:ro
+```
+
 Access the application at <http://localhost:3000>
 
 **⚠️ Security Note**: Only access via localhost. For remote access, use SSH port forwarding:
@@ -632,7 +684,7 @@ Special thanks to all contributors and the Puppet community.
 ### Integration Setup
 
 - [PuppetDB Integration Setup](docs/puppetdb-integration-setup.md) - PuppetDB configuration guide
-- [Puppetserver Setup](docs/PUPPETSERVER_SETUP.md) - Puppetserver configuration guide
+- [Puppetserver Setup](docs/uppetserver-integration-setup.md) - Puppetserver configuration guide
 - [PuppetDB API Documentation](docs/puppetdb-api.md) - PuppetDB-specific API endpoints
 
 ### Additional Resources

docker-compose.yml

@@ -13,6 +13,12 @@ services:
       - ./bolt-project:/bolt-project:ro
       # Mount data directory for SQLite database (read-write)
       - ./data:/data
+      # Mount SSL certificates for PuppetDB/Puppetserver integration (optional, read-only)
+      # Uncomment and adjust paths as needed:
+      # - /path/to/ssl/certs:/ssl-certs:ro
+      # Mount Hiera control repository (optional, read-only)
+      # Uncomment and adjust path as needed:
+      # - /path/to/control-repo:/control-repo:ro
       # Persist node_modules
       - node_modules:/workspace/node_modules
       - backend_node_modules:/workspace/backend/node_modules
@@ -43,6 +49,68 @@ services:
       # Logging configuration
       - LOG_LEVEL=${LOG_LEVEL:-info}
 
+      # PuppetDB integration configuration (disabled by default)
+      - PUPPETDB_ENABLED=${PUPPETDB_ENABLED:-false}
+      - PUPPETDB_SERVER_URL=${PUPPETDB_SERVER_URL:-}
+      - PUPPETDB_PORT=${PUPPETDB_PORT:-8081}
+      - PUPPETDB_TOKEN=${PUPPETDB_TOKEN:-}
+      - PUPPETDB_TIMEOUT=${PUPPETDB_TIMEOUT:-30000}
+      - PUPPETDB_RETRY_ATTEMPTS=${PUPPETDB_RETRY_ATTEMPTS:-3}
+      - PUPPETDB_RETRY_DELAY=${PUPPETDB_RETRY_DELAY:-1000}
+      - PUPPETDB_SSL_ENABLED=${PUPPETDB_SSL_ENABLED:-false}
+      - PUPPETDB_SSL_CA=${PUPPETDB_SSL_CA:-}
+      - PUPPETDB_SSL_CERT=${PUPPETDB_SSL_CERT:-}
+      - PUPPETDB_SSL_KEY=${PUPPETDB_SSL_KEY:-}
+      - PUPPETDB_SSL_REJECT_UNAUTHORIZED=${PUPPETDB_SSL_REJECT_UNAUTHORIZED:-true}
+      - PUPPETDB_CACHE_TTL=${PUPPETDB_CACHE_TTL:-300000}
+      - PUPPETDB_CIRCUIT_BREAKER_THRESHOLD=${PUPPETDB_CIRCUIT_BREAKER_THRESHOLD:-5}
+      - PUPPETDB_CIRCUIT_BREAKER_TIMEOUT=${PUPPETDB_CIRCUIT_BREAKER_TIMEOUT:-60000}
+      - PUPPETDB_CIRCUIT_BREAKER_RESET_TIMEOUT=${PUPPETDB_CIRCUIT_BREAKER_RESET_TIMEOUT:-30000}
+
+      # Puppetserver integration configuration (disabled by default)
+      - PUPPETSERVER_ENABLED=${PUPPETSERVER_ENABLED:-false}
+      - PUPPETSERVER_SERVER_URL=${PUPPETSERVER_SERVER_URL:-}
+      - PUPPETSERVER_PORT=${PUPPETSERVER_PORT:-8140}
+      - PUPPETSERVER_TOKEN=${PUPPETSERVER_TOKEN:-}
+      - PUPPETSERVER_TIMEOUT=${PUPPETSERVER_TIMEOUT:-30000}
+      - PUPPETSERVER_RETRY_ATTEMPTS=${PUPPETSERVER_RETRY_ATTEMPTS:-3}
+      - PUPPETSERVER_RETRY_DELAY=${PUPPETSERVER_RETRY_DELAY:-1000}
+      - PUPPETSERVER_INACTIVITY_THRESHOLD=${PUPPETSERVER_INACTIVITY_THRESHOLD:-3600}
+      - PUPPETSERVER_SSL_ENABLED=${PUPPETSERVER_SSL_ENABLED:-false}
+      - PUPPETSERVER_SSL_CA=${PUPPETSERVER_SSL_CA:-}
+      - PUPPETSERVER_SSL_CERT=${PUPPETSERVER_SSL_CERT:-}
+      - PUPPETSERVER_SSL_KEY=${PUPPETSERVER_SSL_KEY:-}
+      - PUPPETSERVER_SSL_REJECT_UNAUTHORIZED=${PUPPETSERVER_SSL_REJECT_UNAUTHORIZED:-true}
+      - PUPPETSERVER_CACHE_TTL=${PUPPETSERVER_CACHE_TTL:-300000}
+      - PUPPETSERVER_CIRCUIT_BREAKER_THRESHOLD=${PUPPETSERVER_CIRCUIT_BREAKER_THRESHOLD:-5}
+      - PUPPETSERVER_CIRCUIT_BREAKER_TIMEOUT=${PUPPETSERVER_CIRCUIT_BREAKER_TIMEOUT:-60000}
+      - PUPPETSERVER_CIRCUIT_BREAKER_RESET_TIMEOUT=${PUPPETSERVER_CIRCUIT_BREAKER_RESET_TIMEOUT:-30000}
+
+      # Hiera integration configuration (disabled by default)
+      - HIERA_ENABLED=${HIERA_ENABLED:-false}
+      - HIERA_CONTROL_REPO_PATH=${HIERA_CONTROL_REPO_PATH:-}
+      - HIERA_CONFIG_PATH=${HIERA_CONFIG_PATH:-hiera.yaml}
+      - HIERA_ENVIRONMENTS=${HIERA_ENVIRONMENTS:-["production"]}
+      - HIERA_FACT_SOURCE_PREFER_PUPPETDB=${HIERA_FACT_SOURCE_PREFER_PUPPETDB:-true}
+      - HIERA_FACT_SOURCE_LOCAL_PATH=${HIERA_FACT_SOURCE_LOCAL_PATH:-}
+      - HIERA_CATALOG_COMPILATION_ENABLED=${HIERA_CATALOG_COMPILATION_ENABLED:-false}
+      - HIERA_CATALOG_COMPILATION_TIMEOUT=${HIERA_CATALOG_COMPILATION_TIMEOUT:-60000}
+      - HIERA_CATALOG_COMPILATION_CACHE_TTL=${HIERA_CATALOG_COMPILATION_CACHE_TTL:-300000}
+      - HIERA_CACHE_ENABLED=${HIERA_CACHE_ENABLED:-true}
+      - HIERA_CACHE_TTL=${HIERA_CACHE_TTL:-300000}
+      - HIERA_CACHE_MAX_ENTRIES=${HIERA_CACHE_MAX_ENTRIES:-10000}
+      - HIERA_CODE_ANALYSIS_ENABLED=${HIERA_CODE_ANALYSIS_ENABLED:-true}
+      - HIERA_CODE_ANALYSIS_LINT_ENABLED=${HIERA_CODE_ANALYSIS_LINT_ENABLED:-true}
+      - HIERA_CODE_ANALYSIS_MODULE_UPDATE_CHECK=${HIERA_CODE_ANALYSIS_MODULE_UPDATE_CHECK:-true}
+      - HIERA_CODE_ANALYSIS_INTERVAL=${HIERA_CODE_ANALYSIS_INTERVAL:-3600000}
+      - HIERA_CODE_ANALYSIS_EXCLUSION_PATTERNS=${HIERA_CODE_ANALYSIS_EXCLUSION_PATTERNS:-["**/vendor/**","**/fixtures/**"]}
+
+      # Integration priority configuration (optional)
+      - BOLT_PRIORITY=${BOLT_PRIORITY:-5}
+      - PUPPETDB_PRIORITY=${PUPPETDB_PRIORITY:-10}
+      - PUPPETSERVER_PRIORITY=${PUPPETSERVER_PRIORITY:-8}
+      - HIERA_PRIORITY=${HIERA_PRIORITY:-6}
+
     healthcheck:
       test: ["CMD", "node", "-e", "require('http').get('http://localhost:3000/api/health', (r) => {process.exit(r.statusCode === 200 ? 0 : 1)})"]
       interval: 30s

docs/architecture.md

@@ -745,5 +745,5 @@ The plugin architecture is designed for easy extension:
 - [Integrations API](./integrations-api.md)
 - [Configuration Guide](./configuration.md)
 - [PuppetDB Integration Setup](./puppetdb-integration-setup.md)
-- [Puppetserver Setup](./PUPPETSERVER_SETUP.md)
+- [Puppetserver Setup](./uppetserver-integration-setup.md)
 - [Troubleshooting Guide](./troubleshooting.md)

docs/configuration.md

@@ -907,8 +907,12 @@ services:
       - /path/to/bolt-project:/bolt-project:ro
       # Mount database (persistent)
       - pabawi-data:/data
-      # Mount SSH keys (read-only)
+      # Mount SSL keys (read-only)
       - ~/.ssh:/root/.ssh:ro
+      # Mount SSL certificates for integrations (read-only)
+      - /path/to/ssl/certs:/ssl-certs:ro
+      # Mount Hiera control repository (read-only)
+      - /path/to/control-repo:/control-repo:ro
     environment:
       PORT: 3000
       HOST: 0.0.0.0
@@ -922,6 +926,38 @@ services:
       CACHE_INVENTORY_TTL: 60000
       CACHE_FACTS_TTL: 300000
       CONCURRENT_EXECUTION_LIMIT: 10
+      
+      # PuppetDB Integration
+      PUPPETDB_ENABLED: "true"
+      PUPPETDB_SERVER_URL: "https://puppetdb.example.com"
+      PUPPETDB_PORT: 8081
+      PUPPETDB_SSL_ENABLED: "true"
+      PUPPETDB_SSL_CA: "/ssl-certs/ca.pem"
+      PUPPETDB_SSL_CERT: "/ssl-certs/client.pem"
+      PUPPETDB_SSL_KEY: "/ssl-certs/client-key.pem"
+      PUPPETDB_TIMEOUT: 30000
+      PUPPETDB_CACHE_TTL: 300000
+      
+      # Puppetserver Integration
+      PUPPETSERVER_ENABLED: "true"
+      PUPPETSERVER_SERVER_URL: "https://puppet.example.com"
+      PUPPETSERVER_PORT: 8140
+      PUPPETSERVER_SSL_ENABLED: "true"
+      PUPPETSERVER_SSL_CA: "/ssl-certs/ca.pem"
+      PUPPETSERVER_SSL_CERT: "/ssl-certs/client.pem"
+      PUPPETSERVER_SSL_KEY: "/ssl-certs/client-key.pem"
+      PUPPETSERVER_TIMEOUT: 30000
+      PUPPETSERVER_CACHE_TTL: 300000
+      
+      # Hiera Integration
+      HIERA_ENABLED: "true"
+      HIERA_CONTROL_REPO_PATH: "/control-repo"
+      HIERA_CONFIG_PATH: "hiera.yaml"
+      HIERA_ENVIRONMENTS: '["production","staging"]'
+      HIERA_FACT_SOURCE_PREFER_PUPPETDB: "true"
+      HIERA_CACHE_ENABLED: "true"
+      HIERA_CACHE_TTL: 300000
+      
     restart: unless-stopped
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:3000/api/health"]