Note

The openATTIC project has entered maintenance mode. New feature development has been discontinued in favor of enhancing the upstream Ceph Dashboard.

See this blog post for details.

Developer Documentation

openATTIC consists of a set of components built on different frameworks, which work together to provide a comprehensive Ceph storage management platform.

This document describes the architecture and components of openATTIC and provides instructions on how to set up a development environment and work on the various components included in the openATTIC code base.

If you would like to contribute to the openATTIC project, you need to prepare a development environment first.

Follow the outlined steps to Create Your own openATTIC git Fork on BitBucket.

Next, follow the instructions on Setting up a Development System with Vagrant or Setting up a Development System. Then code away, implementing whatever changes you want to make.

If you’re looking for inspiration or some easy development tasks to get started with, we’ve created a list of low hanging fruit tasks that are limited in scope and should be fairly easy to tackle.

See Contributing Code to openATTIC for details on how to submit your changes to the upstream developers. Follow the openATTIC Contributing Guidelines to make sure your patches will be accepted.

If your changes modify documented behaviour or implement new functionality, the documentation should be updated as well. See Working on the openATTIC documentation for instructions on how to update the documentation.

• Create Your own openATTIC git Fork on BitBucket
• Setting up a Development System with Vagrant
  • WebUI preparation
  • Vagrant Installation
  • Network preparation
  • Starting the Virtual Machine
  • Choosing a different Linux distribution
  • Debugging openATTIC with PyCharm Professional
  • Debugging openATTIC with PyCharm Community
  • Perform an openATTIC Base Configuration
  • Troubleshooting
• Setting up a Development System
  • Installing the Development Tools
  • How to run the frontend in a local server
  • How to use eslint in your developer environment
  • How to get the authentication token for your own user
  • WebUI local configuration
  • Backend local configuration
• Contributing Code to openATTIC
  • Keeping Your Local Repository in Sync
  • Using git+ssh behind a Proxy Server
  • Working With Branches
  • Submitting Pull Requests
• openATTIC Contributing Guidelines
  • Documenting Your Changes
  • Signing Your Patch Contribution
  • Merging Pull Requests
  • Backport commits
  • Error Handling in Python
  • Database migrations
• openATTIC Architecture
  • Models
  • openATTIC systemd background process
• Working on the openATTIC documentation
  • Requirements
  • Documentation Guidelines
  • Building the documentation
• Customizing the openATTIC WebUI
  • Changing the favicon
  • Changing the logo
• Background-Tasks
  • What is a background task?
  • Where can I find the running background tasks?
  • Are there different types of tasks?
  • How can I test it?
  • Can I delete them?
  • Do I have to wait for the task to finish?
  • Which processes create a background task?
• Task Queue Module
  • Hello World
  • Recursion
  • Progress Percentage
  • Revision Upgrades
  • Referencing a newly created TaskQueue object
  • Integration with openATTIC-systemD
  • Background
• openATTIC Web UI Tests - Unit Tests
  • Writing Unit Tests
  • Run Unit Tests
  • Coverage Report
  • References
• openATTIC Web UI Tests - E2E Test Suite
  • About Protractor
  • System Requirements
  • Install Protractor
  • Protractor Configuration
  • Start webdriver manager Environment
  • Make Protractor Execute the Tests
  • Starting Only a Specific Test Suite
  • How to Cancel the Tests
  • E2E-Test Directory and File Structure
  • Writing Your Own Tests
  • Style Guide - General e2e.js File Structure / Architecture
  • Tips on how to write tests that also support Firefox
  • Debugging your tests
• openATTIC REST API Tests - Gatling Test Suite
  • Quick start
  • Dependencies
  • Configuration
  • CI integration
  • Advanced options
  • Source code layout
• Python Unit Tests
  • Executing Tests
  • Starting Only a Specific Test Suite
  • Writing Tests
  • Style Guide