Skip to content

Commit

Permalink
Helm docs for each microservice (#152)
Browse files Browse the repository at this point in the history 
* fixed apiversion nesting

* Add helm docs for each  microservice

---------

Co-authored-by: Somanath Hugar <somanathhugar@fynarfin.io>
  • Loading branch information
@somanath21
somanath21 and Somanath Hugar committed May 22, 2023
1 parent 2f1c4cb commit 6f15cb2
Show file tree
Hide file tree
Showing 20 changed files with 1,883 additions and 98 deletions.
1,165 changes: 1,074 additions & 91 deletions helm/ph-ee-engine/README.md
View file

Large diffs are not rendered by default.

31 changes: 31 additions & 0 deletions helm/ph-ee-engine/ams-paygops/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# paygops_connector

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

paygops_connector

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| LOGGING_LEVEL_ROOT | string | `"INFO"` | |
| SPRING_PROFILES_ACTIVE | string | `"bb"` | |
| ams.local.enabled | bool | `false` | |
| configmap.apiversion | string | `"v1"` | |
| deployment.annotations.deployTime | string | `"{{ .Values.deployTime }}"` | |
| deployment.apiVersion | string | `"apps/v1"` | |
| enabled | bool | `true` | |
| image | string | `""` | |
| imageTag | string | `"latest"` | |
| ingress.apiversion | string | `"networking.k8s.io/v1"` | |
| limits.cpu | string | `"500m"` | |
| limits.memory | string | `"512M"` | |
| paygops.authheader | string | `"PaymentHubTest"` | |
| paygops.base_url | string | `"https://feature-test1.paygops.com/"` | |
| requests.cpu | string | `"100m"` | |
| requests.memory | string | `"256M"` | |
| secret.apiversion | string | `"v1"` | |
| service.apiversion | string | `"v1"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
29 changes: 29 additions & 0 deletions helm/ph-ee-engine/ams-roster/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# roster_connector

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

ph-ee-connector-ams-roster

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| SPRING_PROFILES_ACTIVE | string | `""` | |
| ams.local.enabled | bool | `true` | |
| configmap.apiversion | string | `"v1"` | |
| deployment.annotations.deployTime | string | `"{{ .Values.deployTime }}"` | |
| deployment.apiVersion | string | `"apps/v1"` | |
| enabled | bool | `true` | |
| image | string | `""` | |
| imageTag | string | `"latest"` | |
| ingress.apiversion | string | `"networking.k8s.io/v1"` | |
| limits.cpu | string | `"500m"` | |
| limits.memory | string | `"512M"` | |
| pesacore.auth_header | string | `"PaymentHub"` | |
| requests.cpu | string | `"100m"` | |
| requests.memory | string | `"256M"` | |
| secret.apiversion | string | `"v1"` | |
| service.apiversion | string | `"v1"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
47 changes: 47 additions & 0 deletions helm/ph-ee-engine/connector-ams-mifos/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# ph_ee_connector_ams_mifos

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

ph_ee_connector_ams_mifos

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| SPRING_PROFILES_ACTIVE | string | `""` | |
| ams_local_account_host | string | `"https://fynams.sandbox.mifos.io"` | |
| ams_local_auth_host | string | `"https://fynams.sandbox.mifos.io"` | |
| ams_local_customer_host | string | `"https://fynams.sandbox.mifos.io"` | |
| ams_local_enabled | bool | `true` | |
| ams_local_interop_host | string | `"https://fynams.sandbox.mifos.io"` | |
| ams_local_loan_host | string | `"https://fynams.sandbox.mifos.io/"` | |
| configmap.apiversion | string | `"v1"` | |
| deployment.annotations.deployTime | string | `"{{ .Values.deployTime }}"` | |
| deployment.apiVersion | string | `"apps/v1"` | |
| dfspids | string | `"gorilla,rhino"` | |
| enabled | bool | `true` | |
| extraInitContainers | string | `""` | |
| hostname | string | `"amsmifos.sandbox.mifos.io"` | |
| image | string | `""` | |
| imagePullPolicy | string | `"Always"` | |
| imageTag | string | `"latest"` | |
| ingress.annotations."kubernetes.io/ingress.class" | string | `"nginx"` | |
| ingress.apiversion | string | `"networking.k8s.io/v1"` | |
| ingress.backend.service.name | string | `"ph-ee-connector-ams-mifos"` | |
| ingress.backend.service.port.number | int | `80` | |
| ingress.enabled | bool | `true` | |
| ingress.path | string | `"/"` | |
| ingress.tls[0].hosts | string | `"amsmifos.sandbox.mifos.io"` | |
| ingress.tls[1].secretName | string | `"sandbox-secret"` | |
| keycloak.enabled | bool | `true` | |
| limits.cpu | string | `"500m"` | |
| limits.memory | string | `"512M"` | |
| operations_app.datasource.host | string | `"operationsmysql"` | |
| requests.cpu | string | `"100m"` | |
| requests.memory | string | `"256M"` | |
| secret.apiversion | string | `"v1"` | |
| service.apiversion | string | `"v1"` | |
| wildcardhostname | string | `"amsmifos.sandbox.mifos.io"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
60 changes: 60 additions & 0 deletions helm/ph-ee-engine/connector-bulk/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# connector_bulk

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

ph-ee-connector-bulk

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| SPRING_PROFILES_ACTIVE | string | `""` | |
| aws.access_key | string | `"<access key>"` | |
| aws.region | string | `"<region>"` | |
| aws.secret_key | string | `"<secret key>"` | |
| bucket_name | string | `"paymenthub-ee-dev"` | |
| camel_disable_ssl | bool | `true` | |
| config.approval.enable | bool | `false` | |
| config.backpressure.enable | bool | `false` | |
| config.completion_threshold_check.completion_rate | int | `95` | |
| config.completion_threshold_check.enable | bool | `true` | |
| config.formatting.enable | bool | `false` | |
| config.formatting.standard | string | `"DEFAULT"` | |
| config.mergeback.enable | bool | `true` | |
| config.ordering.enable | bool | `false` | |
| config.ordering.field | string | `""` | |
| config.partylookup.enable | bool | `false` | |
| config.splitting.enable | bool | `true` | |
| config.splitting.sub_batch_size | int | `5` | |
| configmap.apiversion | string | `"v1"` | |
| deployment.annotations.deployTime | string | `"{{ .Values.deployTime }}"` | |
| deployment.apiVersion | string | `"apps/v1"` | |
| enabled | bool | `true` | |
| hostname | string | `"bulk-connector.sandbox.mifos.io"` | |
| image | string | `""` | |
| imagePullPolicy | string | `""` | |
| imageTag | string | `"latest"` | |
| ingress.annotations."konghq.com/plugins" | string | `"cors"` | |
| ingress.annotations."kubernetes.io/ingress.class" | string | `"nginx"` | |
| ingress.apiversion | string | `"networking.k8s.io/v1"` | |
| ingress.backend.service.name | string | `"ph-ee-connector-bulk"` | |
| ingress.backend.service.port.number | int | `80` | |
| ingress.className | string | `"kong"` | |
| ingress.enabled | bool | `true` | |
| ingress.path | string | `"/"` | |
| ingress.tls[0].hosts | string | `"bulk-connector.sandbox.mifos.io"` | |
| ingress.tls[1].secretName | string | `"sandbox-secret"` | |
| limits.cpu | string | `"500m"` | |
| limits.memory | string | `"512M"` | |
| operations_app.contactpoint | string | `""` | |
| operations_app.endpoints.batch_transaction | string | `""` | |
| requests.cpu | string | `"100m"` | |
| requests.memory | string | `"256M"` | |
| secret.apiversion | string | `"v1"` | |
| service.apiversion | string | `"v1"` | |
| tenants | string | `""` | |
| wildcardhostname | string | `"bulk-connector.sandbox.mifos.io"` | |
| zeebe_broker_contactpoint | string | `"zeebe-zeebe-gateway:26500"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
67 changes: 67 additions & 0 deletions helm/ph-ee-engine/connector-channel/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# channel

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

ph-ee-connector-channel

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| DFSPIDS | string | `""` | |
| LOGGING_LEVEL_ROOT | string | `"INFO"` | |
| SPRING_PROFILES_ACTIVE | string | `"bb,tenants"` | |
| configmap.apiversion | string | `"v1"` | |
| deployment.annotations.deployTime | string | `"{{ .Values.deployTime }}"` | |
| deployment.apiVersion | string | `"apps/v1"` | |
| enabled | bool | `true` | |
| hostname | string | `"channel.sandbox.mifos.io"` | |
| image | string | `""` | |
| imagePullPolicy | string | `"Always"` | |
| imageTag | string | `"latest"` | |
| ingress.annotations."kubernetes.io/ingress.class" | string | `"nginx"` | |
| ingress.apiversion | string | `"networking.k8s.io/v1"` | |
| ingress.backend.service.name | string | `"ph-ee-connector-channel"` | |
| ingress.backend.service.port.number | int | `80` | |
| ingress.className | string | `"nginx"` | |
| ingress.enabled | bool | `true` | |
| ingress.path | string | `"/"` | |
| ingress.stub_backend.service.name | string | `"ph-ee-connector-channel"` | |
| ingress.stub_backend.service.port.number | int | `82` | |
| ingress.tls[0].hosts | string | `"notifications.sandbox.mifos.io"` | |
| ingress.tls[1].secretName | string | `"sandbox-secret"` | |
| limits.cpu | string | `"500m"` | |
| limits.memory | string | `"512M"` | |
| livenessProbe.httpGet.path | string | `"/actuator/health/liveness"` | |
| livenessProbe.httpGet.port | int | `8080` | |
| livenessProbe.initialDelaySeconds | int | `20` | |
| livenessProbe.periodSeconds | int | `30` | |
| notifications.NOTIFICATION_FAILURE_ENABLED | string | `"false"` | |
| notifications.NOTIFICATION_SUCCESS_ENABLED | string | `"false"` | |
| operations.authEnabled | bool | `false` | |
| operations.url | string | `"http://ops-bk.sandbox.mifos.io/api/v1"` | |
| readinessProbe.httpGet.path | string | `"/actuator/health/readiness"` | |
| readinessProbe.httpGet.port | int | `8080` | |
| readinessProbe.initialDelaySeconds | int | `20` | |
| readinessProbe.periodSeconds | int | `30` | |
| redis.host | string | `"127.0.0.1"` | |
| redis.idempotency.apiList | string | `"/channel/transfer,/channel/collection,/channel/gsma/transaction,/channel/transactionRequest"` | |
| redis.idempotency.enabled | bool | `true` | |
| redis.idempotency.keyFormat | string | `"clientCorrelationId_tenant_api"` | |
| redis.password | string | `""` | |
| redis.port | int | `6379` | |
| requests.cpu | string | `"100m"` | |
| requests.memory | string | `"256M"` | |
| secret.apiversion | string | `"v1"` | |
| service.apiversion | string | `"v1"` | |
| stub_hostname | string | `"channel-gsma.sandbox.mifos.io"` | |
| tenantPrimary.clientId | string | `"mifos"` | |
| tenantPrimary.clientSecret | string | `"password"` | |
| tenantPrimary.tenant | string | `"rhino"` | |
| tenantSecondary.clientId | string | `"mifos"` | |
| tenantSecondary.clientSecret | string | `"password"` | |
| tenantSecondary.tenant | string | `"gorilla"` | |
| wildcardhostname | string | `"channel.sandbox.mifos.io"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
29 changes: 29 additions & 0 deletions helm/ph-ee-engine/connector-gsma/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ph_ee_connector_gsma

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

ph-ee-connector-gsma

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| SPRING_PROFILES_ACTIVE | string | `"bb"` | |
| api.channel | string | `"http://ph-ee-connector-channel"` | |
| configmap.apiversion | string | `"v1"` | |
| deployment.annotations.deployTime | string | `"{{ .Values.deployTime }}"` | |
| deployment.apiVersion | string | `"apps/v1"` | |
| enabled | bool | `true` | |
| image | string | `""` | |
| imageTag | string | `"latest"` | |
| ingress.apiversion | string | `"networking.k8s.io/v1"` | |
| limits.cpu | string | `"500m"` | |
| limits.memory | string | `"512M"` | |
| replicas | int | `1` | |
| requests.cpu | string | `"100m"` | |
| requests.memory | string | `"256M"` | |
| secret.apiversion | string | `"v1"` | |
| service.apiversion | string | `"v1"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
47 changes: 47 additions & 0 deletions helm/ph-ee-engine/connector-mojaloop/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# ph_ee_connector_mojaloop

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

ph_ee_connector_mojaloop

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| DFSPIDS | string | `"gorilla,rhino"` | |
| SPRING_PROFILES_ACTIVE | string | `""` | |
| configmap.apiversion | string | `"v1"` | |
| deployment.annotations.deployTime | string | `"{{ .Values.deployTime }}"` | |
| deployment.apiVersion | string | `"apps/v1"` | |
| enabled | bool | `true` | |
| hostname | string | `"mojaloop.sandbox.mifos.io"` | |
| image | string | `""` | |
| imageTag | string | `"latest"` | |
| ingress.annotations."kubernetes.io/ingress.class" | string | `"nginx"` | |
| ingress.apiversion | string | `"networking.k8s.io/v1"` | |
| ingress.backend.service.name | string | `"ph-ee-connector-mojaloop-java"` | |
| ingress.backend.service.port.number | int | `80` | |
| ingress.className | string | `"nginx"` | |
| ingress.enabled | bool | `true` | |
| ingress.path | string | `"/"` | |
| ingress.tls[0].hosts | string | `"mojaloop.sandbox.mifos.io"` | |
| ingress.tls[1].secretName | string | `"sandbox-secret"` | |
| limits.cpu | string | `"500m"` | |
| limits.memory | string | `"512M"` | |
| requests.cpu | string | `"100m"` | |
| requests.memory | string | `"256M"` | |
| secret.apiversion | string | `"v1"` | |
| service.apiversion | string | `"v1"` | |
| switch.als.host | string | `"http://account-lookup-service.sandbox.mifos.io"` | |
| switch.als.service | string | `"account-lookup-service.local"` | |
| switch.oracle.host | string | `"http://moja-simulator.sandbox.mifos.io"` | |
| switch.quotes.host | string | `"http://quoting-service.sandbox.mifos.io"` | |
| switch.quotes.service | string | `"quoting-service.sandbox.mifos.io"` | |
| switch.transactions.host | string | `"http://ml-api-adapter.sandbox.mifos.io"` | |
| switch.transactions.service | string | `"ml-api-adapter.sandbox.mifos.io"` | |
| switch.transfers.host | string | `"http://api-adapter.sandbox.mifos.io"` | |
| switch.transfers.service | string | `"api-adapter.sandbox.mifos.io"` | |
| wildcardhostname | string | `"mojaloop.sandbox.mifos.io"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
69 changes: 69 additions & 0 deletions helm/ph-ee-engine/connector-mpesa/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# mpesa

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

ph-ee-connector-mpesa

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| LOGGING_LEVEL_ROOT | string | `"INFO"` | |
| SPRING_PROFILES_ACTIVE | string | `""` | |
| accounts.paygops.api_host | string | `"https://sandbox.safaricom.co.ke"` | |
| accounts.paygops.auth_host | string | `"https://sandbox.safaricom.co.ke/oauth/v1/generate"` | |
| accounts.paygops.business_short_code | string | `""` | |
| accounts.paygops.client_key | string | `"<client key>"` | |
| accounts.paygops.client_secret | string | `"<client secret>"` | |
| accounts.paygops.name | string | `"paygops"` | |
| accounts.paygops.pass_key | string | `"<pass key>"` | |
| accounts.paygops.till | string | `""` | |
| accounts.roster.api_host | string | `"https://sandbox.safaricom.co.ke"` | |
| accounts.roster.auth_host | string | `"https://sandbox.safaricom.co.ke/oauth/v1/generate"` | |
| accounts.roster.business_short_code | string | `""` | |
| accounts.roster.client_key | string | `"<client key>"` | |
| accounts.roster.client_secret | string | `"<client secret>"` | |
| accounts.roster.name | string | `"roster"` | |
| accounts.roster.pass_key | string | `"<pass key>"` | |
| accounts.roster.till | string | `""` | |
| api_timeout | int | `60000` | |
| callback_host | string | `"https://mpesa.sandbox.mifos.io/"` | |
| channel.host | string | `"http://ph-ee-connector-channel"` | |
| configmap.apiversion | string | `"v1"` | |
| deployment.annotations.deployTime | string | `"{{ .Values.deployTime }}"` | |
| deployment.apiVersion | string | `"apps/v1"` | |
| enabled | bool | `true` | |
| hostname | string | `"mpesa.sandbox.mifos.io"` | |
| image | string | `""` | |
| imageTag | string | `"latest"` | |
| ingress.annotations."kubernetes.io/ingress.class" | string | `"nginx"` | |
| ingress.apiversion | string | `"networking.k8s.io/v1"` | |
| ingress.backend.service.name | string | `"ph-ee-connector-mpesa"` | |
| ingress.backend.service.port.number | int | `80` | |
| ingress.className | string | `"nginx"` | |
| ingress.enabled | bool | `true` | |
| ingress.path | string | `"/"` | |
| ingress.tls[0].hosts | string | `"mpesa.sandbox.mifos.io"` | |
| ingress.tls[1].secretName | string | `"sandbox-secret"` | |
| limits.cpu | string | `"500m"` | |
| limits.memory | string | `"512M"` | |
| paybill.accountHoldingInstitutionId | string | `"gorilla"` | |
| paybill.paygops.business_short_code | string | `""` | |
| paybill.paygops.currency | string | `"KES"` | |
| paybill.roster.business_short_code | string | `""` | |
| paybill.roster.currency | string | `"KES"` | |
| paygops.host | string | `"http://ph-ee-connector-ams-paygops"` | |
| requests.cpu | string | `"100m"` | |
| requests.memory | string | `"256M"` | |
| retry_count | int | `3` | |
| roster.host | string | `"http://ph-ee-connector-ams-roster"` | |
| secret.apiversion | string | `"v1"` | |
| service.apiversion | string | `"v1"` | |
| skip.enabled | bool | `false` | |
| tenant | string | `"lion"` | |
| wildcardhostname | string | `"mpesa.sandbox.mifos.io"` | |
| zeebe_broker_contactpoint | string | `"zeebe-zeebe-gateway:26500"` | |
| zeebe_init_transfer_wait_timer | int | `10` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Loading

0 comments on commit 6f15cb2

Please sign in to comment.