ieappicon

Documentation

Overview

Package ieappicon implements a Gostwire decorator for adorning containers belonging to Industrial Edge app composer projects with their app icons.

This decorator retrieves the app icons from the local IE edge core's app engine data base. It caches project icons and only looks for potential project updates whenever a new container with an associated composer project gets started. This cache additionally caches negative lookups.

Index

• Constants
• Variables
• func Decorate(engines []*model.ContainerEngine, labels map[string]string)

Constants

const IEAppDebuggableLabel = "gostwire/ieapp/debuggable"

IEAppDebuggableLabel is new as of IE runtime/core 1.8 and is set to the value of the isDebuggingEnabled column of an App if not "0" or missing. IEAppDebuggableLabel is an integer in stringified form.

const IEAppDiscoveryLabel = "ieappicons"

IEAppDiscoveryLabel is the name of a discovery options label to enable (or disable) the ieappicon plugin for a specific discovery. If a label of this name is present in the options of a discovery and its value isn't "off" then this decorator will be used in that particular discovery.

const IEAppDiscoveryOff = "off"

IEAppDiscoveryOff is the "magic" value of an IEAppDiscoveryLabel to explicitly turn off this plugin for a specific discovery. Please note that this plugin defaults to being inactive for any discovery unless the IEAppDiscoveryLabel is present in the discovery options and its value isn't IEAppDiscoveryOff. The rationale here is that it is still possible to disable this plugin on a discovery, even if the magic label is present.

const IEAppTitleLabel = "gostwire/ieapp/title"

IEAppTitleLabel is the name of a label storing a container's IE App title.

const IconLabel = "gostwire/icon"

IconLabel is the name of a label storing a container's icon in form of a data: URL, if any.

Variables

var EnablePlugin = true

EnablePlugin enables this plugin; by default, it is enabled but still needs to be triggered during discovery by passing a discovery label with the name "ieappicons" and value other than "off".

Functions

func Decorate

func Decorate(engines []*model.ContainerEngine, labels map[string]string)

Decorate all IE App containers with their app project icons; the icons are stored in the container labels in form of data: URLs of base64-encoded png-type images.