Skip to content

Commit ded32c6

Browse files
Amichai-Skaliter-PortAmichai-Skaliter-Port
committed
Refactor Port Agent Configuration Documentation:
1 parent 85db2f4 commit ded32c6

File tree

1 file changed

+4
-48
lines changed
  • docs/actions-and-automations/setup-backend/webhook/port-execution-agent

1 file changed

+4
-48
lines changed

‎docs/actions-and-automations/setup-backend/webhook/port-execution-agent/usage.md‎

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -32,48 +32,9 @@ When a new invocation is detected, the agent will pull it from your Kafka topic
3232

3333
## Configuration
3434

35-
The following table lists the configuration parameters of the `port-agent` chart and default values.
36-
37-
| Parameter | Description | Default |
38-
|------------------------------------------------------|--------------------------------------------------------------------------------------------|--------------------------------------------|
39-
| `image.repository` | Image repository | `ghcr.io/port-labs/port-agent` |
40-
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
41-
| `image.tag` | Image tag | `""` |
42-
| `replicaCount` | Number of port-agent replicas | `1` |
43-
| `imagePullSecrets` | Image pull secrets | `[]` |
44-
| `extraLabels` | Additional labels to be added to all resources | `{}` |
45-
| `nameOverride` | Chart name override | `""` |
46-
| `fullnameOverride` | Fully qualified app name override | `""` |
47-
| `secret.annotations` | Annotations for Secret object | `{}` |
48-
| `secret.name` | Secret object name | `""` |
49-
| `secret.useExistingSecret` | Enable this if you wish to create your own secret with credentials | `false` |
50-
| `podServiceAccount.name` | Service account to attach to the pod | `null` |
51-
| `env.normal.STREAMER_NAME` | Streamer name, available: [`KAFKA`] | `"KAFKA"` |
52-
| `env.normal.GITLAB_URL` | GitLab base URL | `"https://gitlab.com/"` |
53-
| `env.normal.PORT_ORG_ID` | Your Port org id - **Required** | `""` |
54-
| `env.normal.PORT_API_BASE_URL` | Port API base url | `"https://api.getport.io"` |
55-
| `env.normal.KAFKA_CONSUMER_GROUP_ID` | Kafka consumer group id - **Required if using any Kafka streamer** | `""` |
56-
| `env.normal.KAFKA_CONSUMER_SECURITY_PROTOCOL` | Kafka consumer security protocol | `"SASL_SSL"` |
57-
| `env.normal.KAFKA_CONSUMER_AUTHENTICATION_MECHANISM` | Kafka consumer authentication mechanism | `"SCRAM-SHA-512"` |
58-
| `env.normal.KAFKA_CONSUMER_AUTO_OFFSET_RESET` | Kafka consumer auto offset reset | `"largest"` |
59-
| `env.secret.PORT_CLIENT_ID` | Port API client id | `""` |
60-
| `env.secret.PORT_CLIENT_SECRET` | Port API client secret | `""` |
61-
| `controlThePayloadConfig` | Override the default control the payload configuration file with custom json configuration | `""` |
62-
| `podAnnotations` | Annotations to be added to the pod | `{}` |
63-
| `podSecurityContext` | Security context applied to the pod | `{}` |
64-
| `containerSecurityContext` | Security context applied to the container | `{}` |
65-
| `extraVolumes` | Additional volumes to be added to the pod | `[]` |
66-
| `extraVolumeMounts` | Additional volume mounts to be added to the container | `[]` |
67-
| `rolloutStrategy` | Deployment rollout strategy (Recreate or RollingUpdate) | `"Recreate"` |
68-
| `resources` | Container resource requests & limits | `{"requests": {"memory": "128Mi", "cpu": "100m"}, "limits": {"memory": "256Mi", "cpu": "200m"}}` |
69-
| `nodeSelector` | NodeSelector applied to the pod | `{}` |
70-
| `tolerations` | Tolerations applied to the pod | `[]` |
71-
| `affinity` | Affinity applied to the pod | `{}` |
72-
| `selfSignedCertificate.enabled` | Enable self-signed certificate trust for the agent | `false` |
73-
| `selfSignedCertificate.certificate` | The value of the self-signed certificate | `""` |
74-
| `selfSignedCertificate.secret.useExistingSecret` | Enable this if you wish to use your own secret with the self-signed certificate | `false` |
75-
| `selfSignedCertificate.secret.key` | The key in the existing self-signed certificate secret | `crt` |
76-
| `selfSignedCertificate.secret.name` | The name of an existing secret containing the self-signed certificate | `""` |
35+
:::info Advanced configuration
36+
For a complete list of all available configuration parameters and their descriptions, see the [Port Agent Helm chart README](https://github.com/port-labs/helm-charts/tree/main/charts/port-agent).
37+
:::
7738

7839
:::note
7940
Ensure your Kafka topic has enough partitions when increasing `replicaCount` beyond 1. Each replica acts as a consumer in the consumer group.
@@ -85,7 +46,7 @@ For self-hosted 3rd-party applications with self-signed certificates, the agent
8546

8647
### Option 1: Provide certificate in Helm values
8748

88-
Use this option to provide the certificate content directly in your Helm values file or via the `--set-file` flag. The Helm chart will create and manage a Kubernetes secret containing the certificate.
49+
Use this option to provide the certificate content directly in your Helm values file or via the `--set-file` flag.
8950

9051
**How to use:**
9152
1. Set `selfSignedCertificate.enabled` to `true`
@@ -212,11 +173,6 @@ helm upgrade --install my-port-agent port-labs/port-agent \
212173
--set resources.limits.memory="512Mi"
213174
```
214175

215-
## All configuration parameters
216-
217-
- A complete list of configuration parameters is available in the [Port Agent Helm chart repository](https://github.com/port-labs/helm-charts/tree/main/charts/port-agent);
218-
- An example `values.yaml` file with all available parameters is available [here](https://github.com/port-labs/helm-charts/blob/main/charts/port-agent/values.yaml).
219-
220176
## Extra environment variables
221177

222178
To pass extra environment variables to the agent's runtime, you can use the `env.normal` section for non-sensitive variables.

0 commit comments

Comments
 (0)