feat: rename url env to upstream

url is still supported for now. But will be removed later.

Author: Iandenh

.env.example

@@ -1,4 +1,4 @@
-export OVERLEASH_URL=
+export OVERLEASH_UPSTREAM=
 export OVERLEASH_TOKEN=
 export NETWORK_NAME=network_name
 export HOST_NAME=overleash.test

README.md

@@ -64,14 +64,14 @@ Setting the config for Overleash can be set in two ways, environment variable or
 
 Here are the config options:
 
-| Name 	                        | Value	                                                                                                                                                                   | Env	                      | Flag	              |
-|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|--------------------|
-| Unleash url	                  | 	 example: `https://unleash.my-site.com`, this url without `/api`, can be a Unleash instance or Unleash edge                                                             | `OVERLEASH_URL`	          | `--url`	           |
-| Reload frequency	             | 	  default: `0`, example: `1`, value is in minutes, `0` is no reload                                                                                                     | `OVERLEASH_RELOAD`	       | `--reload`	        |
-| Server port	                  | default: `5433`                                                                                                                                                          | `OVERLEASH_PORT`	         | `--port`	          |
-| Unleash token (Client token)	 | example:  `*:development.a2a6261d38fe4f9c86aceddce09a00df6c348fd0feeab3c24a9547f2` Token or tokens that are used to fetch the feature flag config from upstream unleash. | `OVERLEASH_TOKEN`	        | `--token`	         |
-| Verbose	                      | default:  `false` Logs a bit more information for diagnose issues                                                                                                        | `OVERLEASH_VERBOSE`	      | `--verbose`	       |
-| Proxy metrics to upstream	    | default:  `false` Proxy the metric calls to the upstream. Make sure the correct token are in the authorization header.                                                   | `OVERLEASH_PROXY_METRICS`	      | `--proxy-metrics`	 |
+| Name 	                        | Value	                                                                                                                                                                   | Env	                       | Flag	              |
+|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|--------------------|
+| Unleash upstream url	         | 	 example: `https://unleash.my-site.com`, this url without `/api`, can be a Unleash instance or Unleash edge                                                             | `OVERLEASH_UPSTREAM`	      | `--upstream`	      |
+| Reload frequency	             | 	  default: `0`, example: `1`, value is in minutes, `0` is no reload                                                                                                     | `OVERLEASH_RELOAD`	        | `--reload`	        |
+| Server port	                  | default: `5433`                                                                                                                                                          | `OVERLEASH_PORT`	          | `--port`	          |
+| Unleash token (Client token)	 | example:  `*:development.a2a6261d38fe4f9c86aceddce09a00df6c348fd0feeab3c24a9547f2` Token or tokens that are used to fetch the feature flag config from upstream unleash. | `OVERLEASH_TOKEN`	         | `--token`	         |
+| Verbose	                      | default:  `false` Logs a bit more information for diagnose issues                                                                                                        | `OVERLEASH_VERBOSE`	       | `--verbose`	       |
+| Proxy metrics to upstream	    | default:  `false` Proxy the metric calls to the upstream. Make sure the correct token are in the authorization header.                                                   | `OVERLEASH_PROXY_METRICS`	 | `--proxy-metrics`	 |
 
 ## API Endpoints
 ### Client API

docker-compose.yaml

@@ -11,6 +11,7 @@ services:
       - overleash-data:/data
     environment:
       - OVERLEASH_URL=${OVERLEASH_URL}
+      - OVERLEASH_UPSTREAM=${OVERLEASH_UPSTREAM}
       - OVERLEASH_TOKEN=${OVERLEASH_TOKEN}
       - OVERLEASH_RELOAD=${OVERLEASH_RELOAD}
       - TZ=${TZ}

helm/overleash/values.yaml

@@ -131,7 +131,7 @@ persistence:
   annotations: {}
 
 extraEnv:
-  OVERLEASH_URL: "http://unleash.unleash:4242"
+  OVERLEASH_UPSTREAM: ""
   OVERLEASH_TOKEN: ""
   OVERLEASH_RELOAD: "1"
   OVERLEASH_VERBOSE: "false"

main.go

@@ -23,7 +23,15 @@ func run(ctx context.Context) {
 	port := viper.GetInt("port")
 	proxyMetrics := viper.GetBool("proxy_metrics")
 
-	o := overleash.NewOverleash(viper.GetString("url"), tokens, reload)
+	upstream := viper.GetString("upstream")
+	if upstream == "" {
+		upstream = viper.GetString("url")
+		if upstream != "" {
+			log.Warn("The 'url' flag is deprecated. Please use the 'upstream' flag instead.")
+		}
+	}
+
+	o := overleash.NewOverleash(upstream, tokens, reload)
 	o.Start(ctx)
 
 	server.New(o, port, proxyMetrics, ctx).Start()
@@ -47,12 +55,14 @@ func initConfig() {
 	viper.AutomaticEnv()
 	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
 
-	pflag.String("url", "", "Upstream to load")
-	pflag.String("token", "", "Token to load")
-	pflag.String("port", "5433", "Port")
-	pflag.Int("reload", 0, "Reload")
-	pflag.Bool("verbose", false, "Verbose mode")
-	pflag.Bool("proxy_metrics", false, "Proxy metrics")
+	pflag.String("url", "", "DEPRECATED: Unleash URL (e.g. https://unleash.my-site.com) without /api. Use --upstream instead.")
+	pflag.String("upstream", "", "Unleash upstream URL to load feature flags (e.g. https://unleash.my-site.com) without /api, can be an Unleash instance or Unleash Edge.")
+	pflag.String("token", "", "Comma-separated Unleash client token(s) to fetch feature flag configurations.")
+	pflag.String("port", "5433", "Port number on which Overleash will listen (default: 5433).")
+	pflag.Int("reload", 0, "Reload frequency in minutes for refreshing feature flag configuration (0 disables automatic reloading).")
+	pflag.Bool("verbose", false, "Enable verbose logging to troubleshoot and diagnose issues.")
+	pflag.Bool("proxy_metrics", false, "Proxy metrics requests to the upstream Unleash server (ensure that the correct token is provided in the authorization header).")
+
 	pflag.Parse()
 
 	viper.BindPFlags(pflag.CommandLine)