| liamfallon | b71482a | 2022-11-09 17:41:41 +0000 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | |
| 3 | .. _ui-label: |
| 4 | |
| 5 | The Policy Framework User Interfaces |
| 6 | #################################### |
| 7 | |
| 8 | The Policy Framework has a demonstration user interface that supports design time and runtime activities for the Policy |
| 9 | Framework. |
| 10 | |
| 11 | Design time activities are offline activities such as policy editing and ACM composition preparation. The design time UI |
| 12 | works with offline files, producing artifacts that can be consumed by the runtime Policy Framework APIs. |
| 13 | |
| 14 | Runtime operations include creating and updating policy types and policies, deploying policies as well as working with |
| 15 | Automation Compositions. The runtime UI works towards the REST APIs published by the Policy Framework. |
| 16 | |
| 17 | .. image:: images/UIArchitecture.png |
| 18 | |
| 19 | .. note:: |
| 20 | The policy framework UI is developed for use in demonstrations. It is a work in progress. As such, it does not cover |
| 21 | all the features and functions that are avaiable on the Policy Framework REST APIs. |
| 22 | |
| 23 | A Policy Framework installation in Kubernetes is shown in the figure above. The **policy-api**, **policy-pap** and |
| 24 | **acm-runtime** microservices publish REST interfaces. In a Service Mesh installation, these interfaces are exposed |
| 25 | over HTTP and are available inside the Service Mesh. Alternatively, the interfaces may be exposed publicly over HTTPS. |
| 26 | |
| 27 | The **gui-server** microservice serves the GUI code to the browser for Policy Framework UI. In addition, it acts as |
| 28 | a single point of reference for the REST interfaces provided by **policy-api**, **policy-pap**, and **acm-runtime**. |
| 29 | It can also be used as a HTTPS gatewy for REST references into a Policy Framework deployment in a Kubernetes cluster. |
| 30 | |
| 31 | The Policy Framework UI runs in a browser as a Web application. It has a **designtime** and a **runtime** part. |
| 32 | |
| 33 | .. image:: images/MainUI.png |
| 34 | |
| 35 | The Policy Framework main UI is shown in the image above. It is, at present, a plain HTML page. |
| 36 | |
| 37 | The pages below describe the elements of the Policy Framework UI. |
| 38 | |
| 39 | .. toctree:: |
| 40 | :maxdepth: 4 |
| 41 | |
| 42 | designtime-ui/designtime-ui |
| 43 | runtime-ui/runtime-ui |