env

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-2023, NVIDIA CORPORATION. All rights reserved.

Package env contains environment variables

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

Index

• Variables

Variables

var (
	AIS = struct {
		Endpoint  string
		IsPrimary string
		PrimaryID string
		UseHTTPS  string
		// TLS: client side
		Certificate   string
		CertKey       string
		ClientCA      string
		SkipVerifyCrt string
		// tests, CI
		NumTarget string
		NumProxy  string
		// K8s
		K8sPod string
	}{

		Endpoint:  "AIS_ENDPOINT",
		IsPrimary: "AIS_IS_PRIMARY",
		PrimaryID: "AIS_PRIMARY_ID",

		UseHTTPS: "AIS_USE_HTTPS",

		Certificate: "AIS_CRT",
		CertKey:     "AIS_CRT_KEY",
		ClientCA:    "AIS_CLIENT_CA",

		SkipVerifyCrt: "AIS_SKIP_VERIFY_CRT",

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

		K8sPod: "MY_POD",
	}
)

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",
	}
)