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

See also

• List of all environment variables
• List of system filenames ("filename constants")

Documentation

Overview

Package env contains environment variables

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

Package env contains environment variables

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

Package env contains environment variables

• Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.

Index

• Variables
• func AwsDefaultRegion() (region string)

Variables

var (
	AIS = struct {
		// endpoint: client | primary startup
		Endpoint  string
		PrimaryEP string

		// networking: two CIDR masks
		LocalRedirectCIDR string
		PubIPv4CIDR       string

		//
		// HTTPS
		// for details and background, see: https://github.com/NVIDIA/aistore/blob/main/docs/environment-vars.md#https
		//
		UseHTTPS string
		// TLS: client side
		Certificate   string
		CertKey       string
		ClientCA      string
		SkipVerifyCrt string

		// tests, CI
		NumTarget string
		NumProxy  string

		// K8s
		K8sPod       string
		K8sNode      string
		K8sNamespace string
	}{

		Endpoint:  "AIS_ENDPOINT",
		PrimaryEP: "AIS_PRIMARY_EP",

		LocalRedirectCIDR: "AIS_CLUSTER_CIDR",
		PubIPv4CIDR:       "AIS_PUBLIC_IP_CIDR",

		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",
		K8sNode:      "MY_NODE",
		K8sNamespace: "K8S_NS",
	}
)

var (
	AWS = struct {
		Endpoint  string
		Region    string
		Profile   string
		Inventory string
	}{
		Endpoint: "S3_ENDPOINT",
		Region:   "AWS_REGION",
		Profile:  "AWS_PROFILE",
	}
)

var (
	AuthN = struct {
		Enabled       string
		URL           string
		TokenFile     string
		Token         string
		ConfDir       string
		LogDir        string
		LogLevel      string
		Port          string
		TTL           string
		UseHTTPS      string
		ServerCrt     string
		ServerKey     string
		AdminPassword string
		AdminUsername string
		SecretKey     string
	}{
		Enabled:       "AIS_AUTHN_ENABLED",
		URL:           "AIS_AUTHN_URL",
		TokenFile:     "AIS_AUTHN_TOKEN_FILE",
		Token:         "AIS_AUTHN_TOKEN",
		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",
		ServerCrt:     "AIS_SERVER_CRT",
		ServerKey:     "AIS_SERVER_KEY",
		SecretKey:     "AIS_AUTHN_SECRET_KEY",
		AdminUsername: "AIS_AUTHN_SU_NAME",
		AdminPassword: "AIS_AUTHN_SU_PASS",
	}
)

Functions

func AwsDefaultRegion

func AwsDefaultRegion() (region string)