From f84e00e481196824c2fd5b1d75101fa24504dcea Mon Sep 17 00:00:00 2001 From: Jesper Noordsij <45041769+jnoordsij@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:24:04 +0200 Subject: [PATCH] Consistent entryPoints capitalization in CLI flag usage --- docs/content/getting-started/faq.md | 2 +- docs/content/https/acme.md | 8 +-- docs/content/migration/v1-to-v2.md | 16 +++--- .../kubernetes-gateway-traefik-lb-svc.yml | 4 +- docs/content/routing/entrypoints.md | 54 +++++++++---------- .../routing/providers/kubernetes-crd.md | 6 +-- .../routing/providers/kubernetes-ingress.md | 12 ++--- docs/content/routing/routers/index.md | 36 ++++++------- .../user-guides/crd-acme/03-deployments.yml | 4 +- .../acme-dns/docker-compose.yml | 4 +- .../acme-dns/docker-compose_secrets.yml | 4 +- .../docker-compose/acme-dns/index.md | 2 +- .../acme-http/docker-compose.yml | 4 +- .../docker-compose/acme-http/index.md | 2 +- .../acme-tls/docker-compose.yml | 2 +- .../docker-compose/acme-tls/index.md | 2 +- .../basic-example/docker-compose.yml | 2 +- .../docker-compose/basic-example/index.md | 2 +- 18 files changed, 83 insertions(+), 83 deletions(-) diff --git a/docs/content/getting-started/faq.md b/docs/content/getting-started/faq.md index 761e8d3a7..facdd71bf 100644 --- a/docs/content/getting-started/faq.md +++ b/docs/content/getting-started/faq.md @@ -93,7 +93,7 @@ The example below is a file provider only version (`yaml`) of what this configur ```yaml tab="Static configuration" # traefik.yml -entrypoints: +entryPoints: web: address: :80 diff --git a/docs/content/https/acme.md b/docs/content/https/acme.md index 99e64c76d..b012263ac 100644 --- a/docs/content/https/acme.md +++ b/docs/content/https/acme.md @@ -116,8 +116,8 @@ Please check the [configuration examples below](#configuration-examples) for mor ``` ```bash tab="CLI" - --entrypoints.web.address=:80 - --entrypoints.websecure.address=:443 + --entryPoints.web.address=:80 + --entryPoints.websecure.address=:443 # ... --certificatesresolvers.myresolver.acme.email=your-email@example.com --certificatesresolvers.myresolver.acme.storage=acme.json @@ -241,8 +241,8 @@ when using the `HTTP-01` challenge, `certificatesresolvers.myresolver.acme.httpc ``` ```bash tab="CLI" - --entrypoints.web.address=:80 - --entrypoints.websecure.address=:443 + --entryPoints.web.address=:80 + --entryPoints.websecure.address=:443 # ... --certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web ``` diff --git a/docs/content/migration/v1-to-v2.md b/docs/content/migration/v1-to-v2.md index 849f42b4c..8992fff87 100644 --- a/docs/content/migration/v1-to-v2.md +++ b/docs/content/migration/v1-to-v2.md @@ -354,7 +354,7 @@ To apply a redirection: ``` ```bash tab="CLI" - --entrypoints=Name:web Address::80 Redirect.EntryPoint:websecure + --entryPoints=Name:web Address::80 Redirect.EntryPoint:websecure --entryPoints='Name:websecure Address::443 TLS' ``` @@ -394,10 +394,10 @@ To apply a redirection: ```bash tab="CLI" ## static configuration - --entrypoints.web.address=:80 - --entrypoints.web.http.redirections.entrypoint.to=websecure - --entrypoints.web.http.redirections.entrypoint.scheme=https - --entrypoints.websecure.address=:443 + --entryPoints.web.address=:80 + --entryPoints.web.http.redirections.entrypoint.to=websecure + --entryPoints.web.http.redirections.entrypoint.scheme=https + --entryPoints.websecure.address=:443 --providers.docker=true ``` @@ -750,8 +750,8 @@ with the path `/admin` stripped, e.g. to `http://:/`. In this case, yo ``` ```bash tab="CLI" - --entrypoints.web.address=:80 - --entrypoints.websecure.address=:443 + --entryPoints.web.address=:80 + --entryPoints.websecure.address=:443 --certificatesresolvers.myresolver.acme.email=your-email@example.com --certificatesresolvers.myresolver.acme.storage=acme.json --certificatesresolvers.myresolver.acme.tlschallenge=true @@ -1078,7 +1078,7 @@ To activate the dashboard, you can either: routers: api: rule: Host(`traefik.docker.localhost`) - entrypoints: + entryPoints: - websecure service: api@internal middlewares: diff --git a/docs/content/reference/dynamic-configuration/kubernetes-gateway-traefik-lb-svc.yml b/docs/content/reference/dynamic-configuration/kubernetes-gateway-traefik-lb-svc.yml index be0c7e225..c6f81d756 100644 --- a/docs/content/reference/dynamic-configuration/kubernetes-gateway-traefik-lb-svc.yml +++ b/docs/content/reference/dynamic-configuration/kubernetes-gateway-traefik-lb-svc.yml @@ -27,8 +27,8 @@ spec: - name: traefik image: traefik:v2.11 args: - - --entrypoints.web.address=:80 - - --entrypoints.websecure.address=:443 + - --entryPoints.web.address=:80 + - --entryPoints.websecure.address=:443 - --experimental.kubernetesgateway - --providers.kubernetesgateway diff --git a/docs/content/routing/entrypoints.md b/docs/content/routing/entrypoints.md index a162f1839..70f1f4e0d 100644 --- a/docs/content/routing/entrypoints.md +++ b/docs/content/routing/entrypoints.md @@ -227,8 +227,8 @@ If both TCP and UDP are wanted for the same port, two entryPoints definitions ar ``` ```bash tab="CLI" - --entrypoints.specificIPv4.address=192.168.2.7:8888 - --entrypoints.specificIPv6.address=[2001:db8::1]:8888 + --entryPoints.specificIPv4.address=192.168.2.7:8888 + --entryPoints.specificIPv6.address=[2001:db8::1]:8888 ``` Full details for how to specify `address` can be found in [net.Listen](https://golang.org/pkg/net/#Listen) (and [net.Dial](https://golang.org/pkg/net/#Dial)) of the doc for go. @@ -295,7 +295,7 @@ In most scenarios, this entryPoint is the same as the one used for TLS traffic. ```bash tab="CLI" --experimental.http3=true - --entrypoints.name.http3 + --entryPoints.name.http3 ``` #### `advertisedPort` @@ -326,7 +326,7 @@ It can be used to override the authority in the `alt-svc` header, for example if ```bash tab="CLI" --experimental.http3=true - --entrypoints.name.http3.advertisedport=443 + --entryPoints.name.http3.advertisedport=443 ``` ### Forwarded Headers @@ -763,10 +763,10 @@ This whole section is dedicated to options, keyed by entry point, that will appl ``` ```bash tab="CLI" - --entrypoints.web.address=:80 - --entrypoints.web.http.redirections.entryPoint.to=websecure - --entrypoints.web.http.redirections.entryPoint.scheme=https - --entrypoints.websecure.address=:443 + --entryPoints.web.address=:80 + --entryPoints.web.http.redirections.entryPoint.to=websecure + --entryPoints.web.http.redirections.entryPoint.scheme=https + --entryPoints.websecure.address=:443 ``` #### `entryPoint` @@ -801,7 +801,7 @@ This section is a convenience to enable (permanent) redirecting of all incoming ``` ```bash tab="CLI" - --entrypoints.foo.http.redirections.entryPoint.to=websecure + --entryPoints.foo.http.redirections.entryPoint.to=websecure ``` ??? info "`entryPoint.scheme`" @@ -831,7 +831,7 @@ This section is a convenience to enable (permanent) redirecting of all incoming ``` ```bash tab="CLI" - --entrypoints.foo.http.redirections.entryPoint.scheme=https + --entryPoints.foo.http.redirections.entryPoint.scheme=https ``` ??? info "`entryPoint.permanent`" @@ -861,7 +861,7 @@ This section is a convenience to enable (permanent) redirecting of all incoming ``` ```bash tab="CLI" - --entrypoints.foo.http.redirections.entrypoint.permanent=true + --entryPoints.foo.http.redirections.entrypoint.permanent=true ``` ??? info "`entryPoint.priority`" @@ -891,7 +891,7 @@ This section is a convenience to enable (permanent) redirecting of all incoming ``` ```bash tab="CLI" - --entrypoints.foo.http.redirections.entrypoint.priority=10 + --entryPoints.foo.http.redirections.entrypoint.priority=10 ``` ### EncodeQuerySemicolons @@ -919,8 +919,8 @@ entryPoints: ``` ```bash tab="CLI" ---entrypoints.websecure.address=:443 ---entrypoints.websecure.http.encodequerysemicolons=true +--entryPoints.websecure.address=:443 +--entryPoints.websecure.http.encodequerysemicolons=true ``` #### Examples @@ -955,8 +955,8 @@ entryPoints: ``` ```bash tab="CLI" ---entrypoints.websecure.address=:443 ---entrypoints.websecure.http.middlewares=auth@file,strip@file +--entryPoints.websecure.address=:443 +--entryPoints.websecure.http.middlewares=auth@file,strip@file ``` ### TLS @@ -1002,13 +1002,13 @@ entryPoints: ``` ```bash tab="CLI" ---entrypoints.websecure.address=:443 ---entrypoints.websecure.http.tls.options=foobar ---entrypoints.websecure.http.tls.certResolver=leresolver ---entrypoints.websecure.http.tls.domains[0].main=example.com ---entrypoints.websecure.http.tls.domains[0].sans=foo.example.com,bar.example.com ---entrypoints.websecure.http.tls.domains[1].main=test.com ---entrypoints.websecure.http.tls.domains[1].sans=foo.test.com,bar.test.com +--entryPoints.websecure.address=:443 +--entryPoints.websecure.http.tls.options=foobar +--entryPoints.websecure.http.tls.certResolver=leresolver +--entryPoints.websecure.http.tls.domains[0].main=example.com +--entryPoints.websecure.http.tls.domains[0].sans=foo.example.com,bar.example.com +--entryPoints.websecure.http.tls.domains[1].main=test.com +--entryPoints.websecure.http.tls.domains[1].sans=foo.test.com,bar.test.com ``` ??? example "Let's Encrypt" @@ -1031,8 +1031,8 @@ entryPoints: ``` ```bash tab="CLI" - --entrypoints.websecure.address=:443 - --entrypoints.websecure.http.tls.certResolver=leresolver + --entryPoints.websecure.address=:443 + --entryPoints.websecure.http.tls.certResolver=leresolver ``` ## UDP Options @@ -1063,8 +1063,8 @@ entryPoints: ``` ```bash tab="CLI" -entrypoints.foo.address=:8000/udp -entrypoints.foo.udp.timeout=10s +--entryPoints.foo.address=:8000/udp +--entryPoints.foo.udp.timeout=10s ``` {!traefik-for-business-applications.md!} diff --git a/docs/content/routing/providers/kubernetes-crd.md b/docs/content/routing/providers/kubernetes-crd.md index 17cb204db..9d1f5f721 100644 --- a/docs/content/routing/providers/kubernetes-crd.md +++ b/docs/content/routing/providers/kubernetes-crd.md @@ -53,9 +53,9 @@ The Kubernetes Ingress Controller, The Custom Resource Way. - --log.level=DEBUG - --api - --api.insecure - - --entrypoints.web.address=:80 - - --entrypoints.tcpep.address=:8000 - - --entrypoints.udpep.address=:9000/udp + - --entryPoints.web.address=:80 + - --entryPoints.tcpep.address=:8000 + - --entryPoints.udpep.address=:9000/udp - --providers.kubernetescrd ports: - name: web diff --git a/docs/content/routing/providers/kubernetes-ingress.md b/docs/content/routing/providers/kubernetes-ingress.md index 65730bc91..5b86c70a1 100644 --- a/docs/content/routing/providers/kubernetes-ingress.md +++ b/docs/content/routing/providers/kubernetes-ingress.md @@ -149,7 +149,7 @@ which in turn will create the resulting routers, services, handlers, etc. - name: traefik image: traefik:v2.11 args: - - --entrypoints.web.address=:80 + - --entryPoints.web.address=:80 - --providers.kubernetesingress ports: - name: web @@ -396,8 +396,8 @@ TLS can be enabled through the [HTTP options](../entrypoints.md#tls) of an Entry ```bash tab="CLI" # Static configuration ---entrypoints.websecure.address=:443 ---entrypoints.websecure.http.tls +--entryPoints.websecure.address=:443 +--entryPoints.websecure.http.tls ``` ```yaml tab="File (YAML)" @@ -552,8 +552,8 @@ This way, any Ingress attached to this Entrypoint will have TLS termination by d - name: traefik image: traefik:v2.11 args: - - --entrypoints.websecure.address=:443 - - --entrypoints.websecure.http.tls + - --entryPoints.websecure.address=:443 + - --entryPoints.websecure.http.tls - --providers.kubernetesingress ports: - name: websecure @@ -762,7 +762,7 @@ For more options, please refer to the available [annotations](#on-ingress). - name: traefik image: traefik:v2.11 args: - - --entrypoints.websecure.address=:443 + - --entryPoints.websecure.address=:443 - --providers.kubernetesingress ports: - name: websecure diff --git a/docs/content/routing/routers/index.md b/docs/content/routing/routers/index.md index 418f77201..e7714af38 100644 --- a/docs/content/routing/routers/index.md +++ b/docs/content/routing/routers/index.md @@ -146,9 +146,9 @@ If you want to limit the router scope to a set of entry points, set the `entryPo ```bash tab="CLI" ## Static configuration - --entrypoints.web.address=:80 - --entrypoints.websecure.address=:443 - --entrypoints.other.address=:9090 + --entryPoints.web.address=:80 + --entryPoints.websecure.address=:443 + --entryPoints.other.address=:9090 ``` ??? example "Listens to Specific EntryPoints" @@ -204,9 +204,9 @@ If you want to limit the router scope to a set of entry points, set the `entryPo ```bash tab="CLI" ## Static configuration - --entrypoints.web.address=:80 - --entrypoints.websecure.address=:443 - --entrypoints.other.address=:9090 + --entryPoints.web.address=:80 + --entryPoints.websecure.address=:443 + --entryPoints.other.address=:9090 ``` ### Rule @@ -756,9 +756,9 @@ If you want to limit the router scope to a set of entry points, set the entry po ```bash tab="CLI" ## Static configuration - --entrypoints.web.address=:80 - --entrypoints.websecure.address=:443 - --entrypoints.other.address=:9090 + --entryPoints.web.address=:80 + --entryPoints.websecure.address=:443 + --entryPoints.other.address=:9090 ``` ??? example "Listens to Specific Entry Points" @@ -820,9 +820,9 @@ If you want to limit the router scope to a set of entry points, set the entry po ```bash tab="CLI" ## Static configuration - --entrypoints.web.address=:80 - --entrypoints.websecure.address=:443 - --entrypoints.other.address=:9090 + --entryPoints.web.address=:80 + --entryPoints.websecure.address=:443 + --entryPoints.other.address=:9090 ``` ### Rule @@ -1280,9 +1280,9 @@ If one wants to limit the router scope to a set of entry points, one should set ```bash tab="CLI" ## Static configuration - --entrypoints.web.address=":80" - --entrypoints.other.address=":9090/udp" - --entrypoints.streaming.address=":9191/udp" + --entryPoints.web.address=":80" + --entryPoints.other.address=":9090/udp" + --entryPoints.streaming.address=":9191/udp" ``` ??? example "Listens to Specific Entry Points" @@ -1337,9 +1337,9 @@ If one wants to limit the router scope to a set of entry points, one should set ```bash tab="CLI" ## Static configuration - --entrypoints.web.address=":80" - --entrypoints.other.address=":9090/udp" - --entrypoints.streaming.address=":9191/udp" + --entryPoints.web.address=":80" + --entryPoints.other.address=":9090/udp" + --entryPoints.streaming.address=":9191/udp" ``` ### Services diff --git a/docs/content/user-guides/crd-acme/03-deployments.yml b/docs/content/user-guides/crd-acme/03-deployments.yml index 55cff5009..5375b47ef 100644 --- a/docs/content/user-guides/crd-acme/03-deployments.yml +++ b/docs/content/user-guides/crd-acme/03-deployments.yml @@ -30,8 +30,8 @@ spec: args: - --api.insecure - --accesslog - - --entrypoints.web.Address=:8000 - - --entrypoints.websecure.Address=:4443 + - --entryPoints.web.Address=:8000 + - --entryPoints.websecure.Address=:4443 - --providers.kubernetescrd - --certificatesresolvers.myresolver.acme.tlschallenge - --certificatesresolvers.myresolver.acme.email=foo@you.com diff --git a/docs/content/user-guides/docker-compose/acme-dns/docker-compose.yml b/docs/content/user-guides/docker-compose/acme-dns/docker-compose.yml index 13beb1e9e..c3740baa3 100644 --- a/docs/content/user-guides/docker-compose/acme-dns/docker-compose.yml +++ b/docs/content/user-guides/docker-compose/acme-dns/docker-compose.yml @@ -10,8 +10,8 @@ services: - "--api.insecure=true" - "--providers.docker=true" - "--providers.docker.exposedbydefault=false" - - "--entrypoints.web.address=:80" - - "--entrypoints.websecure.address=:443" + - "--entryPoints.web.address=:80" + - "--entryPoints.websecure.address=:443" - "--certificatesresolvers.myresolver.acme.dnschallenge=true" - "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh" #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory" diff --git a/docs/content/user-guides/docker-compose/acme-dns/docker-compose_secrets.yml b/docs/content/user-guides/docker-compose/acme-dns/docker-compose_secrets.yml index c98f67b67..6b221f46a 100644 --- a/docs/content/user-guides/docker-compose/acme-dns/docker-compose_secrets.yml +++ b/docs/content/user-guides/docker-compose/acme-dns/docker-compose_secrets.yml @@ -20,8 +20,8 @@ services: - "--api.insecure=true" - "--providers.docker=true" - "--providers.docker.exposedbydefault=false" - - "--entrypoints.web.address=:80" - - "--entrypoints.websecure.address=:443" + - "--entryPoints.web.address=:80" + - "--entryPoints.websecure.address=:443" - "--certificatesresolvers.myresolver.acme.dnschallenge=true" - "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh" #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory" diff --git a/docs/content/user-guides/docker-compose/acme-dns/index.md b/docs/content/user-guides/docker-compose/acme-dns/index.md index 84fc9c8dc..d312b79d9 100644 --- a/docs/content/user-guides/docker-compose/acme-dns/index.md +++ b/docs/content/user-guides/docker-compose/acme-dns/index.md @@ -64,7 +64,7 @@ What changed between the initial setup: ```yaml command: # Traefik will listen to incoming request on the port 443 (https) - - "--entrypoints.websecure.address=:443" + - "--entryPoints.websecure.address=:443" ports: - "443:443" ``` diff --git a/docs/content/user-guides/docker-compose/acme-http/docker-compose.yml b/docs/content/user-guides/docker-compose/acme-http/docker-compose.yml index d4db80f53..d05ec09f8 100644 --- a/docs/content/user-guides/docker-compose/acme-http/docker-compose.yml +++ b/docs/content/user-guides/docker-compose/acme-http/docker-compose.yml @@ -10,8 +10,8 @@ services: - "--api.insecure=true" - "--providers.docker=true" - "--providers.docker.exposedbydefault=false" - - "--entrypoints.web.address=:80" - - "--entrypoints.websecure.address=:443" + - "--entryPoints.web.address=:80" + - "--entryPoints.websecure.address=:443" - "--certificatesresolvers.myresolver.acme.httpchallenge=true" - "--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web" #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory" diff --git a/docs/content/user-guides/docker-compose/acme-http/index.md b/docs/content/user-guides/docker-compose/acme-http/index.md index 67808853e..f6d5e0fc2 100644 --- a/docs/content/user-guides/docker-compose/acme-http/index.md +++ b/docs/content/user-guides/docker-compose/acme-http/index.md @@ -50,7 +50,7 @@ What changed between the basic example: ```yaml command: # Traefik will listen to incoming request on the port 443 (https) - - "--entrypoints.websecure.address=:443" + - "--entryPoints.websecure.address=:443" ports: - "443:443" ``` diff --git a/docs/content/user-guides/docker-compose/acme-tls/docker-compose.yml b/docs/content/user-guides/docker-compose/acme-tls/docker-compose.yml index 7e9bec323..d4a095985 100644 --- a/docs/content/user-guides/docker-compose/acme-tls/docker-compose.yml +++ b/docs/content/user-guides/docker-compose/acme-tls/docker-compose.yml @@ -10,7 +10,7 @@ services: - "--api.insecure=true" - "--providers.docker=true" - "--providers.docker.exposedbydefault=false" - - "--entrypoints.websecure.address=:443" + - "--entryPoints.websecure.address=:443" - "--certificatesresolvers.myresolver.acme.tlschallenge=true" #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory" - "--certificatesresolvers.myresolver.acme.email=postmaster@example.com" diff --git a/docs/content/user-guides/docker-compose/acme-tls/index.md b/docs/content/user-guides/docker-compose/acme-tls/index.md index b201a4c95..9e6e6ac4a 100644 --- a/docs/content/user-guides/docker-compose/acme-tls/index.md +++ b/docs/content/user-guides/docker-compose/acme-tls/index.md @@ -50,7 +50,7 @@ What changed between the basic example: ```yaml command: # Traefik will listen to incoming request on the port 443 (https) - - "--entrypoints.websecure.address=:443" + - "--entryPoints.websecure.address=:443" ports: - "443:443" ``` diff --git a/docs/content/user-guides/docker-compose/basic-example/docker-compose.yml b/docs/content/user-guides/docker-compose/basic-example/docker-compose.yml index c040750cd..1ecffae92 100644 --- a/docs/content/user-guides/docker-compose/basic-example/docker-compose.yml +++ b/docs/content/user-guides/docker-compose/basic-example/docker-compose.yml @@ -10,7 +10,7 @@ services: - "--api.insecure=true" - "--providers.docker=true" - "--providers.docker.exposedbydefault=false" - - "--entrypoints.web.address=:80" + - "--entryPoints.web.address=:80" ports: - "80:80" - "8080:8080" diff --git a/docs/content/user-guides/docker-compose/basic-example/index.md b/docs/content/user-guides/docker-compose/basic-example/index.md index 4efef3bcb..c3950dd1d 100644 --- a/docs/content/user-guides/docker-compose/basic-example/index.md +++ b/docs/content/user-guides/docker-compose/basic-example/index.md @@ -86,7 +86,7 @@ Second, you define an entry point, along with the exposure of the matching port ```yaml command: # Traefik will listen to incoming request on the port 80 (HTTP) - - "--entrypoints.web.address=:80" + - "--entryPoints.web.address=:80" ports: - "80:80"