Merge pull request #173 from bci-oss/feature/fuseki_documentation

feat:Added fuseki documentation

INSTALL.md

@@ -19,6 +19,17 @@
 -->
 ## Deploy using Helm and K8s
 If you have a running Kubernetes cluster available, you can deploy the Semantic Hub using our Helm Chart, which is located under `./charts/semantic-hub`.
+
+## Precondition
+Build fuseki docker image by following the below steps :
+- Download [jena-fuseki-docker-4.7.0.zip](https://repo1.maven.org/maven2/org/apache/jena/jena-fuseki-docker/4.7.0/jena-fuseki-docker-4.7.0.zip)
+- Unzip the jena-fuseki-docker-4.7.0.zip.
+- Build the docker image by running the command - `docker build --build-arg JENA_VERSION=4.7.0 -t jena-fuseki-docker:4.7.0 .`
+
+This docker image `jena-fuseki-docker:4.7.0` will be used in the Helm deployment and test - [values.yaml](charts/semantic-hub/values.yaml) (graphdb.image).
+
+## Install Instructions
+
 In case you don't have a running cluster, you can set up one by yourself locally, using [minikube](https://minikube.sigs.k8s.io/docs/start/).
 In the following, we will use a minikube cluster for reference.
 
@@ -66,11 +77,12 @@ The Helm Chart can be configured using the following parameters (incomplete list
 | `hub.ingress.annotations`     | Annotations to further configure the `Ingress` resource, e.g. for using with `cert-manager`.  |  |
 
 ### GraphDB
-| Parameter       | Description | Default value       |
-| ---             | ---         | ---                 |
-| `graphdb.enabled`     | Configures, whether a separate Fuseki Triplestore should be deployed in the cluster.   | `true` |
-| `graphdb.storageClassName`     | Defines the storage class name of the `PersistentVolumeClaim` that is used to persist the GraphDB data.  | `standard` |
-| `graphdb.storageSize`     | Size of the `PersistentVolumeClaim`  | `50Gi` |
+| Parameter       | Description                                                                                             | Default value       |
+| ---             |---------------------------------------------------------------------------------------------------------| ---                 |
+| `graphdb.enabled`     | Configures, whether a separate Fuseki Triplestore should be deployed in the cluster.                    | `true` |
+| `graphdb.storageClassName`     | Defines the storage class name of the `PersistentVolumeClaim` that is used to persist the GraphDB data. | `standard` |
+| `graphdb.image`     | Defines the fuseki docker image and version details.                                                    | `jena-fuseki-docker:4.7.0` |
+| `graphdb.storageSize`     | Size of the `PersistentVolumeClaim`                                                                     | `50Gi` |
 
 ### Prerequisites
 - Kubernetes 1.19+

README.md

@@ -22,6 +22,14 @@
 The Semantic Hub is a logical and architectural component of Tractus-X.
 The source code under this folder contains reference implementations of the SLDT Semantic Hub
 
+## Precondition
+Build fuseki docker image by following the below steps :
+- Download [jena-fuseki-docker-4.7.0.zip](https://repo1.maven.org/maven2/org/apache/jena/jena-fuseki-docker/4.7.0/jena-fuseki-docker-4.7.0.zip)
+- Unzip the jena-fuseki-docker-4.7.0.zip.
+- Build the docker image by running the command - `docker build --build-arg JENA_VERSION=4.7.0 -t jena-fuseki-docker:4.7.0 .`
+
+This docker image `jena-fuseki-docker:4.7.0` will be used in the Helm deployment and test - [values.yaml](charts/semantic-hub/values.yaml) (graphdb.image).
+
 ## Build Packages
 
 Run `mvn install` to run unit tests, build and install the package.
@@ -32,8 +40,6 @@ To check whether the build was successful, you can start the resulting JAR file
 ## Build Docker
 Run `docker build -t semantic-hub .`
 
-In case you want to publish your image into a remote container registry, apply the tag accordingly and `docker push` the image.
-
 ## Install Instructions
 For detailed instructions please refer to our [INSTALL.md](INSTALL.md)
 

charts/semantic-hub/Chart.yaml

@@ -26,7 +26,7 @@ sources:
   - https://github.com/eclipse-tractusx/sldt-semantic-hub
 
 type: application
-version: 0.1.27
+version: 0.1.28
 appVersion: 0.2.10-M1
 dependencies:
   - repository: https://charts.bitnami.com/bitnami

charts/semantic-hub/values.yaml

@@ -70,7 +70,7 @@ hub:
 graphdb:
   ## Include Fuski deployment or deploy separately
   enabled: false
-  image: ghcr.io/catenax-ng/jena-fuseki:4.7.0
+  image: jena-fuseki-docker:4.7.0
   imagePullPolicy: IfNotPresent
   replicaCount: 1
   containerPort: 3030