DATAGERRY Documentation

DATAGERRY is an enterprise-grade OpenSource CMDB, which completely leaves the definition of object types to the user.

Introduction

• Welcome to DATAGERRY
• License

Guides

• Admin Guide
  • 1. Setup
    • 1.1. Requirements
    • 1.2. Docker Image
    • 1.3. RPM setup
      • 1.3.1. Setup MongoDB
      • 1.3.2. Setup RabbitMQ
      • 1.3.3. Setup DATAGERRY
    • 1.4. tar.gz archive setup
      • 1.4.1. Setup MongoDB
      • 1.4.2. Setup RabbitMQ
      • 1.4.3. Setup DATAGERRY
    • 1.5. Setting up Nginx as reverse proxy
    • 1.6. Update DATAGERRY
  • 2. Configuration
  • 3. Getting Started
    • 3.1. Concept of DATAGERRY
    • 3.2. Quick Start
  • 4. Objects and Object Types
    • 4.1. Managing Categories
    • 4.2. Managing Object Types
      • 4.2.1. Adding/Editing an Object Type
      • 4.2.2. Changing an existing Object Type
      • 4.2.3. Importing/Exporting Object Types
    • 4.3. Managing Objects
      • 4.3.1. Active und Inactive Objects
      • 4.3.2. Exporting Objects
      • 4.3.3. Importing Objects
        • 4.3.3.1. CSV Import
        • 4.3.3.2. JSON
  • 5. Exportd
    • 5.1. Concept
    • 5.2. Configuration
      • 5.2.1. Define Sources
      • 5.2.2. Define Destinations
      • 5.2.3. Define Export Variables
      • 5.2.4. Configure Scheduling
    • 5.3. ExternalSystems
      • 5.3.1. ExternalSystemAnsible
      • 5.3.2. ExternalSystemCpanelDns
      • 5.3.3. ExternalSystemCsv
      • 5.3.4. ExternalSystemExecuteScript
      • 5.3.5. ExternalSystemGenericPullJson
      • 5.3.6. ExternalSystemGenericRestCall
      • 5.3.7. ExternalSystemOpenNMS
  • 6. DocAPI
    • 6.1. Concept
    • 6.2. Required Permissions
    • 6.3. Configuration
    • 6.4. Template Types
      • 6.4.1. Object Template
    • 6.5. Advanced Styling
      • 6.5.1. Page Format
      • 6.5.2. Advanced Layouts
      • 6.5.3. Custom Fonts
  • 7. User Management
    • 7.1. Local Users and Groups
    • 7.2. Access Rights
  • 8. Authentication
    • 8.1. Access Token
    • 8.2. Providers
• Development Guide
  • 1. Setup a development system
    • 1.1. Install Python
    • 1.2. Clone repository
      • 1.2.1. Install requirements
    • 1.3. Setting up third party dependencies
      • 1.3.1. MongoDB
      • 1.3.2. RabbitMQ
    • 1.4. Modify configuration file
      • 1.4.1. Database config
      • 1.4.2. Webserver config
      • 1.4.3. Message queueing config
    • 1.5. Starting the backend and frontend
      • 1.5.1. Starting DATAGERRY
        • 1.5.1.1. Generate clean database
        • 1.5.1.2. Insert test data (optional)
      • 1.5.2. Starting angular frontend
        • 1.5.2.1. Installation
        • 1.5.2.2. Development server
        • 1.5.2.3. Build
  • 2. GIT Repository
    • 2.1. Branches
    • 2.2. Creating a Release
      • 2.2.1. latest symlink
  • 3. Documentation
    • 3.1. Generation
    • 3.2. Approach
  • 4. Process Management
    • 4.1. adding a new service
  • 5. Logging
    • 5.1. Log Levels
    • 5.2. Log Output
    • 5.3. Changing the Log Configuration
  • 6. Event Handling
    • 6.1. structure of an event
      • 6.1.1. example:
    • 6.2. event routing
    • 6.3. list of event types
      • 6.3.1. cmdb.core.object:
      • 6.3.2. cmdb.core.objecttype:
  • 7. REST API Guidelines
    • 7.1. Instruction
      • 7.1.1. Principles
      • 7.1.2. Conventions
    • 7.2. General
      • 7.2.1. Version Control System
      • 7.2.2. Naming Conventions
      • 7.2.3. Security
    • 7.3. Resources
      • 7.3.1. Naming
      • 7.3.2. URL
      • 7.3.3. Methods
      • 7.3.4. Parameters
      • 7.3.5. Filtering
      • 7.3.6. Sorting
      • 7.3.7. Pagination
      • 7.3.8. Documentation
    • 7.4. Responses
      • 7.4.1. Status Codes
        • 7.4.1.1. 2xx Success
        • 7.4.1.2. 3xx Redirection
        • 7.4.1.3. 4xx Client errors
        • 7.4.1.4. 5xx Server errors
      • 7.4.2. Error Codes
    • 7.5. TL;DR