From 35d1a8a6ecda8cf513caa1e829fb7d9c4c29ab81 Mon Sep 17 00:00:00 2001 From: Bastiaan Date: Fri, 9 Feb 2024 15:29:18 +0100 Subject: [PATCH] update readme --- .../radar-rest-sources-authorizer/README.md | 87 ++++++++++--------- 1 file changed, 44 insertions(+), 43 deletions(-) diff --git a/charts/radar-rest-sources-authorizer/README.md b/charts/radar-rest-sources-authorizer/README.md index fbbcacd6..a0544bc4 100644 --- a/charts/radar-rest-sources-authorizer/README.md +++ b/charts/radar-rest-sources-authorizer/README.md @@ -3,7 +3,7 @@ # radar-rest-sources-authorizer [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/radar-rest-sources-authorizer)](https://artifacthub.io/packages/helm/radar-base/radar-rest-sources-authorizer) -![Version: 1.1.2](https://img.shields.io/badge/Version-1.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.4.0](https://img.shields.io/badge/AppVersion-4.4.0-informational?style=flat-square) +![Version: 1.1.3](https://img.shields.io/badge/Version-1.1.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.4.0](https://img.shields.io/badge/AppVersion-4.4.0-informational?style=flat-square) A Helm chart for the front-end application of RADAR-base Rest Sources Authorizer which is a portal to authorize the Fitbit connector to read data from Fitbit accounts. @@ -29,45 +29,46 @@ A Helm chart for the front-end application of RADAR-base Rest Sources Authorizer ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| replicaCount | int | `2` | Number of radar-rest-sources-authorizer replicas to deploy | -| image.repository | string | `"radarbase/radar-rest-source-authorizer"` | radar-rest-sources-authorizer image repository | -| image.tag | string | `"4.4.0"` | radar-rest-sources-authorizer image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. | -| image.pullPolicy | string | `"IfNotPresent"` | radar-rest-sources-authorizer image pull policy | -| imagePullSecrets | list | `[]` | Docker registry secret names as an array | -| nameOverride | string | `""` | String to partially override radar-rest-sources-authorizer.fullname template with a string (will prepend the release name) | -| fullnameOverride | string | `""` | String to fully override radar-rest-sources-authorizer.fullname template with a string | -| podSecurityContext | object | `{}` | Configure radar-rest-sources-authorizer pods' Security Context | -| securityContext | object | `{}` | Configure radar-rest-sources-authorizer containers' Security Context | -| service.type | string | `"ClusterIP"` | Kubernetes Service type | -| service.port | int | `8080` | radar-rest-sources-authorizer port | -| ingress.enabled | bool | `true` | Enable ingress controller resource | -| ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer | -| ingress.path | string | `"/rest-sources/authorizer"` | Path within the url structure | -| ingress.pathType | string | `"ImplementationSpecific"` | Ingress Path type | -| ingress.ingressClassName | string | `"nginx"` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | -| ingress.hosts | list | `["localhost"]` | Hosts to accept requests from | -| ingress.tls.secretName | string | `"radar-base-tls-radar-rest-sources-authorizer"` | TLS Secret Name | -| resources.requests | object | `{"cpu":"100m","memory":"128Mi"}` | CPU/Memory resource requests | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| tolerations | list | `[]` | Toleration labels for pod assignment | -| affinity | object | `{}` | Affinity labels for pod assignment | -| extraEnvVars | list | `[]` | Extra environment variables | -| customLivenessProbe | object | `{}` | Custom livenessProbe that overrides the default one | -| livenessProbe.enabled | bool | `true` | Enable livenessProbe | -| livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe | -| livenessProbe.periodSeconds | int | `30` | Period seconds for livenessProbe | -| livenessProbe.timeoutSeconds | int | `3` | Timeout seconds for livenessProbe | -| livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | -| livenessProbe.failureThreshold | int | `3` | Failure threshold for livenessProbe | -| customReadinessProbe | object | `{}` | Custom readinessProbe that overrides the default one | -| readinessProbe.enabled | bool | `true` | Enable readinessProbe | -| readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | -| readinessProbe.periodSeconds | int | `10` | Period seconds for readinessProbe | -| readinessProbe.timeoutSeconds | int | `3` | Timeout seconds for readinessProbe | -| readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | -| readinessProbe.failureThreshold | int | `3` | Failure threshold for readinessProbe | -| networkpolicy | object | check `values.yaml` | Network policy defines who can access this application and who this applications has access to | -| clientId | string | `"radar_rest_sources_authorizer"` | OAuth2 client id of the application registered in Management Portal. It is assumed that this is a public client with empty client secret. | -| serverName | string | `"localhost"` | Domain name of the server | +| Key | Type | Default | Description | +|------------------------------------|------|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| replicaCount | int | `2` | Number of radar-rest-sources-authorizer replicas to deploy | +| image.repository | string | `"radarbase/radar-rest-source-authorizer"` | radar-rest-sources-authorizer image repository | +| image.tag | string | `"4.4.0"` | radar-rest-sources-authorizer image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. | +| image.pullPolicy | string | `"IfNotPresent"` | radar-rest-sources-authorizer image pull policy | +| imagePullSecrets | list | `[]` | Docker registry secret names as an array | +| nameOverride | string | `""` | String to partially override radar-rest-sources-authorizer.fullname template with a string (will prepend the release name) | +| fullnameOverride | string | `""` | String to fully override radar-rest-sources-authorizer.fullname template with a string | +| podSecurityContext | object | `{}` | Configure radar-rest-sources-authorizer pods' Security Context | +| securityContext | object | `{}` | Configure radar-rest-sources-authorizer containers' Security Context | +| service.type | string | `"ClusterIP"` | Kubernetes Service type | +| service.port | int | `8080` | radar-rest-sources-authorizer port | +| ingress.enabled | bool | `true` | Enable ingress controller resource | +| ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer | +| ingress.path | string | `"/rest-sources/authorizer"` | Path within the url structure | +| ingress.pathType | string | `"ImplementationSpecific"` | Ingress Path type | +| ingress.ingressClassName | string | `"nginx"` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | +| ingress.hosts | list | `["localhost"]` | Hosts to accept requests from | +| ingress.tls.secretName | string | `"radar-base-tls-radar-rest-sources-authorizer"` | TLS Secret Name | +| resources.requests | object | `{"cpu":"100m","memory":"128Mi"}` | CPU/Memory resource requests | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| tolerations | list | `[]` | Toleration labels for pod assignment | +| affinity | object | `{}` | Affinity labels for pod assignment | +| extraEnvVars | list | `[]` | Extra environment variables | +| customLivenessProbe | object | `{}` | Custom livenessProbe that overrides the default one | +| livenessProbe.enabled | bool | `true` | Enable livenessProbe | +| livenessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for livenessProbe | +| livenessProbe.periodSeconds | int | `30` | Period seconds for livenessProbe | +| livenessProbe.timeoutSeconds | int | `3` | Timeout seconds for livenessProbe | +| livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | +| livenessProbe.failureThreshold | int | `3` | Failure threshold for livenessProbe | +| customReadinessProbe | object | `{}` | Custom readinessProbe that overrides the default one | +| readinessProbe.enabled | bool | `true` | Enable readinessProbe | +| readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | +| readinessProbe.periodSeconds | int | `10` | Period seconds for readinessProbe | +| readinessProbe.timeoutSeconds | int | `3` | Timeout seconds for readinessProbe | +| readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | +| readinessProbe.failureThreshold | int | `3` | Failure threshold for readinessProbe | +| networkpolicy | object | check `values.yaml` | Network policy defines who can access this application and who this applications has access to | +| clientId | string | `"radar_rest_sources_authorizer"` | OAuth2 client id of the application registered in Management Portal. It is assumed that this is a public client with empty client secret. | +| serverName | string | `"localhost"` | Domain name of the server | +| authUrl | string | `"localhost/managementportal/oauth"` | Authorization URL of the IDP |