From ec1bf7e55ef77e72d214b4d7bb42928e11111b35 Mon Sep 17 00:00:00 2001 From: talsabagport Date: Thu, 23 May 2024 15:18:19 +0300 Subject: [PATCH 1/4] Add support for ocean sendRawDataExamples --- charts/port-ocean/templates/configmap.yaml | 1 + charts/port-ocean/values.yaml | 2 ++ 2 files changed, 3 insertions(+) diff --git a/charts/port-ocean/templates/configmap.yaml b/charts/port-ocean/templates/configmap.yaml index b16404f..0b1189c 100644 --- a/charts/port-ocean/templates/configmap.yaml +++ b/charts/port-ocean/templates/configmap.yaml @@ -11,6 +11,7 @@ data: {{- if .Values.clientTimeout }} OCEAN__CLIENT_TIMEOUT: "{{ .Values.clientTimeout }}" {{- end }} + OCEAN__SEND_RAW_DATA_EXAMPLES: "{{ .Values.sendRawDataExamples | default true }}" OCEAN__EVENT_LISTENER: {{ .Values.integration.eventListener | toJson | quote }} {{- if .Values.integration.identifier }} OCEAN__INTEGRATION__IDENTIFIER: "{{ .Values.integration.identifier }}" diff --git a/charts/port-ocean/values.yaml b/charts/port-ocean/values.yaml index ec2a9b9..32b0e2b 100644 --- a/charts/port-ocean/values.yaml +++ b/charts/port-ocean/values.yaml @@ -55,6 +55,8 @@ scheduledResyncInterval: null clientTimeout: null +sendRawDataExamples: true + secret: name: "" useExistingSecret: false From 5f2276a456a75479d37fb128665d51e8edb29bb6 Mon Sep 17 00:00:00 2001 From: talsabagport Date: Thu, 23 May 2024 15:22:54 +0300 Subject: [PATCH 2/4] Add support for ocean sendRawDataExamples --- charts/port-ocean/README.md | 85 +++++++++++++++++++------------------ 1 file changed, 43 insertions(+), 42 deletions(-) diff --git a/charts/port-ocean/README.md b/charts/port-ocean/README.md index 8db3473..a7e8e1e 100644 --- a/charts/port-ocean/README.md +++ b/charts/port-ocean/README.md @@ -45,48 +45,49 @@ The command removes all the Kubernetes components associated with the chart and The following table lists the configuration parameters of the `port-ocean` chart and default values. -| Parameter | Description | Default | -|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| -| `nameOverride` | Chart name override. | `""` | -| `fullnameOverride` | Fully qualified app name override. | `""` | -| `port.clientId` | Client ID for Port API authentication (irrelevant if secret.useExistingSecret=true). | | -| `port.clientSecret` | Client secret for Port API authentication (irrelevant if secret.useExistingSecret=true). | | -| `port.baseUrl` | Base URL for the Port API. | `https://api.getport.io/v1` | -| `initializePortResources` | When set to true, creates a default JQ mapping and the relevant blueprints | `true` | -| `scheduledResyncInterval` | The number in minutes to reschedule and poll data from the 3rd party system | `null` | -| `podAnnotations` | Annotations to be added to the pod. | `{}` | -| `podSecurityContext` | Security context applied to the pod. | `{}` | -| `securityContext` | Security context applied to the container. | `{}` | -| `resources` | Container resource requests and limits. | `{}` | -| `nodeSelector` | NodeSelector applied to the pod. | `{}` | -| `tolerations` | Tolerations applied to the pod. | `[]` | -| `affinity` | Affinity applied to the pod. | `{}` | -| `imageRegistry` | Image registry override. | `""` | -| `imagePullSecrets` | Image pull secrets | `[]` | -| `secret.name` | Secret object name | `""` | -| `secret.useExistingSecret` | Enable this if you wish to create your own secret with credentials.
You must provide the following secrets:
`OCEAN__PORT__CLIENT_ID`
`OCEAN__PORT__CLIENT_SECRET`
Moreover, you need to provide sensitive configurations (required ones are **MUST**) for the selected integration:
Secret key format:`OCEAN__INTEGRATION__CONFIG__{{ $configName \| snakecase \| upper }}`
Example (if config name is `clusterConfMapping`): `OCEAN__INTEGRATION__CONFIG__CLUSTER_CONF_MAPPING` | `false` | -| `service.enabled` | Specifies whether the service is enabled or not. | `true` | -| `service.type` | Service type for the Port application. | `ClusterIP` | -| `service.port` | Port number for the service. | `8000` | -| `ingress.enabled` | Specifies whether the ingress is enabled or not. | `false` | -| `ingress.className` | Specifies the ingress ClassName. | `""` | -| `ingress.annotations` | Annotations for the ingress object. | `{}` | -| `ingress.host` | Hostname for the ingress. | `null` | -| `ingress.path` | Path for the ingress. | `/` | -| `ingress.pathType` | Path type for the ingress. | `Prefix` | -| `integration.identifier` | Identifier for the integration. | `""` | -| `integration.version` | Version of the integration. | `""` | -| `integration.type` | Type of the integration. i.e (`pager-duty`) | `""` | -| `integration.config` | Configuration for the integration. | `{}` | -| `integration.secrets` | Secrets for the integration (irrelevant if secret.useExistingSecret=true). | `{}` | -| `selfSignedCertificate` | Self Signed certificate for the integration | `{}` | -| `selfSignedCertificate.enabled` | Enable self-signed certificate trust for the integration. | `false` | -| `selfSignedCertificate.certificate` | The value of the self-signed certificate (only when `selfSignedCertificate.enabled=true`) | `""` | -| `selfSignedCertificate.secret` | Secret with self-signed certificate | `{}` | -| `selfSignedCertificate.secret.useExistingSecret` | Enable this if you wish to use your own secret with the self-signed certificate | `false` | -| `selfSignedCertificate.secret.key` | The key in the existing self-signed certificate secret | `crt` | -| `selfSignedCertificate.secret.name` | The name of an existing secret containing the self-signed certificate | `""` | -| `eventListener.type` | Type of the event listener for the integration, one of the following "WEBHOOK" / "KAFKA" / "SAMPLE" | `"KAFKA"` | +| Parameter | Description | Default | +|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| `nameOverride` | Chart name override. | `""` | +| `fullnameOverride` | Fully qualified app name override. | `""` | +| `port.clientId` | Client ID for Port API authentication (irrelevant if secret.useExistingSecret=true). | | +| `port.clientSecret` | Client secret for Port API authentication (irrelevant if secret.useExistingSecret=true). | | +| `port.baseUrl` | Base URL for the Port API. | `https://api.getport.io/v1` | +| `initializePortResources` | When set to true, creates a default JQ mapping and the relevant blueprints | `true` | +| `scheduledResyncInterval` | The number in minutes to reschedule and poll data from the 3rd party system | `null` | +| `sendRawDataExamples` | Enable sending of raw data examples to port for test a mapping | `null` | +| `podAnnotations` | Annotations to be added to the pod. | `{}` | +| `podSecurityContext` | Security context applied to the pod. | `{}` | +| `securityContext` | Security context applied to the container. | `{}` | +| `resources` | Container resource requests and limits. | `{}` | +| `nodeSelector` | NodeSelector applied to the pod. | `{}` | +| `tolerations` | Tolerations applied to the pod. | `[]` | +| `affinity` | Affinity applied to the pod. | `{}` | +| `imageRegistry` | Image registry override. | `""` | +| `imagePullSecrets` | Image pull secrets | `[]` | +| `secret.name` | Secret object name | `""` | +| `secret.useExistingSecret` | Enable this if you wish to create your own secret with credentials.
You must provide the following secrets:
`OCEAN__PORT__CLIENT_ID`
`OCEAN__PORT__CLIENT_SECRET`
Moreover, you need to provide sensitive configurations (required ones are **MUST**) for the selected integration:
Secret key format:`OCEAN__INTEGRATION__CONFIG__{{ $configName \| snakecase \| upper }}`
Example (if config name is `clusterConfMapping`): `OCEAN__INTEGRATION__CONFIG__CLUSTER_CONF_MAPPING` | `false` | +| `service.enabled` | Specifies whether the service is enabled or not. | `true` | +| `service.type` | Service type for the Port application. | `ClusterIP` | +| `service.port` | Port number for the service. | `8000` | +| `ingress.enabled` | Specifies whether the ingress is enabled or not. | `false` | +| `ingress.className` | Specifies the ingress ClassName. | `""` | +| `ingress.annotations` | Annotations for the ingress object. | `{}` | +| `ingress.host` | Hostname for the ingress. | `null` | +| `ingress.path` | Path for the ingress. | `/` | +| `ingress.pathType` | Path type for the ingress. | `Prefix` | +| `integration.identifier` | Identifier for the integration. | `""` | +| `integration.version` | Version of the integration. | `""` | +| `integration.type` | Type of the integration. i.e (`pager-duty`) | `""` | +| `integration.config` | Configuration for the integration. | `{}` | +| `integration.secrets` | Secrets for the integration (irrelevant if secret.useExistingSecret=true). | `{}` | +| `selfSignedCertificate` | Self Signed certificate for the integration | `{}` | +| `selfSignedCertificate.enabled` | Enable self-signed certificate trust for the integration. | `false` | +| `selfSignedCertificate.certificate` | The value of the self-signed certificate (only when `selfSignedCertificate.enabled=true`) | `""` | +| `selfSignedCertificate.secret` | Secret with self-signed certificate | `{}` | +| `selfSignedCertificate.secret.useExistingSecret` | Enable this if you wish to use your own secret with the self-signed certificate | `false` | +| `selfSignedCertificate.secret.key` | The key in the existing self-signed certificate secret | `crt` | +| `selfSignedCertificate.secret.name` | The name of an existing secret containing the self-signed certificate | `""` | +| `eventListener.type` | Type of the event listener for the integration, one of the following "WEBHOOK" / "KAFKA" / "SAMPLE" | `"KAFKA"` | To override values in `helm install`, use either the `--set` flag. From 334f70695092bde04d2d0b2bebd923ff7fdd84b0 Mon Sep 17 00:00:00 2001 From: talsabagport Date: Sun, 26 May 2024 11:08:06 +0300 Subject: [PATCH 3/4] bump helm version --- charts/port-ocean/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/port-ocean/Chart.yaml b/charts/port-ocean/Chart.yaml index 334e190..ff119a4 100644 --- a/charts/port-ocean/Chart.yaml +++ b/charts/port-ocean/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: port-ocean description: A Helm chart for Port Ocean integrations type: application -version: 0.1.22 +version: 0.1.23 appVersion: "0.1.0" home: https://getport.io/ sources: From 1d8eba18086ad079b0cee066498c30fd0d69ea9e Mon Sep 17 00:00:00 2001 From: talsabagport Date: Sun, 26 May 2024 11:21:36 +0300 Subject: [PATCH 4/4] Update charts/port-ocean/README.md Co-authored-by: Tom Tankilevitch <59158507+Tankilevitch@users.noreply.github.com> --- charts/port-ocean/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/port-ocean/README.md b/charts/port-ocean/README.md index a7e8e1e..c2aff2f 100644 --- a/charts/port-ocean/README.md +++ b/charts/port-ocean/README.md @@ -54,7 +54,7 @@ The following table lists the configuration parameters of the `port-ocean` chart | `port.baseUrl` | Base URL for the Port API. | `https://api.getport.io/v1` | | `initializePortResources` | When set to true, creates a default JQ mapping and the relevant blueprints | `true` | | `scheduledResyncInterval` | The number in minutes to reschedule and poll data from the 3rd party system | `null` | -| `sendRawDataExamples` | Enable sending of raw data examples to port for test a mapping | `null` | +| `sendRawDataExamples` | Enable sending raw data examples from the third party API to port for testing and managing the integration mapping | `null` | | `podAnnotations` | Annotations to be added to the pod. | `{}` | | `podSecurityContext` | Security context applied to the pod. | `{}` | | `securityContext` | Security context applied to the container. | `{}` |