diff --git a/examples/osdu_onprem_minikube/README.md b/examples/osdu_onprem_minikube/README.md index a2bb4c234befcde11a49f2723004ec50221137cd..01054f934b85646fb9b1c7b73ca9b7cd9b1d00ec 100644 --- a/examples/osdu_onprem_minikube/README.md +++ b/examples/osdu_onprem_minikube/README.md @@ -12,7 +12,7 @@ The solution is based on the original [OSDU on-prem helm chart](../../helm/osdu- ### Minikube -The code was tested on minikube v1.25.2[^1] with istio and istio-provisioner minikube addons enabled, in [development mode](../../helm/osdu-infra-onprem/README.md#1--development-mode) (a single node, **6vcpu**, **16Gb memory**) +The code was tested on minikube v1.25.2[^1] with istio and istio-provisioner minikube addons enabled, in [development mode](../../helm/osdu-infra-onprem/README.md#1-development-mode) (a single node, **6vcpu**, **16Gb memory**) Minikube configuration: @@ -27,4 +27,4 @@ minikube config set memory 16000 ## Provisioning -When minikube is ready, OSDU can be installed with [external](../osdu_onprem_external_infra/README.md#elasticsearch) elasticsearch and [custom-values.yaml](../simple_osdu_onprem/README.md) installation. +When minikube is ready, OSDU can be installed with [external](../osdu_onprem_external_infra/README.md#elasticsearch) elasticsearch and [custom-values.yaml](../simple_osdu_onprem/README.md#provisioning-with-custom-values) installation. diff --git a/helm/osdu-infra-onprem/README.md b/helm/osdu-infra-onprem/README.md index e3b4098f971d041bf9ac6e130f8ce813cd474ba2..1dc5c3ecae3b4605e9fabd6d06a7faf286efdabe 100644 --- a/helm/osdu-infra-onprem/README.md +++ b/helm/osdu-infra-onprem/README.md @@ -90,7 +90,9 @@ Specify the stoarge class with the command below: ### 4. Install ISTIO in cluster -Install ISTIO, version 1.12.6 or above. Visit [this site](https://istio.io/latest/docs/setup/getting-started/) for detailed information about how to install ISTIO in your cluster. +Install ISTIO, version 1.12.6 or above, this installation has been tested with **default** installation configuration profile. + +Visit [this site](https://istio.io/latest/docs/setup/getting-started/) for detailed information about how to install ISTIO in your cluster. To learn more about ISTIO installation configuration profile visit [this link](https://istio.io/latest/docs/setup/additional-setup/config-profiles/). ### 5. Add namespace label (for secure mode) @@ -136,7 +138,7 @@ To verify that all the resources and tools are ready for installation, perform t kubectl get svc -A | grep 'istio-' ``` - The output list should include following services: + The output list can be similar as noted below: * istio-citadel * istio-galley * istio-ingressgateway @@ -145,6 +147,8 @@ To verify that all the resources and tools are ready for installation, perform t * istio-sidecar-injector * istio-telemetry + *Note: The services in the above list may also vary upon version and installation profile used, for confirmation kindly refer to the documentation of the specific version on ISTIOs official site.* + * To get ISTIO Ingress Gateway IP address run: ```sh @@ -202,7 +206,9 @@ More details on configuration can be found in the original [Bitnami Helm Chart R ### Airflow Environmental variables List of arbitrary env variables. These variables must be set for Scheduler, Workers and Webserver pods. -### FIXME Add all variables to readme! + +### FIXME Add all variables to readme + | Environmental variables | Airflow representation of variables | Value | | --------------------------------------------------------- | ------------------------------------------- | ------------------------------------------- | | AIRFLOW\_VAR\_ANTHOS\_\_IMAGE\_\_CSV\_PARSER | anthos\_\_image\_\_csv\_parser | {path-to-image}/csv-parser |