os

package

v0.0.0-...-0369387 Latest Latest Go to latest Published: Apr 30, 2024 License: Zlib Imports: 6 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/portainer/agent

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func DetermineContainerPlatform() agent.ContainerPlatform
func GetHostName() (string, error)
func GetKubernetesPodIP() string
type EnvOptionParser
- func NewEnvOptionParser() *EnvOptionParser
- func (parser *EnvOptionParser) Options() (*agent.Options, error)

Constants ¶

View Source

const (
	PodmanMode            = "PODMAN"
	KubernetesServiceHost = "KUBERNETES_SERVICE_HOST"
	KubernetesPodIP       = "KUBERNETES_POD_IP"
	NomadJobName          = "NOMAD_JOB_NAME"
)

View Source

const (
	EnvKeyAgentHost             = "AGENT_HOST"
	EnvKeyAgentPort             = "AGENT_PORT"
	EnvKeyClusterAddr           = "AGENT_CLUSTER_ADDR"
	EnvKeyClusterProbeTimeout   = "AGENT_CLUSTER_PROBE_TIMEOUT"
	EnvKeyClusterProbeInterval  = "AGENT_CLUSTER_PROBE_INTERVAL"
	EnvKeyAgentSecret           = "AGENT_SECRET"
	EnvKeyAgentSecurityShutdown = "AGENT_SECRET_TIMEOUT"
	EnvKeyAssetsPath            = "ASSETS_PATH"
	EnvKeyDataPath              = "DATA_PATH"
	EnvKeyEdge                  = "EDGE"
	EnvKeyEdgeAsync             = "EDGE_ASYNC"
	EnvKeyEdgeKey               = "EDGE_KEY"
	EnvKeyEdgeID                = "EDGE_ID"
	EnvKeyEdgeServerHost        = "EDGE_SERVER_HOST"
	EnvKeyEdgeServerPort        = "EDGE_SERVER_PORT"
	EnvKeyEdgeInactivityTimeout = "EDGE_INACTIVITY_TIMEOUT"
	EnvKeyEdgeInsecurePoll      = "EDGE_INSECURE_POLL"
	EnvKeyEdgeTunnel            = "EDGE_TUNNEL"
	EnvKeyEdgeTunnelHttpProxy   = "HTTP_PROXY"
	EnvKeyEdgeTunnelHttpsProxy  = "HTTPS_PROXY"
	EnvKeyHealthCheck           = "HEALTH_CHECK"
	EnvKeyLogLevel              = "LOG_LEVEL"
	EnvKeyLogMode               = "LOG_MODE"
	EnvKeySSLCert               = "MTLS_SSL_CERT"
	EnvKeySSLKey                = "MTLS_SSL_KEY"
	EnvKeySSLCACert             = "MTLS_SSL_CA"
	EnvKeyCertRetryInterval     = "MTLS_CERT_RETRY_INTERVAL"
	EnvKeyAWSClientCert         = "AWS_CLIENT_CERT"
	EnvKeyAWSClientKey          = "AWS_CLIENT_KEY"
	EnvKeyAWSClientBundle       = "AWS_CLIENT_BUNDLE"
	EnvKeyAWSRoleARN            = "AWS_ROLE_ARN"
	EnvKeyAWSTrustAnchorARN     = "AWS_TRUST_ANCHOR_ARN"
	EnvKeyAWSProfileARN         = "AWS_PROFILE_ARN"
	EnvKeyAWSRegion             = "AWS_REGION"
	EnvKeyUpdateID              = "UPDATE_ID"
	EnvKeyEdgeGroups            = "EDGE_GROUPS"
	EnvKeyEnvironmentGroup      = "PORTAINER_GROUP"
	EnvKeyTags                  = "PORTAINER_TAGS"
)

Variables ¶

This section is empty.

Functions ¶

func DetermineContainerPlatform ¶

func DetermineContainerPlatform() agent.ContainerPlatform

DetermineContainerPlatform will check for the existence of the PODMAN_MODE or KUBERNETES_SERVICE_HOST environment variable to determine if the container is running on Podman or inside the Kubernetes platform. Defaults to Docker otherwise.

func GetHostName ¶

func GetHostName() (string, error)

func GetKubernetesPodIP ¶

func GetKubernetesPodIP() string

GetKubernetesPodIP returns the pod IP address through the KUBERNETES_POD_IP environment variable. This environment variable must be specified in the Agent deployment specs.

Types ¶

type EnvOptionParser ¶

type EnvOptionParser struct{}

func NewEnvOptionParser ¶

func NewEnvOptionParser() *EnvOptionParser

func (*EnvOptionParser) Options ¶

func (parser *EnvOptionParser) Options() (*agent.Options, error)

Source Files ¶

View all Source files

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