env

package

v1.3.15 Latest Latest Go to latest Published: Nov 13, 2022 License: MIT Imports: 0 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/NVIDIA/aistore

Links

README ¶

System environment variables

The package contains system environment variables - globally defined names that include AIS_ENDPOINT, AIS_AUTHN_TOKEN_FILE, and more.

As such, the env package is, effectively, part of the API: the names defined here are used throughout, both in the Go code and in the scripts. In particular, deployment scripts.

It is important to preserve consistency and reference the same names (without copy-paste duplication, when possible)

ais.go: AIS environment
authn.go: AuthN environment
debug.go: DEBUG environment (build and command-line)

For the list of private system filenames (aka "filename constants"), see also: cmn/fname/fname.go

Documentation ¶

Overview ¶

Package env contains environment variables

Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.

Package env contains environment variables

Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.

Package env contains environment variables

Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.

Constants ¶

View Source

const (
	MODE  = "MODE"      // e.g., MODE=debug make deploy ...
	DEBUG = "AIS_DEBUG" // e.g., AIS_DEBUG="fs=4,reb=4,transport=1" make deploy ...
)

Variables ¶

View Source

var (
	AIS = struct {
		Endpoint      string
		IsPrimary     string
		PrimaryID     string
		SkipVerifyCrt string
		UseHTTPS      string
		NumTarget     string
		NumProxy      string
		K8sPod        string
	}{
		Endpoint:      "AIS_ENDPOINT",
		IsPrimary:     "AIS_IS_PRIMARY",
		PrimaryID:     "AIS_PRIMARY_ID",
		SkipVerifyCrt: "AIS_SKIP_VERIFY_CRT",
		UseHTTPS:      "AIS_USE_HTTPS",

		NumTarget: "NUM_TARGET",
		NumProxy:  "NUM_PROXY",

		K8sPod: "MY_POD",
	}
)

View Source

var (
	AuthN = struct {
		Enabled   string
		URL       string
		TokenFile string
		ConfDir   string
		LogDir    string
		LogLevel  string
		Port      string
		TTL       string
		UseHTTPS  string
	}{
		Enabled:   "AIS_AUTHN_ENABLED",
		URL:       "AIS_AUTHN_URL",
		TokenFile: "AIS_AUTHN_TOKEN_FILE",
		ConfDir:   "AIS_AUTHN_CONF_DIR",
		LogDir:    "AIS_AUTHN_LOG_DIR",
		LogLevel:  "AIS_AUTHN_LOG_LEVEL",
		Port:      "AIS_AUTHN_PORT",
		TTL:       "AIS_AUTHN_TTL",
		UseHTTPS:  "AIS_AUTHN_USE_HTTPS",
	}
)

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL