summaryrefslogtreecommitdiffstats
path: root/docs/platform/installation/user-guide/uui-guide.rst
blob: 0ade9e7511a6d2787943c8dfb5b1b2f7e1bbaade (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.. contents::
   :depth: 3
..


**1. Confirm Usecase-UI MicroService**
======================================

Confirm that the Usecase-UI microservice has been successfully registered in MSB with OOM.

**2. Register Usecase-UI MicroService**
=======================================

If Usecase-UI microservice does not exist in MSB, please register them manually.
::
            
    curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "usecaseui-server", "version": "v1", "url": "/api/usecaseui-server/v1","protocol": "REST", "nodes": [{"ip": "${UUI_SERVER_IP}","port": "8082"}]}' "http://${MSB_IP}:30280/api/microservices/v1/services"
    curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "usecaseui-ui", "version": "v1", "url": "/usecase-ui","path": "/iui/usecaseui","protocol": "UI", "nodes": [{"ip": "${UUI_IP}","port": "8080"}]}' "http://${MSB_IP}:30280/api/microservices/v1/services"

**3. Open Usecase-UI Home**
===========================

Please open Usecase-UI dashboard page through your browser.

::

  http://${MSB_IP}:30280/iui/usecaseui/
  
**4. Specific Pages Function**
==============================

Usecase-UI project consists of 5 modules which are *Home*, *Cusomer*, *Monitor*, *Services*, *Network Topology*. 

*4.1. Home Module*

|homepage|

.. |homepage| image:: ../../images/usecaseui-architecture-homepage.png
   :width: 5.97047in
   :height: 3.63208in

*4.2. Cusomer Module*

*4.3. Monitor Module*

*4.4. Services Module*

*4.5. Network Topology Module*
criptExecutorConfiguration): port = configuration.script_executor_property('port') authType = configuration.script_executor_property('authType') maxWorkers = configuration.script_executor_property('maxWorkers') if authType == 'tls-auth': cert_chain_file = configuration.script_executor_property('certChain') private_key_file = configuration.script_executor_property('privateKey') logger.info("Setting GRPC server TLS authentication, cert file(%s) private key file(%s)", cert_chain_file, private_key_file) # read in key and certificate with open(cert_chain_file, 'rb') as f: certificate_chain = f.read() with open(private_key_file, 'rb') as f: private_key = f.read() # create server credentials server_credentials = grpc.ssl_server_credentials(((private_key, certificate_chain),)) # create server server = grpc.server(futures.ThreadPoolExecutor(max_workers=int(maxWorkers))) BluePrintProcessing_pb2_grpc.add_BluePrintProcessingServiceServicer_to_server( BluePrintProcessingServer(configuration), server) # add secure port using credentials server.add_secure_port('[::]:' + port, server_credentials) server.start() else: logger.info("Setting GRPC server base authentication") basic_auth = configuration.script_executor_property('token') header_validator = RequestHeaderValidatorInterceptor( 'authorization', basic_auth, grpc.StatusCode.UNAUTHENTICATED, 'Access denied!') # create server with token authentication interceptors server = grpc.server(futures.ThreadPoolExecutor(max_workers=int(maxWorkers)), interceptors=(header_validator,)) BluePrintProcessing_pb2_grpc.add_BluePrintProcessingServiceServicer_to_server( BluePrintProcessingServer(configuration), server) server.add_insecure_port('[::]:' + port) server.start() logger.info("Command Executor Server started on %s" % port) try: while True: time.sleep(_ONE_DAY_IN_SECONDS) except KeyboardInterrupt: server.stop(0) if __name__ == '__main__': config_file = str(PurePath(Path().absolute())) + '/configuration.ini' configuration = ScriptExecutorConfiguration(config_file) logging_formater = '%(asctime)s - %(name)s - %(threadName)s - %(levelname)s - %(message)s' logging.basicConfig(filename=configuration.script_executor_property('logFile'), level=logging.DEBUG, format=logging_formater) console = logging.StreamHandler() console.setLevel(logging.INFO) formatter = logging.Formatter(logging_formater) console.setFormatter(formatter) logging.getLogger('').addHandler(console) serve(configuration)