config

Documentation

Overview

Copyright (c) Alex Ellis 2017. All rights reserved. Copyright (c) OpenFaaS Author(s) 2020. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.

Index

• func ConnectivityCheck() error
• type BootstrapConfig
  • func (c BootstrapConfig) Fprint(verbose bool)
• type ReadConfig
  • func (ReadConfig) Read(hasEnv ftypes.HasEnv) (BootstrapConfig, error)

Functions

func ConnectivityCheck

func ConnectivityCheck() error

ConnectivityCheck checks if the controller can reach the public Internet via HTTPS. A license is required to use OpenFaaS for Commercial Use.

Types

type BootstrapConfig

type BootstrapConfig struct {
	// HTTPProbe when set to true switches readiness and liveness probe to
	// access /_/health over HTTP instead of accessing /tmp/.lock.
	HTTPProbe bool

	// SetNonRootUser determines if the Function is deployed with a overridden
	// non-root user id.  Currently this is preconfigured to the uid 12000.
	SetNonRootUser bool

	// DefaultFunctionNamespace defines which namespace in which Functions are deployed.
	// Value is set via the function_namespace environment variable. If the
	// variable is not set, it is set to "default".
	DefaultFunctionNamespace string

	// FaaSConfig contains the configuration for the FaaSProvider
	FaaSConfig ftypes.FaaSConfig
}

BootstrapConfig contains the server configuration values as well as default Function configuration parameters that are passed to the function factory.

func (BootstrapConfig) Fprint

func (c BootstrapConfig) Fprint(verbose bool)

Fprint pretty-prints the config with the stdlib logger. One line per config value. When the verbose flag is set to false, it prints the same output as prior to the 0.12.0 release.

type ReadConfig

type ReadConfig struct {
}

ReadConfig constitutes config from env variables

func (ReadConfig) Read

func (ReadConfig) Read(hasEnv ftypes.HasEnv) (BootstrapConfig, error)

Read fetches config from environmental variables.