Metadata-Version: 2.1
Name: fabric-cf
Version: 1.0b32
Summary: Fabric Control Framework
Home-page: https://github.com/fabric-testbed/ControlFramework
Author: Komal Thareja, Ilya Baldin
Author-email: kthare10@renci.org, ibaldin@renci.org
License: UNKNOWN
Description: [![Requirements Status](https://requires.io/github/fabric-testbed/ControlFramework/requirements.svg?branch=master)](https://requires.io/github/fabric-testbed/ControlFramework/requirements/?branch=master)
        
        [![PyPI](https://img.shields.io/pypi/v/fabric-cf?style=plastic)](https://pypi.org/project/fabric-cf/)
        
        # Control Framework
        This repository contains Fabric Control Framework and Actor implementations.
        
        ## Overview
        Fabric Control Framework has 3 actors
        - Controller
        - Broker
        - Aggregate Manager
        
        ## Broker
        Broker is an agent of CF that collects resource availability information from multiple aggregate managers and can make resource promises on their behalf. More details can be found [here](fabric_cf/broker/Readme.md)
        
        ## Aggregate Manager
        AM is a CF agent responsible for managing aggregate resources. Is under the control of the owner of the aggregate. Provides promises of resources to brokers and controllers/ orchestrators. More details can be found [here](fabric_cf/authority/Readme.md)
        
        ## Orchestrator
        Orchestrator is an agent of CF that makes allocation decisions (embedding) of user requests into available resources. Communicates with user to collect slice requests, communicates with broker or aggregate managers to collect resource promises, communicates with aggregate managers to provision promised resources. Creates slices, configures resources, maintains their state, modifies slices and slivers. More details can be found [here](fabric_cf/orchestrator/Readme.md)  
        
        ## Requirements
        Python 3.7+
        
        ## Build Docker Images
        
        ### Authority Docker Image
        ```
        docker build -f Dockerfile-auth -t authority .
        ```
        
        ### Broker Docker Image
        ```
        docker build -f Dockerfile-broker -t broker .
        ```
        
        ### Orchestrator Docker Image
        ```
        docker build -f Dockerfile-orchestrator -t orchestrator .
        ```
        
        ## Configuration pre-requisites
        - Kafka Configuration
          - Request topic, consumer and producer credentials for each Actor from [Song](ywsong2@g.uky.edu) 
          - Request Hosts running the Actors to be added to Kafka Brokers and Schema Registry Firewall
          - Make sure to configure consumer.group.id different for each actor
        
Keywords: Swagger,Fabric Control Framework
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
