Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

vantage6 documentation

Toggle table of contents sidebar

Overview
Introduction
Architecture

1. User guide
Toggle child pages in navigation
2. Node admin guide
Toggle child pages in navigation
3. Server admin guide
Toggle child pages in navigation
4. Algorithm store admin guide
Toggle child pages in navigation
5. Algorithm Development
Toggle child pages in navigation
6. Feature descriptions
Toggle child pages in navigation
- 6.1. Server features
  Toggle child pages in navigation
- 6.2. Node features
  Toggle child pages in navigation
- 6.3. Algorithm features
  Toggle child pages in navigation
  - 6.3.1. Algorithm wrappers
  - 6.3.2. Algorithm container isolation
- 6.4. Communication between components
  Toggle child pages in navigation
7. Developer community
Toggle child pages in navigation
8. Function documentation
Toggle child pages in navigation
- 8.1. vantage6.cli
  Toggle child pages in navigation
  - 8.1.1. vantage6.cli.cli
  - 8.1.2. vantage6.cli.configuration_manager
    Toggle child pages in navigation
  - 8.1.3. vantage6.cli.configuration_wizard
    Toggle child pages in navigation
  - 8.1.4. vantage6.cli.context
    Toggle child pages in navigation
    - vantage6.cli.context.get_context
    - vantage6.cli.context.select_context_class
    - vantage6.cli.context.algorithm_store
      Toggle child pages in navigation
      - vantage6.cli.context.algorithm_store.AlgorithmStoreContext
    - vantage6.cli.context.base_server
      Toggle child pages in navigation
      - vantage6.cli.context.base_server.BaseServerContext
    - vantage6.cli.context.node
      Toggle child pages in navigation
      - vantage6.cli.context.node.NodeContext
    - vantage6.cli.context.server
      Toggle child pages in navigation
      - vantage6.cli.context.server.ServerContext
  - 8.1.5. vantage6.cli.globals
    Toggle child pages in navigation
  - 8.1.6. vantage6.cli.rabbitmq
    Toggle child pages in navigation
    - vantage6.cli.rabbitmq.definitions
    - vantage6.cli.rabbitmq.queue_manager
      Toggle child pages in navigation
      - vantage6.cli.rabbitmq.queue_manager.RabbitMQManager
  - 8.1.7. vantage6.cli.utils
    Toggle child pages in navigation
- 8.2. vantage6.client
  Toggle child pages in navigation
  - 8.2.1. vantage6.client.Client
  - 8.2.2. vantage6.client.UserClient
  - 8.2.3. vantage6.client.exceptions
    Toggle child pages in navigation
    - vantage6.client.exceptions.DeserializationException
  - 8.2.4. vantage6.client.filter
    Toggle child pages in navigation
  - 8.2.5. vantage6.client.subclients
    Toggle child pages in navigation
    - vantage6.client.subclients.store
      Toggle child pages in navigation
      - vantage6.client.subclients.store.algorithm
        Toggle child pages in navigation
        
        vantage6.client.subclients.store.algorithm.AlgorithmSubClient
      - vantage6.client.subclients.store.algorithm_store
        Toggle child pages in navigation
        
        vantage6.client.subclients.store.algorithm_store.AlgorithmStoreSubClient
      - vantage6.client.subclients.store.policy
        Toggle child pages in navigation
        
        vantage6.client.subclients.store.policy.PolicySubClient
      - vantage6.client.subclients.store.review
        Toggle child pages in navigation
        
        vantage6.client.subclients.store.review.ReviewSubClient
      - vantage6.client.subclients.store.role
        Toggle child pages in navigation
        
        vantage6.client.subclients.store.role.StoreRoleSubClient
      - vantage6.client.subclients.store.rule
        Toggle child pages in navigation
        
        vantage6.client.subclients.store.rule.StoreRuleSubClient
      - vantage6.client.subclients.store.user
        Toggle child pages in navigation
        
        vantage6.client.subclients.store.user.StoreUserSubClient
    - vantage6.client.subclients.study
      Toggle child pages in navigation
      - vantage6.client.subclients.study.StudySubClient
  - 8.2.6. vantage6.client.utils
    Toggle child pages in navigation
    - vantage6.client.utils.LogLevel
- 8.3. vantage6.algorithm.client
  Toggle child pages in navigation
  - 8.3.1. vantage6.algorithm.client.AlgorithmClient
- 8.4. vantage6.algorithm.tools
  Toggle child pages in navigation
- 8.5. vantage6.node
  Toggle child pages in navigation
  - 8.5.1. vantage6.node.run
  - 8.5.2. vantage6.node.Node
  - 8.5.3. vantage6.node.VPNConnectMode
  - 8.5.4. vantage6.node.cli
    Toggle child pages in navigation
    - vantage6.node.cli.node
  - 8.5.5. vantage6.node.context
    Toggle child pages in navigation
  - 8.5.6. vantage6.node.globals
  - 8.5.7. vantage6.node.proxy_server
    Toggle child pages in navigation
  - 8.5.8. vantage6.node.socket
    Toggle child pages in navigation
    - vantage6.node.socket.NodeTaskNamespace
  - 8.5.9. vantage6.node.util
    Toggle child pages in navigation
    - vantage6.node.util.get_parent_id
    - vantage6.node.util.colorer
      Toggle child pages in navigation
      - vantage6.node.util.colorer.add_coloring_to_emit_ansi
      - vantage6.node.util.colorer.add_coloring_to_emit_windows
- 8.6. vantage6.backend.common
  Toggle child pages in navigation
  - 8.6.1. vantage6.backend.common.base
    Toggle child pages in navigation
  - 8.6.2. vantage6.backend.common.globals
  - 8.6.3. vantage6.backend.common.jsonable
    Toggle child pages in navigation
    - vantage6.backend.common.jsonable.jsonable
  - 8.6.4. vantage6.backend.common.permission
    Toggle child pages in navigation
  - 8.6.5. vantage6.backend.common.permission_models
    Toggle child pages in navigation
    - vantage6.backend.common.permission_models.RoleInterface
    - vantage6.backend.common.permission_models.RuleInterface
  - 8.6.6. vantage6.backend.common.session
  - 8.6.7. vantage6.backend.common.test_context
    Toggle child pages in navigation
    - vantage6.backend.common.test_context.TestContext
- 8.7. vantage6.common
  Toggle child pages in navigation
  - 8.7.1. vantage6.common.base64s_to_bytes
  - 8.7.2. vantage6.common.bytes_to_base64s
  - 8.7.3. vantage6.common.check_config_writeable
  - 8.7.4. vantage6.common.debug
  - 8.7.5. vantage6.common.echo
  - 8.7.6. vantage6.common.error
  - 8.7.7. vantage6.common.generate_apikey
  - 8.7.8. vantage6.common.get_config_path
  - 8.7.9. vantage6.common.get_database_config
  - 8.7.10. vantage6.common.info
  - 8.7.11. vantage6.common.is_ip_address
  - 8.7.12. vantage6.common.logger_name
  - 8.7.13. vantage6.common.split_rabbitmq_uri
  - 8.7.14. vantage6.common.warning
  - 8.7.15. vantage6.common.ClickLogger
  - 8.7.16. vantage6.common.Singleton
  - 8.7.17. vantage6.common.WhoAmI
  - 8.7.18. vantage6.common.colors
    Toggle child pages in navigation
    - vantage6.common.colors.ColorStreamHandler
  - 8.7.19. vantage6.common.configuration_manager
    Toggle child pages in navigation
    - vantage6.common.configuration_manager.Configuration
    - vantage6.common.configuration_manager.ConfigurationManager
  - 8.7.20. vantage6.common.context
    Toggle child pages in navigation
    - vantage6.common.context.AppContext
  - 8.7.21. vantage6.common.docker
    Toggle child pages in navigation
    - vantage6.common.docker.addons
      Toggle child pages in navigation
    - vantage6.common.docker.network_manager
      Toggle child pages in navigation
      - vantage6.common.docker.network_manager.remove_subnet_mask
      - vantage6.common.docker.network_manager.NetworkManager
  - 8.7.22. vantage6.common.encryption
    Toggle child pages in navigation
  - 8.7.23. vantage6.common.enum
    Toggle child pages in navigation
    - vantage6.common.enum.AlgorithmViewPolicies
    - vantage6.common.enum.StorePolicies
  - 8.7.24. vantage6.common.exceptions
    Toggle child pages in navigation
    - vantage6.common.exceptions.AuthenticationException
  - 8.7.25. vantage6.common.globals
    Toggle child pages in navigation
    - vantage6.common.globals.InstanceType
    - vantage6.common.globals.NodePolicy
  - 8.7.26. vantage6.common.log
    Toggle child pages in navigation
    - vantage6.common.log.get_file_logger
  - 8.7.27. vantage6.common.serialization
    Toggle child pages in navigation
    - vantage6.common.serialization.serialize
  - 8.7.28. vantage6.common.task_status
    Toggle child pages in navigation
  - 8.7.29. vantage6.common.utest
    Toggle child pages in navigation
9. Glossary

Release notes
Partners

Toggle table of contents sidebar

8.7.24. vantage6.common.exceptions#

Exceptions

AuthenticationException

Exception to indicate authentication has failed

vantage6.common.exceptions.AuthenticationException

vantage6.common.enum.StorePolicies

Copyright © 2022 vantage6

Made with Sphinx and @pradyunsg's Furo