Adds ability to change api url via env var #621
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds the ability to change the OCM API URL based on the environment variable `OCM_URL` allowing a user to change the OCM context without changing global state on their machine.
These commands were missing the ConnectionBuilder abstraction and were still building the connection manually, so these were migrated so that they will work correctly.
iamkirkbater
commented
Jun 4, 2024
Adds an explicit warning message in the login command that the OCM_URL environment variable is explicitly NOT used for login.
Allows override URL but when running with the debug flag this will inform users that this functionality is tech preview and may have issues while we build and test this. This should allow SRE to be able to use this feature immediately following the next release while setting the expectation with customers who may find this that it may still have some unexpected quirks, and to fall back to supported methodology for using this tool.
iamkirkbater
commented
Jun 4, 2024
| } | ||
| b.cfg.URL = overrideUrl | ||
| } | ||
|
|
There was a problem hiding this comment.
When run with the debug flag, output will end up looking like this:
> OCM_URL=https://api.regional.openshift.com ./ocm --debug get cluster $CLUSTER_ID
INFO: OCM_URL is overridden via environment variable. This functionality is considered tech preview and may cause unexpected issues.
If you experience issues while OCM_URL is set, unset the OCM_URL environment variable and attempt to log in directly to the desired OCM environment.
I0604 10:23:47.595646 83670 connection.go:876] Added URL with prefix '', regular expression '^(/.*)?$' and URL 'https://api.regional.openshift.com'
...
iamkirkbater
commented
Jun 4, 2024
| if overrideUrl := os.Getenv("OCM_URL"); overrideUrl != "" { | ||
| fmt.Fprintf(os.Stderr, "WARNING: the `OCM_URL` environment variable is set, but is not used for the login command. The `ocm login` command will only use the explicitly set flag's url, which is set as %s\n", gatewayURL) | ||
| } | ||
|
|
There was a problem hiding this comment.
> OCM_URL=https://api.stage.openshift.com ./ocm login --token=$OCM_ACCESS_TOKEN --url integration
WARNING: the `OCM_URL` environment variable is set, but is not used for the login command. The `ocm login` command will only use the explicitly set flag's url, which is set as https://api.integration.openshift.com
> ocm config get url
https://api.integration.openshift.com
macgregor
reviewed
Jun 4, 2024
tylercreller
reviewed
Jun 5, 2024
macgregor
approved these changes
Jun 5, 2024
|
Yeah - if you want to rewrite the whole thing to have specific env var overrides I'd consider implementing |
tylercreller
approved these changes
Jun 5, 2024
cristianoveiga
approved these changes
Jun 5, 2024
renan-campos
approved these changes
Jun 5, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds the ability to change the OCM API URL based on the environment variable
OCM_URLallowing a user to change the OCM context without changing global state on their machine.Satisfies OCM-8459.
Testing
To test this, I built the binary locally and ran a few commands, expecting different output.