Skip to content

User Manual

Overview
Architecture documents
Architecture documents
Installation
Installation
- System: Minimum Requirements
- Downloading the Platform
- Bundle install
  Bundle install
  - Overview
  - Bundle Installation
- Docker install
  Docker install
  - Overview
- Configuration setup
  Configuration setup
  - Overview
  - API
  - Jupyter
  - Web Application
- Components
  Components
  - Web server
    Web server
    
    Overview
    
    Nginx
    
    Apache http server (httpd)
  - Metadata database setup
    Metadata database setup
    
    Metadata: Database Setup
    
    Oracle DB
    
    POSTGRESQL
    
    SQLite
  - Authentication setup
    Authentication setup
    
    Overview
    
    Internal
    
    SAML
  - File management setup
    File management setup
    
    Overview
    
    Amazon S3
    
    OS File System
  - Process management
    Process management
    
    Overview
    
    Daemons
    
    Systemd
  - Datalake Integration
Customization
Customization
- Overview
- Approval Handler
- Export
  Export
- Definition sources
  Definition sources
  - Definition Sources
- Shortcuts
- Fetching metadata
  Fetching metadata
- Email Notifications
- Additional Libraries
- Job Specific Configurations
- Multiple Corridor Workers
- Spark UI
- Custom fields
  Custom fields
  - Externally managed custom field
- Monitoring dashboard
  Monitoring dashboard
  - Monitoring external objects
  - Alerting
Maintenance
Maintenance
Production
Production
- Production: Using Artifacts
- Corridor-Runtime
CLI: Utility Commands
CLI: Utility Commands
- Overview
- Health check
- DB Operations
- Apply a patch script
- Python Shell for debugging
- Regenerate Artifacts
- Run Scheduled Jobs
- Settings
  Settings
  - Encrypt and decrypt strings
  - Generate Settings
- Create Workspace

Overview

This section discusses a list of common task required to manage and maintain the platform.