Skip to content
Snippets Groups Projects

GONRG-5542 fix update readme for ref arch

Merged Tejinder Dhingra requested to merge GONRG-5542-fix-update-readme-for-ref-arch into master
@@ -52,15 +52,21 @@ if not scpecified use command:
kubectl annotate sc <STORAGE_CLASS_NAME> "storageclass.kubernetes.io/is-default-class"="true"
```
The installation requires at least 2 cluster nodes. It is partially compatible with [minikube](https://github.com/kubernetes/minikube) (see more details in the [examples](../../examples/osdu_onprem_minikube/README.md)).
This installation has been tested, in two modes, with following cluster configurations:
1. ##### Development Mode
* Single node cluster : 8 vCPU and 32 GB RAM
* Two nodes cluster : 4 vCPU and 15 GB RAM per node
* [Minicube cluster](../../examples/osdu_onprem_minikube/README.md) : 6 vCPU and 16 GB RAM
2. ##### Secure Mode
* Single node cluster : 11 vCPU and 27 GB RAM
* Two nodes cluster : 6 vCPU and 12 GB RAM per node
Helm chart could be installed in **two modes**:
Helm chart can be installed in **two modes**:
1. #### **Development mode**
Helm chart installs OSDU to the namespace **not labeled with Istio**: [^3]
* it requires fewer hardware resources: 2 worker nodes (not used by other processes) with 4 vCPU and 11 GB RAM per each[^4]
* it reduces security: Istio security policy will not be applied for partition and entitlements OSDU services, which means that authentication will not work for requests because authentication is configured on the Istio side
* Istio is required and used for traffic routing
@@ -71,7 +77,6 @@ Helm chart could be installed in **two modes**:
Helm chart is installed to the namespace **labeled with Istio**[^3].
* In this case, each pod works with an Istio sidecar injected with a security policy and authentication.
* it requires the following free hardware resources: 11 vCPU, 27 GB RAM[^4]
**We strongly recommend the approach for any publicly available endpoints.**
@@ -89,7 +94,7 @@ The code works in Debian-based Linux (Debian 10 and Ubuntu 20.04) and Windows WS
### Packages
Packages are only needed for installation from a local computer.
Packages needed for installation from a local computer.
* **HELM** (version: v3.7.1 or higher) [helm](https://helm.sh/docs/intro/install/)[^1]
@@ -419,22 +424,17 @@ helm install osdu-onprem
It takes about 10-20 minutes to install infrastructure applications and OSDU services. It is an expected behavior pods restart several times until they are ready.
### Uninstall OSDU on-prem helm chart
After the helm install process is completed, it provides the list of OSDU Services endpoints, which you can use for verification of the status of your applications. Before verification please wait for around 20 mins till all the pods are in running state.
To uninstall OSDU on-prem helm chart use commands:
To check the status of pods do run the following command from terminal
```sh
helm uninstall osdu-onprem
kubectl get pods
```
Delete secrets and pvc:
```sh
kubectl delete secret --all; kubectl delete pvc --all
```
### OSDU services endpoints
The list of OSDU services endpoints would look like as below, wherein "domain_name" would be replaced with the domain you have provided earlier in values.yaml.
<pre>
CRS-Catalog: "http://osdu.domain_name/api/crs/catalog/v2/info"
@@ -559,6 +559,20 @@ Example of output message after the previous command if you use default variable
</details>
### Uninstall OSDU on-prem helm chart
To uninstall OSDU on-prem helm chart use commands:
```sh
helm uninstall osdu-onprem
```
Delete secrets and pvc:
```sh
kubectl delete secret --all; kubectl delete pvc --all
```
## Install logging and monitoring helm chart
Helm chart with logging and monitoring tools could be installed as described [here](../logging-and-monitoring).
Loading