diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 39 |
1 files changed, 19 insertions, 20 deletions
@@ -13,9 +13,9 @@ After cloning the project, execute the following Maven command from the project' Now, you can build your Docker image: - > docker build -t onap/crud-service target - -### Deploying The Microservice + > docker build -t onap/crud-service target + +### Deploying The Microservice Push the Docker image that you have built to your Docker repository and pull it down to the location from which you will be running the service. @@ -24,7 +24,7 @@ Push the Docker image that you have built to your Docker repository and pull it ../logs ../appconfig ../appconfig/auth - + You will be mounting these as data volumes when you start the Docker container. #### Configuring the Microservice @@ -33,24 +33,24 @@ Create configuration file **../appconfig/crud-api.properties** # List of hostnames/addresses of the graph database crud.graph.host=graphhost1.onap.com,graphhost2.onap.com - + # Port on which to connect to the graph database crud.graph.port=2181 - + # Name of the graph on which this service will operate crud.graph.name=aaigraphautomation - + # Backend storage type for the graph. Types currently supported: # - cassandra # - hbase crud.storage.backend.db=cassandra - + # List of hostnames/addresses of the DMaaP/Kafka cluster on which to post notification events event.stream.hosts=kafkahost1.onap.com,kafkahost2.onap.com - + # Number of events to bath up before posting to DMaaP/Kafka event.stream.batch-size=100 - + # Amount of time (in ms) to wait before sending batch of events (when batch does not reach batch-size) event.stream.batch-timeout=60000 @@ -70,7 +70,7 @@ This policy file defines which client certificates are authorized to use the ser "users": [ { "username": "CN=admin, OU=My Organization Unit, O=, L=Sometown, ST=SomeProvince, C=CA" - } + } ] } ] @@ -94,7 +94,7 @@ You can now start the Docker container in the following manner: -v /<path>/appconfig:/opt/app/crud-service/config \ --name crud-service \ {{your docker repo}}/crud-service - + Where, {{your docker repo}} = The Docker repository you have published your CRUD Service image to. @@ -107,20 +107,19 @@ Where, URL: https://<host>:9520/services/crud-api/v1/echo-service/echo/<input> Method: GET Success Response: 200 - + ### Vertex APIs -Gizmo exposes a set of APIs to operate on verticies within the graph. +Gizmo exposes a set of APIs to operate on verticies within the graph. [Vertex APIs](./VERTEX.md) ### Edge APIs -Gizmo exposes a set of APIs to operate on edges within the graph. +Gizmo exposes a set of APIs to operate on edges within the graph. [Edge APIs](./EDGE.md) ### Bulk API -Gizmo exposes a bulk API to operate on multiple graph entities within a single request. +Gizmo exposes a bulk API to operate on multiple graph entities within a single request. [Bulk API](./BULK.md) - - - - +## ASYNC PIPELINE +Gizmo is capable of working Synchronously and Asynchronously. Asynchronous Pipeline is explained +here: [Async Pipeline](./ASYNC.MD) |