move and refactor common environment; AuthN version and build time

* add `api/env` package * authn executable to report version and build time (consistent format) Signed-off-by: Alex Aizman <[email protected]>
NVIDIA · Jul 5, 2022 · 41a5070 · 41a5070
1 parent eb50757
commit 41a5070
Show file tree

Hide file tree

Showing 32 changed files with 125 additions and 85 deletions.
diff --git a/ais/earlystart.go b/ais/earlystart.go
@@ -1,6 +1,6 @@
 // Package ais provides core functionality for the AIStore object storage.
 /*
- * Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
+ * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */
 package ais
 
@@ -11,6 +11,7 @@ import (
 
 	"github.com/NVIDIA/aistore/3rdparty/glog"
 	"github.com/NVIDIA/aistore/api/apc"
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cluster"
 	"github.com/NVIDIA/aistore/cmn"
 	"github.com/NVIDIA/aistore/cmn/cos"
@@ -115,14 +116,14 @@ func (p *proxy) determineRole(loadedSmap *smapX) (pid string, primary bool) {
 		pid     string
 		primary bool
 	}{
-		pid:     os.Getenv(cmn.EnvVars.PrimaryID),
-		primary: cos.IsParseBool(os.Getenv(cmn.EnvVars.IsPrimary)),
+		pid:     os.Getenv(env.AIS.PrimaryID),
+		primary: cos.IsParseBool(os.Getenv(env.AIS.IsPrimary)),
 	}
 
 	if envP.pid != "" && envP.primary && p.si.ID() != envP.pid {
 		cos.ExitLogf(
 			"FATAL: %s: invalid combination of %s=true & %s=%s",
-			p.si, cmn.EnvVars.IsPrimary, cmn.EnvVars.PrimaryID, envP.pid,
+			p.si, env.AIS.IsPrimary, env.AIS.PrimaryID, envP.pid,
 		)
 	}
 	glog.Infof("%s: %sprimary-env=%+v", p.si.StringEx(), tag, envP)
@@ -132,13 +133,13 @@ func (p *proxy) determineRole(loadedSmap *smapX) (pid string, primary bool) {
 		if primary == nil {
 			glog.Errorf(
 				"%s: ignoring %s=%s - not found in the loaded %s",
-				p.si, cmn.EnvVars.IsPrimary, envP.pid, loadedSmap,
+				p.si, env.AIS.IsPrimary, envP.pid, loadedSmap,
 			)
 			envP.pid = ""
 		} else if loadedSmap.Primary.ID() != envP.pid {
 			glog.Warningf(
 				"%s: new %s=%s, previous %s",
-				p.si, cmn.EnvVars.PrimaryID, envP.pid, loadedSmap.Primary,
+				p.si, env.AIS.PrimaryID, envP.pid, loadedSmap.Primary,
 			)
 			loadedSmap.Primary = primary
 		}

diff --git a/ais/proxy.go b/ais/proxy.go
@@ -23,6 +23,7 @@ import (
 
 	"github.com/NVIDIA/aistore/3rdparty/glog"
 	"github.com/NVIDIA/aistore/api/apc"
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cluster"
 	"github.com/NVIDIA/aistore/cmn"
 	"github.com/NVIDIA/aistore/cmn/cos"
@@ -2341,7 +2342,7 @@ func (p *proxy) httpdaeget(w http.ResponseWriter, r *http.Request) {
 			DeploymentType: deploymentType(),
 			Version:        daemon.version,
 			BuildTime:      daemon.buildTime,
-			K8sPodName:     os.Getenv(cmn.EnvVars.K8sPod),
+			K8sPodName:     os.Getenv(env.AIS.K8sPod),
 		}
 
 		p.writeJSON(w, r, msg, what)

diff --git a/ais/tests/main_test.go b/ais/tests/main_test.go
@@ -1,6 +1,6 @@
 // Package integration contains AIS integration tests.
 /*
- * Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
+ * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */
 package integration
 
@@ -15,6 +15,7 @@ import (
 
 	"github.com/NVIDIA/aistore/api"
 	"github.com/NVIDIA/aistore/api/apc"
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cmn"
 	"github.com/NVIDIA/aistore/cmn/cos"
 	"github.com/NVIDIA/aistore/devtools/tlog"
@@ -50,16 +51,16 @@ func waitForCluster() error {
 		err                        error
 		proxyCnt, targetCnt, retry int
 	)
-	pc := os.Getenv(cmn.EnvVars.NumProxy)
-	tc := os.Getenv(cmn.EnvVars.NumTarget)
+	pc := os.Getenv(env.AIS.NumProxy)
+	tc := os.Getenv(env.AIS.NumTarget)
 	if pc != "" || tc != "" {
 		proxyCnt, err = strconv.Atoi(pc)
 		if err != nil {
-			return fmt.Errorf("error EnvVars: %s. err: %v", cmn.EnvVars.NumProxy, err)
+			return fmt.Errorf("error EnvVars: %s. err: %v", env.AIS.NumProxy, err)
 		}
 		targetCnt, err = strconv.Atoi(tc)
 		if err != nil {
-			return fmt.Errorf("error EnvVars: %s. err: %v", cmn.EnvVars.NumTarget, err)
+			return fmt.Errorf("error EnvVars: %s. err: %v", env.AIS.NumTarget, err)
 		}
 	}
 	_, err = tutils.WaitForClusterState(tutils.GetPrimaryURL(), "startup", -1, proxyCnt, targetCnt)

diff --git a/ais/tests/s3compat/e2e_s3_test.go b/ais/tests/s3compat/e2e_s3_test.go
@@ -1,6 +1,6 @@
 // Package s3_integration provides tests of compatibility with AWS S3
 /*
- * Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
+ * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */
 package integration
 
@@ -11,7 +11,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/NVIDIA/aistore/cmn"
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cmn/cos"
 	"github.com/NVIDIA/aistore/devtools/tutils"
 	. "github.com/onsi/ginkgo"
@@ -38,7 +38,7 @@ var _ = Describe("E2E AWS Compatibility Tests", func() {
 		params string
 	)
 
-	if value := os.Getenv(cmn.EnvVars.UseHTTPS); cos.IsParseBool(value) {
+	if value := os.Getenv(env.AIS.UseHTTPS); cos.IsParseBool(value) {
 		host = "https://localhost:8080/s3"
 		params = "--no-check-certificate"
 	} else {

diff --git a/ais/tgtcp.go b/ais/tgtcp.go
@@ -17,6 +17,7 @@ import (
 	"github.com/NVIDIA/aistore/3rdparty/glog"
 	"github.com/NVIDIA/aistore/ais/backend"
 	"github.com/NVIDIA/aistore/api/apc"
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cluster"
 	"github.com/NVIDIA/aistore/cmn"
 	"github.com/NVIDIA/aistore/cmn/cos"
@@ -262,7 +263,7 @@ func (t *target) httpdaeget(w http.ResponseWriter, r *http.Request) {
 			DeploymentType: deploymentType(),
 			Version:        daemon.version,
 			BuildTime:      daemon.buildTime,
-			K8sPodName:     os.Getenv(cmn.EnvVars.K8sPod),
+			K8sPodName:     os.Getenv(env.AIS.K8sPod),
 		}
 		// capacity
 		tstats := t.statsT.(*stats.Trunner)

diff --git a/ais/utils.go b/ais/utils.go
@@ -14,6 +14,7 @@ import (
 
 	"github.com/NVIDIA/aistore/3rdparty/glog"
 	"github.com/NVIDIA/aistore/api/apc"
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cluster"
 	"github.com/NVIDIA/aistore/cmn"
 	"github.com/NVIDIA/aistore/cmn/cos"
@@ -242,7 +243,7 @@ func cleanupConfigDir(name string, keepInitialConfig bool) {
 }
 
 func writeShutdownMarker() {
-	markerDir := os.Getenv(cmn.EnvVars.ShutdownMarkerPath)
+	markerDir := os.Getenv(env.AIS.ShutdownMarkerPath)
 	if markerDir == "" {
 		if k8s.Detect() == nil {
 			glog.Warningf("marker directory not specified, skipping writing shutdown marker")
@@ -259,7 +260,7 @@ func writeShutdownMarker() {
 }
 
 func deleteShutdownMarker() {
-	markerDir := os.Getenv(cmn.EnvVars.ShutdownMarkerPath)
+	markerDir := os.Getenv(env.AIS.ShutdownMarkerPath)
 	if markerDir != "" {
 		cos.RemoveFile(filepath.Join(markerDir, cmn.ShutdownMarker))
 	}

diff --git a/api/authn/loadtoken.go b/api/authn/loadtoken.go
@@ -8,6 +8,7 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cmn"
 	"github.com/NVIDIA/aistore/cmn/cos"
 	"github.com/NVIDIA/aistore/cmn/debug"
@@ -21,7 +22,7 @@ func LoadToken(tokenFile string) string {
 		mustLoad = true
 	)
 	if tokenFile == "" {
-		tokenFile = os.Getenv(EnvVars.TokenFile)
+		tokenFile = os.Getenv(env.AuthN.TokenFile)
 	}
 	if tokenFile == "" {
 		// default config location

diff --git a/cmn/env_const.go → api/env/ais.go b/cmn/env_const.go → api/env/ais.go
@@ -1,14 +1,13 @@
-// Package cmn provides common constants, types, and utilities for AIS clients
-// and AIStore.
+// Package env contains environment variables
 /*
  * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */
-package cmn
+package env
 
 // ais environment variable names (see also fname_const.go)
 
 var (
-	EnvVars = struct {
+	AIS = struct {
 		Endpoint           string
 		ShutdownMarkerPath string
 		IsPrimary          string

diff --git a/api/authn/env_const.go → api/env/authn.go b/api/authn/env_const.go → api/env/authn.go
@@ -1,13 +1,13 @@
-// Package authn provides AuthN API over HTTP(S)
+// Package env contains environment variables
 /*
  * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */
-package authn
+package env
 
-// authn environment variable names (see also cmn/env_const.go)
+// authn environment variables
 
 var (
-	EnvVars = struct {
+	AuthN = struct {
 		Enabled   string
 		URL       string
 		ConfFile  string

diff --git a/bench/aisloader/bootstrap.go b/bench/aisloader/bootstrap.go
@@ -57,6 +57,7 @@ import (
 	"github.com/NVIDIA/aistore/api"
 	"github.com/NVIDIA/aistore/api/apc"
 	"github.com/NVIDIA/aistore/api/authn"
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/bench/aisloader/namegetter"
 	"github.com/NVIDIA/aistore/bench/aisloader/stats"
 	"github.com/NVIDIA/aistore/cmn"
@@ -552,7 +553,7 @@ func parseCmdLine() (params, error) {
 	}
 
 	aisEndpoint = "http://" + ip + ":" + port
-	envEndpoint = os.Getenv(cmn.EnvVars.Endpoint)
+	envEndpoint = os.Getenv(env.AIS.Endpoint)
 	if envEndpoint != "" {
 		aisEndpoint = envEndpoint
 	}

diff --git a/cmd/aisfs/config.go b/cmd/aisfs/config.go
@@ -1,6 +1,6 @@
 // Package aisfs - command-line mounting utility for aisfs.
 /*
- * Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
+ * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */
 package main
 
@@ -10,8 +10,8 @@ import (
 	"path/filepath"
 	"time"
 
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cmd/aisfs/fs"
-	"github.com/NVIDIA/aistore/cmn"
 	"github.com/NVIDIA/aistore/cmn/cos"
 	"github.com/NVIDIA/aistore/cmn/jsp"
 )
@@ -51,7 +51,7 @@ type (
 var defaultConfig = Config{
 	Cluster: ClusterConfig{
 		URL:           "http://127.0.0.1:8080",
-		SkipVerifyCrt: cos.IsParseBool(os.Getenv(cmn.EnvVars.SkipVerifyCrt)),
+		SkipVerifyCrt: cos.IsParseBool(os.Getenv(env.AIS.SkipVerifyCrt)),
 	},
 	Timeout: TimeoutConfig{
 		TCPTimeoutStr:  "60s",

diff --git a/cmd/aisfs/util.go b/cmd/aisfs/util.go
@@ -17,6 +17,7 @@ import (
 	"time"
 
 	"github.com/NVIDIA/aistore/api"
+	"github.com/NVIDIA/aistore/api/env"
 	"github.com/NVIDIA/aistore/cmd/aisfs/fs"
 	"github.com/NVIDIA/aistore/cmn"
 	"github.com/NVIDIA/aistore/cmn/cos"
@@ -60,9 +61,9 @@ func discoverClusterURL(c *cli.Context) string {
 		defaultAISDockerURL = "http://172.50.0.2:8080"
 		dockerErrMsgFmt     = "Failed to discover docker proxy URL: %v.\nUsing default %q.\n"
 	)
-	setURLMsg := fmt.Sprintf("Set URL with: export %s=`url`.", cmn.EnvVars.Endpoint)
+	setURLMsg := fmt.Sprintf("Set URL with: export %s=`url`.", env.AIS.Endpoint)
 
-	if envURL := os.Getenv(cmn.EnvVars.Endpoint); envURL != "" {
+	if envURL := os.Getenv(env.AIS.Endpoint); envURL != "" {
 		return envURL
 	}
 

diff --git a/cmd/aisnode/main.go b/cmd/aisnode/main.go
@@ -1,6 +1,6 @@
 // Package main for the AIS node executable.
 /*
- * Copyright (c) 2018-2021, NVIDIA CORPORATION. All rights reserved.
+ * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */
 package main
 

diff --git a/cmd/authn/aisreq.go b/cmd/authn/aisreq.go
@@ -1,4 +1,4 @@
-// Package authn provides AuthN server for AIStore.
+// Package authn is authentication server for AIStore.
 /*
  * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */

diff --git a/cmd/authn/config.go b/cmd/authn/config.go
@@ -1,4 +1,4 @@
-// Package authn provides AuthN server for AIStore.
+// Package authn is authentication server for AIStore.
 /*
  * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */

diff --git a/cmd/authn/const.go b/cmd/authn/const.go
@@ -1,4 +1,4 @@
-// Package authn provides AuthN server for AIStore.
+// Package authn is authentication server for AIStore.
 /*
  * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */

diff --git a/cmd/authn/hcommon.go b/cmd/authn/hcommon.go
@@ -1,4 +1,4 @@
-// Package authn provides AuthN server for AIStore.
+// Package authn is authentication server for AIStore.
 /*
  * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */

diff --git a/cmd/authn/hserv.go b/cmd/authn/hserv.go
@@ -1,4 +1,4 @@
-// Package authn provides AuthN server for AIStore.
+// Package authn is authentication server for AIStore.
 /*
  * Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.
  */