diff --git a/README.md b/README.md index 7892ec38e1de4ae3918d12c4c70137ba9f0b1984..b3e4a16bd06d7258450fbd107ec06f54bc0e4a0a 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,19 @@ OEG acts as a middleware layer between the CAMARA APIs and the Service Resource OEG can be deployed in a Kubernetes cluster by executing the file _oeg-deployment.yaml_ located in the root folder. This file will create a OEG Deployment resource and its supporting native K8s Service. The following table contains the necesssary environment variables for the Kubernetes adapter. +| **Variable** | **Description** | +|-----------------------------|-------------------------------------------------------------| +| `SRM_HOST` | Base URL of the Service Resource Manager | +| `PI_EDGE_USERNAME` | Username for authenticating to SRM | +| `PI_EDGE_PASSWORD` | Password for authenticating to SRM | +| `FEDERATION_MANAGER_HOST` | Base URL of the Federation Manager | +| `SOURCE_OP_ID` | ID of your Operator Platform (used for federation logic) | +| `HTTP_PROXY` *(optional)* | HTTP proxy URL if needed | + + + +You can also run the OEG outside of k8s environment: -### Usage Before running the server you need to `mv env.sample .env` and update variables to properly link to a running OP service resource manager instance. To run the server, please execute the following from the root directory: