Skip to content

Commit 9219873

Browse files
authored
Fix print command instructions in README (#218)
* v0.3.0 made the `--providers` print command required, however the README wasn't updated * Updates the example print command to use --providers=ingress-nginx since at least one provider *must* be specified * Removes the default option of providers in the table in the README since it no longer exists.
1 parent 936b78e commit 9219873

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,17 @@ brew install ingress2gateway
7777

7878
Ingress2gateway reads Ingress resources and/or provider-specifc CRDs from a Kubernetes
7979
cluster or a file. It will output the equivalent Gateway API resources in a YAML/JSON
80-
format to stdout. To run ingress2gateway with default options simply run:
80+
format to stdout. The simplest case is to convert all ingresses from one provider (in this example we use ingress-nginx):
8181

8282
```shell
83-
./ingress2gateway print
83+
./ingress2gateway print --providers=ingress-nginx
8484
```
8585

8686
The above command will:
8787

8888
1. Read your Kube config file to extract the cluster credentials and the current
8989
active namespace.
90-
1. Search for ingresses and provider-specific resources in that namespace.
90+
1. Search for ingress-nginx resources in that namespace.
9191
1. Convert them to Gateway-API resources (Currently only Gateways and HTTPRoutes).
9292

9393
## Options
@@ -103,7 +103,7 @@ The above command will:
103103
| openapi3-gateway-class-name | | No | Provider-specific: openapi3. The name of the gateway class to use in the Gateways. |
104104
| openapi3-gateway-tls-secret | | No | Provider-specific: openapi3. The name of the secret for the TLS certificate references in the Gateways. |
105105
| output | yaml | No | The output format, either yaml or json. |
106-
| providers | all supported providers | Yes | Comma-separated list of providers. |
106+
| providers | | Yes | Comma-separated list of providers. |
107107
| kubeconfig | | No | The kubeconfig file to use when talking to the cluster. If the flag is not set, a set of standard locations can be searched for an existing kubeconfig file. |
108108

109109
## Conversion of Ingress resources to Gateway API

0 commit comments

Comments
 (0)