Skip to content

Commit

Permalink
Some more README improvements
Browse files Browse the repository at this point in the history 
Signed-off-by: Jakub Scholz <[email protected]>
  • Loading branch information
@scholzj
scholzj committed Dec 25, 2023
1 parent 8d8fe53 commit 1c9e735
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ Alternatively, you can also checkout the project and run it from your IDE or fro

Keksposé supports several parameters that can be used to configure it:

| Option | Short option | Description | Default Value |
|-----------------|:-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| --namespace | -n | Namespace of the Kafka cluster. This is also the namespace where the Keksposé proxy will be deployed. | The default namespace form your Kubernetes configuration will be used. |
| --cluster-name | -c | Name of the Kafka cluster. | `myproject` |
| --listener-name | -l | Name of the listener that should be exposed. If not set, Keksposé will try to find a suitable listener on its own. | |
| --starting-port | -p | The starting port number. This port number will be used for the bootstrap connection and will be used as the basis to calculate the per-broker ports. | `50000` |
| --kekspose-name | -k | Name that will be used for the Keksposé ConfigMap and Pod. | `kekspose` |
| Option | Description | Default Value |
|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `--namespace` / `-n` | Namespace of the Kafka cluster. This is also the namespace where the Keksposé proxy will be deployed. Defaults to the namespace form your Kubernetes configuration. | |
| `--cluster-name` / `-c` | Name of the Kafka cluster. | `myproject` |
| `--listener-name`/ `-l` | Name of the listener that should be exposed. If not set, Keksposé will try to find a suitable listener on its own. | |
| `--starting-port` / `-p` | The starting port number. This port number will be used for the bootstrap connection and will be used as the basis to calculate the per-broker ports. | `50000` |
| `--kekspose-name` / `-k` | Name that will be used for the Keksposé ConfigMap and Pod. | `kekspose` |

If you are using the Keksposé binary, you can just pass the options form the command line.
When using the Quarkus Dev mode, you can pass options using the `quakrus.args` system property - e.g. `mvn quarkus:dev -Dquarkus.args="--help"`.
Expand Down

0 comments on commit 1c9e735

Please sign in to comment.