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

Should we allow/prevent user to set DebugPort as environment variable? #2183

Closed
dharmit opened this issue Sep 26, 2019 · 6 comments
Closed
Labels
priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done.

Comments

@dharmit
Copy link
Member

dharmit commented Sep 26, 2019

[kind/bug]

What versions of software are you using?

  • Operating System: all
  • Output of odo version: master

How did you run odo exactly?

I set the DebugPort using environment variable approach (odo config set --env) but tried to unset it using normal approach (odo config unset DebugPort) and was left confused why it's not getting unset.

  1. odo config set -e DebugPort 9090
  2. odo config unset DebugPort

Actual behavior

Not really a bug but as a user I was wondering if this is a bug.

Expected behavior

TBD

Any logs, error output, etc?

In this case, it was my mistake to set DebugPort as env var and then unset it using odo config unset. Should we have a check or documentation or anything to prevent user from doing this or should this be just passed as user error?

It seems more like user error to me than anything that tool should be worried about.

@kadel
Copy link
Member

kadel commented Sep 26, 2019

Not sure how we could check this.
This is simply users error. If he/she sets the environment variable but tries to unset it as a config option. Maybe just a little bit documentation to make it more clear

@kadel kadel removed the need-docs label Dec 17, 2019
@girishramnani girishramnani added kind/documentation priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done. labels Dec 18, 2019
@yhontyk
Copy link

yhontyk commented Jan 6, 2020

We have a separate module on setting / unsetting variables now which users can refer to: openshift/openshift-docs#18478

@Preeticp
Copy link
Contributor

Preeticp commented Jan 31, 2020

@dharmit a separate module on setting / unsetting variables is documented by Yana here: https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_developer_cli/managing-environment-variables-in-odo.html
Do you think we can close this issue?

Also it will be covered as part of this issue: #2227

@dharmit
Copy link
Member Author

dharmit commented Feb 3, 2020

@dharmit a separate module on setting / unsetting variables is documented by Yana here: https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_developer_cli/managing-environment-variables-in-odo.html
Do you think we can close this issue?

In it's current state, the link you mentioned talks about environment variables in general. We're discussing a particular environment variable (DebugPort) which, IMO, could cause confusion if we don't document it.

@Preeticp
Copy link
Contributor

Preeticp commented Apr 2, 2020

@dharmit documentation on the debug feature was covered through this PR: openshift/openshift-docs#19750 can you confirm if we can close this issue, please?

@dharmit
Copy link
Member Author

dharmit commented Apr 3, 2020

Looks good to me. Thanks for addressing this @boczkowska & @Preeticp !

@dharmit dharmit closed this as completed Apr 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/Low Nice to have issue. It's not immediately on the project roadmap to get it done.
Projects
None yet
Development

No branches or pull requests

5 participants