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.

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

additional help when making a predefined tunneller config #1325

Open
dovholuknf opened this issue Sep 20, 2023 · 0 comments
Open

additional help when making a predefined tunneller config #1325

dovholuknf opened this issue Sep 20, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@dovholuknf
Copy link
Member

Problem
ziti edge create config expects the user to create a json config that is full and complete and matches the schema. When the user misses something, the error is not immediately obvious. For example this host.v1 config is subtlely wrong (pluralized protocols):

{
  "address":"127.0.0.1",
  "protocols":["udp", "tcp"], # this key is wrong, it should be `protocol` with the value type of `string` and not list
  "port":'"${PORT}"',
  "listenOptions": { "identity": "$tunneler_id.name" }
  }

leading to an error that is difficult to parse and understand even for a very advanced CLI user:

    "error": {
        "cause": {
            "field": "(root)",
            "reason": "(root) is invalid: (root): Must validate \"else\" as \"if\" was not valid",
            "value": "map[address:127.0.0.1 listenOptions:map[identity:$tunneler_id.name] port:3889 protocols:[udp tcp]]"
        },

Desired Outcome
it would be a better experience for the user if we could do something such as:

  • somehow be able to guide the user through the process of creating the config, (perhaps with input prompts)
  • add numerous flags for the "80% usecase" to let the ziti cli compose the representative json before sending it to the controller
  • validate the json in the CLI and try to decipher the issue before sending to the controller
  • some other solution that would help people find/fix this error
@dovholuknf dovholuknf added the enhancement New feature or request label Sep 20, 2023
plorenz pushed a commit that referenced this issue Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant