gaeconfig

Documentation

Overview

Package gaeconfig implements LUCI-config service bindings backed by AppEngine storage and caching.

Importing this module registers ${appid} and ${config_service_appid} config placeholder variables, see go.chromium.org/luci/config/vars.

DEPRECATED!

Do not use outside of GAEv1. Use go.chromium.org/luci/config/server/cfgmodule on GAEv2 and GKE instead.

Index

• func GetConfigServiceAppID(c context.Context) (string, error)
• func InstallValidationHandlers(r *router.Router, base router.MiddlewareChain, rules *validation.RuleSet)
• func RegisterVars(vars *vars.VarSet)
• func Use(c context.Context) context.Context
• type Settings
  • func DefaultSettings(c context.Context) Settings
  • func FetchCachedSettings(c context.Context) (Settings, error)
  • func (s *Settings) SetIfChanged(c context.Context, who, why string) error

Functions

func GetConfigServiceAppID

func GetConfigServiceAppID(c context.Context) (string, error)

GetConfigServiceAppID looks up the app ID of the LUCI Config service, as set in the app's settings.

Returns an empty string if the LUCI Config integration is not configured for the app.

func InstallValidationHandlers

func InstallValidationHandlers(r *router.Router, base router.MiddlewareChain, rules *validation.RuleSet)

InstallValidationHandlers installs handlers for config validation.

It ensures that caller is either the config service itself or a member of a trusted group, both of which are configurable in the appengine app settings. It requires that the hostname, the email of config service and the name of the trusted group have been defined in the appengine app settings page before the installed endpoints are called.

func RegisterVars

func RegisterVars(vars *vars.VarSet)

RegisterVars registers placeholders that can be used in config set names.

Registers:

${appid} - expands into a GAE app ID of the running service.
${config_service_appid} - expands into a GAE app ID of a LUCI Config
    service that the running service is using (or empty string if
    unconfigured).

This function is called during init() with the default var set.

func Use

func Use(c context.Context) context.Context

Use installs the default luci-config client.

The client is configured to use luci-config URL specified in the settings, using GAE app service account for authentication.

If running in prod, and the settings don't specify luci-config URL, produces an implementation that returns a "not configured" error from all methods.

If running on devserver, and the settings don't specify luci-config URL, returns a filesystem-based implementation that reads configs from a directory (or a symlink) named 'devcfg' located in the GAE module directory (where app.yaml is) or its immediate parent directory.

If such directory can not be located, produces an implementation of that returns errors from all methods.

Panics if it can't load the settings (should not happen since they are in the local memory cache usually).

Types

type Settings

type Settings struct {
	// ConfigServiceHost is host name (and port) of the luci-config service to
	// fetch configs from.
	//
	// For legacy reasons, the JSON value is "config_service_url".
	ConfigServiceHost string `json:"config_service_url"`

	// Administrators is the auth group of users that can call the validation
	// endpoint.
	AdministratorsGroup string `json:"administrators_group"`
}

Settings are stored in the datastore via appengine/gaesettings package.

func DefaultSettings

func DefaultSettings(c context.Context) Settings

DefaultSettings returns Settings to use if setting store is empty.

func FetchCachedSettings

func FetchCachedSettings(c context.Context) (Settings, error)

FetchCachedSettings fetches Settings from the settings store.

Uses in-process global cache to avoid hitting datastore often. The cache expiration time is 1 min (see gaesettings.expirationTime), meaning the instance will refetch settings once a minute (blocking only one unlucky request to do so).

Returns errors only if there's no cached value (i.e. it is the first call to this function in this process ever) and datastore operation fails.

func (*Settings) SetIfChanged

func (s *Settings) SetIfChanged(c context.Context, who, why string) error

SetIfChanged sets "s" to be the new Settings if it differs from the current settings value.