Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed streamer name in docs #141

Merged
merged 1 commit into from
Sep 22, 2024
Merged

Fixed streamer name in docs #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions charts/port-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,10 @@ If you had already added this repo earlier, run `helm repo update` to retrieve
the latest versions of the packages. You can then run `helm search repo
port-labs` to see the charts.

Then, install the chart.
For example, to use the `KafkaToWebhookStreamer` Streamer, use the following command:
Then, install the chart using the following command:

helm upgrade --install my-port-agent port-labs/port-agent \
--create-namespace --namespace port-agent \
--set env.normal.STREAMER_NAME=KafkaToWebhookStreamer \
--set env.normal.PORT_ORG_ID=YOUR_PORT_ORG_ID
--set env.normal.PORT_API_BASE_URL=https://api.getport.io \
--set env.normal.KAFKA_CONSUMER_GROUP_ID=YOUR_KAFKA_CONSUMER_GROUP_ID \
Expand Down Expand Up @@ -58,7 +56,7 @@ The following table lists the configuration parameters of the `port-agent` chart
| `secret.name` | Secret object name | `""` |
| `secret.useExistingSecret` | Enable this if you wish to create your own secret with credentials | `false` |
| `podServiceAccount.name` | Service account to attach to the pod. | `null` |
| `env.normal.STREAMER_NAME` | Streamer name, one of: [`KafkaToWebhookStreamer`] - **Required** | `"KafkaToWebhookStreamer"` |
| `env.normal.STREAMER_NAME` | Streamer name, available: [`KAFKA`] | `"KafkaToWebhookStreamer"` |
| `env.normal.PORT_ORG_ID` | Your Port org id - **Required** | `""` |
| `env.normal.PORT_API_BASE_URL` | Port API base url | `"https://api.getport.io"` |
| `env.normal.KAFKA_CONSUMER_GROUP_ID` | Kafka consumer group id - **Required if using any Kafka streamer** | `""` |
Expand Down
Loading