cloudfoundry / cloudfoundry/cli

map-route options documentation is wrong

Open
#3,606 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1.9k
Forks
990
Avg merge
1d 7h
Merged PRs (30d)
8

Description

  • I reviewed open and closed github issues that may be related to my problem.
  • I tried updating to the latest version of the CF CLI to see if it fixed my problem.
  • I attempted to run the command with CF_TRACE=1 to help debug the issue.
  • I am reporting a bug that others will be able to reproduce.

Describe the bug and the command you saw an issue with
I wanted to set a route using cf map-routewith HTTP/2 enabled like it is described in the documentation.

What happened
An error occurred Incorrect Usage: unknown flag destination-protocol'. The help command for map-route` gave me those instructions:

NAME:
   map-route - Map a route to an app

USAGE:
   Map an HTTP route:
      cf map-route APP_NAME DOMAIN [--hostname HOSTNAME] [--path PATH] [--app-protocol PROTOCOL] [--option OPTION=VALUE]
   
   Map a TCP route:
      cf map-route APP_NAME DOMAIN [--port PORT] [--option OPTION=VALUE]

EXAMPLES:
   cf map-route my-app example.com                                                      # example.com
   cf map-route my-app example.com --hostname myhost                                    # myhost.example.com
   cf map-route my-app example.com --hostname myhost -o loadbalancing=least-connection  # myhost.example.com with a per-route option
   cf map-route my-app example.com --hostname myhost --path foo                         # myhost.example.com/foo
   cf map-route my-app example.com --hostname myhost --app-protocol http2               # myhost.example.com
   cf map-route my-app example.com --port 5000                                          # example.com:5000

OPTIONS:
   --hostname, -n      Hostname for the HTTP route (required for shared domains)
   --path              Path for the HTTP route
   --port              Port for the TCP route (default: random port)
   --app-protocol      [Beta flag, subject to change] Protocol for the route destination (default: http1). Only applied to HTTP routes
   --option, -o        Set the value of a per-route option

SEE ALSO:
   create-route, routes, unmap-route, update-route

I then tried using app-protocol instead which fixed the problem so no current blocker.

Expected behavior
I expect the cli help and the documentation to be aligned and that the description in the documentation is correct. Please correct the documentation.

Exact Steps To Reproduce
Steps to reproduce the behavior; include the exact CLI commands and verbose output:

  1. Run cf map-route <YOUR_APP> <YOUR_DOMAIN> --destination-protocol http2
  2. See error

Provide more context

Notes regarding V6 and V7 CLI support:

  • V6:
    • Minimum supported version of CF Deployment: v7.0.0 (CAPI Release: 1.74.0 (APIs 2.128.0 and 3.63.0))
    • Maximum supported version of CF Deployment: v13.4.0 (CAPI Release: 1.94.0 (APIs 2.149.0 and 3.84.0))
  • V7:
    • Minimum supported version of CF Deployment: v13.5.0 (CAPI Release: 1.95.0 (APIs 2.150.0 and 3.85.0))

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the map-route documentation page and the supporting-http2 documentation page linked in the issue, then compare their flag names with the cf map-route help output shown here. Update the documented option to match the CLI, and verify that both pages describe the same command and HTTP/2 behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.