Add MICRO_IGLU_REGISTRY_URL and MICRO_IGLU_API_KEY environment variables

snowplow-incubator / snowplow-micro

Standalone application to automate testing of trackers

Other

47 stars 15 forks source link

Add MICRO_IGLU_REGISTRY_URL and MICRO_IGLU_API_KEY environment variables #132

Closed stanch closed 1 year ago

stanch commented 1 year ago

This offers an easy shortcut for those who don’t want to spell out a full Iglu config file.

stanch commented 1 year ago

Sorry for the noise! The thinking around how this should be configured is evolving :)

stanch commented 1 year ago

Last change I promise :) Added _URL based on feedback from Jordan.

Would be nice to update the README with a quick explanation/example values for the envvars (or also even in the --help printout? though I'm less sure if envvars belong there), in addition to the site docs

My plan is:

Land this and release 1.5.0
Publish the Micro docs (https://github.com/snowplow/documentation/pull/301), which I will update to include this version, and also a new page with an overview of env vars and command line flags
Point the README to the docs
Add a Docker Hub README pointing to the docs

rlh1994 commented 1 year ago

Is it worth adding a check that a private registry URL ends with /api to avoid anyone missing that out and not knowing why it isn't working? https://docs.snowplow.io/docs/pipeline-components-and-applications/iglu/iglu-resolver/

(sorry if you already do, I couldn't see it in there but I also don't speak scala)

stanch commented 1 year ago

Is it worth adding a check that a private registry URL ends with /api to avoid anyone missing that out and not knowing why it isn't working? https://docs.snowplow.io/docs/pipeline-components-and-applications/iglu/iglu-resolver/

(sorry if you already do, I couldn't see it in there but I also don't speak scala)

I am not sure we can/should enforce that. For example, http://iglucentral.com is a valid registry but does end with /api. Could someone theoretically run a private registry that way as well?

rlh1994 commented 1 year ago

I am not sure we can/should enforce that. For example, http://iglucentral.com is a valid registry but does end with /api. Could someone theoretically run a private registry that way as well?

I am not the person to ask that... Maybe if they provide an API key value we could at least warn/log?

stanch commented 1 year ago

Added env vars to --help: