5. Technical Docs

Contents:

• 5.1. Architecture
  • 5.1.1. Network Actors
    • Server
    • Data Station
    • User or Application
  • 5.1.2. Components
    • vantage6-server
    • vantage6-node
    • vantage6-clients
    • vantage6-UI
  • 5.1.3. Architecture
• 5.2. Features
  • 5.2.1. Server features
    • Two-factor authentication
    • Horizontal scaling
    • Permission management
    • API response structure
  • 5.2.2. Node features
    • Whitelisting
    • SSH Tunnel
  • 5.2.3. Algorithm features
    • Algorithm wrappers
  • 5.2.4. Communication between components
    • SocketIO connection
    • Algorithm-to-algorithm comunication
• 5.3. Node
  • 5.3.1. vantage6.node.Node
  • 5.3.2. vantage6.node.docker.docker_base
  • 5.3.3. vantage6.node.docker.docker_manager
  • 5.3.4. vantage6.node.docker.task_manager
  • 5.3.5. vantage6.node.docker.vpn_manager
  • 5.3.6. vantage6.node.docker.exceptions
  • 5.3.7. vantage6.node.proxy_server
  • 5.3.8. vantage6.node.cli.node
• 5.4. Server
  • 5.4.1. Main server class
    • vantage6.server.ServerApp
  • 5.4.2. Starting the server
    • vantage6.server.run_server
    • vantage6.server.run_dev_server
  • 5.4.3. Permission management
    • vantage6.server.model.rule.Scope
    • vantage6.server.model.rule.Operation
    • vantage6.server.model.permission.RuleCollection
    • vantage6.server.permission.PermissionManager
  • 5.4.4. Socket functionality
    • vantage6.server.websockets.DefaultSocketNamespace
  • 5.4.5. API endpoints
    • vantage6.server.resource
    • vantage6.server.resource.common._schema
    • vantage6.server.resource.common.auth_helper
    • vantage6.server.resource.common.swagger_template
  • 5.4.6. SQLAlchemy models
    • vantage6.server.model.base
    • Database models for the API resources
    • Database models that link resources together
  • 5.4.7. Database utility functions
    • vantage6.server.db
  • 5.4.8. Mail service
    • vantage6.server.mail_service
  • 5.4.9. Default roles
    • vantage6.server.default_roles
  • 5.4.10. Custom exceptions
    • vantage6.server.exceptions
  • 5.4.11. vantage6.server.cli
    • vserver-local
• 5.5. CLI
  • 5.5.1. Node CLI
    • vantage6.cli.node
  • 5.5.2. Server CLI
  • 5.5.3. vantage6.cli.context
    • NodeContext
    • ServerContext
  • 5.5.4. vanatge6.cli.configuration_manager
    • NodeConfiguration
    • NodeConfigurationManager
    • ServerConfiguration
    • ServerConfigurationManager
    • TestConfiguration
    • TestingConfigurationManager
  • 5.5.5. vantage6.cli.configuration_wizard
    • configuration_wizard()
    • node_configuration_questionaire()
    • select_configuration_questionaire()
    • server_configuration_questionaire()
  • 5.5.6. vanatge6.cli.rabbitmq.queue_manager
  • 5.5.7. vanatge6.cli.rabbitmq
    • is_local_address()
    • split_rabbitmq_uri()
  • 5.5.8. vantage6.cli.utils
    • check_config_name_allowed()
    • check_if_docker_daemon_is_running()
• 5.6. Client
  • 5.6.1. User Client
    • vantage6.client
    • vantage6.client.utils
  • 5.6.2. Algorithm Client
    • vantage6.client.algorithm_client
  • 5.6.3. Algorithm tooling
    • vantage6.tools.wrapper
    • vantage6.tools.mock_client
    • vantage6.tools.dispatch_rpc
    • vantage6.tools.util
  • 5.6.4. Custom exceptions
    • vantage6.client.exceptions
• 5.7. Vantage6-common
  • 5.7.1. vantage6.common.configuration_manager
    • Configuration
    • ConfigurationManager
  • 5.7.2. vantage6.common.context
    • AppContext
  • 5.7.3. vantage6.common.encryption
    • CryptorBase
    • DummyCryptor
    • RSACryptor
  • 5.7.4. vantage6.common
    • ClickLogger
    • Singleton
    • WhoAmI
    • base64s_to_bytes()
    • bytes_to_base64s()
    • check_config_writeable()
    • debug()
    • echo()
    • error()
    • get_database_config()
    • info()
    • is_ip_address()
    • logger_name()
    • warning()
  • 5.7.5. vantage6.common.docker.addons
  • 5.7.6. vantage6.common.docker.network_manager
  • 5.7.7. vantage6.common.task_status
    • TaskStatus
    • has_task_failed()
    • has_task_finished()
  • 5.7.8. vantage6.common.colors
    • ColorStreamHandler
    • _AnsiColorStreamHandler
    • _WinColorStreamHandler
  • 5.7.9. vantage6.common.exceptions
    • AuthenticationException