reference.json

{"entities": [{"name": "CouchDB Node", "type": "org.apache.brooklyn.entity.nosql.couchdb.CouchDBNode", "iconUrl": "classpath:///couchdb-logo.png", "effectors": [{"returnType": "void", "name": "populateServiceNotUpDiagnostics", "parameters": [], "description": "Populates the attribute service.notUp.diagnostics, with any available health indicators"}, {"returnType": "void", "name": "restart", "parameters": [], "description": "Restart the process/service represented by an entity"}, {"returnType": "void", "name": "start", "parameters": [{"defaultValue": null, "type": "java.lang.Object", "name": "locations", "description": "The location or locations to start in, as a string, a location object, a list of strings, or a list of location objects"}], "description": "Start the process/service represented by an entity"}, {"returnType": "void", "name": "stop", "parameters": [], "description": "Stop the process/service represented by an entity"}], "sensors": [{"type": "java.lang.String", "name": "couchdb.cluster.name", "links": {}, "description": "Name of the CouchDB cluster"}, {"type": "java.lang.String", "name": "couchdb.config.fileName", "links": {}, "description": "Name for the copied config file"}, {"type": "java.lang.String", "name": "couchdb.config.templateUrl", "links": {}, "description": "Template file (in freemarker format) for the couchdb config file"}, {"type": "java.lang.String", "name": "couchdb.uri.templateUrl", "links": {}, "description": "Template file (in freemarker format) for the couchdb URI file"}, {"type": "java.util.Map", "name": "download.addon.urls", "links": {}, "description": "URL patterns for downloading named add-ons (will substitute things like ${version} automatically)"}, {"type": "java.lang.String", "name": "download.url", "links": {}, "description": "URL pattern for downloading the installer (will substitute things like ${version} automatically)"}, {"type": "java.lang.String", "name": "expandedinstall.dir", "links": {}, "description": "Directory for installed artifacts (e.g. expanded dir after unpacking .tgz)"}, {"type": "java.lang.String", "name": "host.address", "links": {}, "description": "Host IP address"}, {"type": "java.lang.String", "name": "host.name", "links": {}, "description": "Host name"}, {"type": "java.lang.String", "name": "host.subnet.address", "links": {}, "description": "Host address as known internally in the subnet where it is running (if different to host.name)"}, {"type": "java.lang.String", "name": "host.subnet.hostname", "links": {}, "description": "Host name as known internally in the subnet where it is running (if different to host.name)"}, {"type": "java.lang.Integer", "name": "http.port", "links": {}, "description": "HTTP port"}, {"type": "java.lang.Integer", "name": "https.port", "links": {}, "description": "HTTP port (with SSL/TLS)"}, {"type": "java.lang.String", "name": "install.dir", "links": {}, "description": "Directory for this software to be installed in"}, {"type": "java.lang.String", "name": "run.dir", "links": {}, "description": "Directory for this software to be run from"}, {"type": "java.lang.Boolean", "name": "service.isUp", "links": {}, "description": "Whether the service is active and availability (confirmed and monitored)"}, {"type": "java.lang.Boolean", "name": "service.process.isRunning", "links": {}, "description": "Whether the process for the service is confirmed as running"}, {"type": "org.apache.brooklyn.core.entity.lifecycle.Lifecycle", "name": "service.state", "links": {}, "description": "Actual lifecycle state of the service"}, {"type": "org.apache.brooklyn.core.entity.lifecycle.Lifecycle$Transition", "name": "service.state.expected", "links": {}, "description": "Last controlled change to service state, indicating what the expected state should be"}, {"type": "java.lang.String", "name": "softwareprocess.pid.file", "links": {}, "description": "PID file"}, {"type": "org.apache.brooklyn.api.location.MachineProvisioningLocation", "name": "softwareservice.provisioningLocation", "links": {}, "description": "Location used to provision a machine where this is running"}, {"type": "java.util.Set", "name": "webapp.enabledProtocols", "links": {}, "description": "List of enabled protocols (e.g. http, https)"}, {"type": "org.apache.brooklyn.entity.webapp.HttpsSslConfig", "name": "webapp.https.ssl", "links": {}, "description": "SSL Configuration for HTTPS"}, {"type": "java.lang.Long", "name": "webapp.reqs.bytes.received", "links": {}, "description": "Total bytes received by the webserver"}, {"type": "java.lang.Long", "name": "webapp.reqs.bytes.sent", "links": {}, "description": "Total bytes sent by the webserver"}, {"type": "java.lang.Integer", "name": "webapp.reqs.errors", "links": {}, "description": "Request errors"}, {"type": "java.lang.Double", "name": "webapp.reqs.perSec.last", "links": {}, "description": "Reqs/sec (last datapoint)"}, {"type": "java.lang.Double", "name": "webapp.reqs.perSec.windowed", "links": {}, "description": "Reqs/sec (over time window)"}, {"type": "java.lang.Double", "name": "webapp.reqs.processingTime.fraction.last", "links": {}, "description": "Fraction of time spent processing, reported by webserver (percentage, last datapoint)"}, {"type": "java.lang.Double", "name": "webapp.reqs.processingTime.fraction.windowed", "links": {}, "description": "Fraction of time spent processing, reported by webserver (percentage, over time window)"}, {"type": "java.lang.Integer", "name": "webapp.reqs.processingTime.max", "links": {}, "description": "Max processing time for any single request, reported by webserver (millis)"}, {"type": "java.lang.Integer", "name": "webapp.reqs.processingTime.total", "links": {}, "description": "Total processing time, reported by webserver (millis)"}, {"type": "java.lang.Integer", "name": "webapp.reqs.total", "links": {}, "description": "Request count"}, {"type": "java.lang.String", "name": "webapp.url", "links": {}, "description": "URL"}], "defaultVersion": "1.2.1", "config": [{"type": "java.lang.String", "name": "archive.nameFormat", "reconfigurable": false, "description": "The format for the directory created when the installation archive is extracted, if required. The version string will be passed in as the first argument, replacing the %s format specifier"}, {"name": "children.startable.mode", "defaultValue": "NONE", "reconfigurable": false, "possibleValues": [{"description": "NONE", "value": "NONE"}, {"description": "FOREGROUND", "value": "FOREGROUND"}, {"description": "FOREGROUND_LATE", "value": "FOREGROUND_LATE"}, {"description": "BACKGROUND", "value": "BACKGROUND"}, {"description": "BACKGROUND_LATE", "value": "BACKGROUND_LATE"}], "type": "java.lang.Enum", "description": "Controls behaviour when starting Startable children as part of this entity's lifecycle."}, {"defaultValue": "BrooklynCluster", "type": "java.lang.String", "name": "couchdb.cluster.name", "reconfigurable": false, "description": "Name of the CouchDB cluster"}, {"defaultValue": "local.ini", "type": "java.lang.String", "name": "couchdb.config.fileName", "reconfigurable": false, "description": "Name for the copied config file"}, {"defaultValue": "classpath://org/apache/brooklyn/entity/nosql/couchdb/couch.ini", "type": "java.lang.String", "name": "couchdb.config.templateUrl", "reconfigurable": false, "description": "Template file (in freemarker format) for the couchdb config file"}, {"defaultValue": "classpath://org/apache/brooklyn/entity/nosql/couchdb/couch.uri", "type": "java.lang.String", "name": "couchdb.uri.templateUrl", "reconfigurable": false, "description": "Template file (in freemarker format) for the couchdb URI file"}, {"type": "java.lang.Boolean", "name": "customize.latch", "reconfigurable": false, "description": "Latch for blocking customize until ready"}, {"defaultValue": false, "type": "java.lang.Boolean", "name": "dontRequireTtyForSudo", "reconfigurable": false, "description": "Whether to explicitly set /etc/sudoers, so don't need tty (will leave unchanged if 'false'); some machines require a tty for sudo; brooklyn by default does not use a tty (so that it can get separate error+stdout streams); you can enable a tty as an option to every ssh command, or you can do it once and modify the machine so that a tty is not subsequently required."}, {"type": "java.util.Map", "name": "download.addon.urls", "reconfigurable": false, "description": "URL patterns for downloading named add-ons (will substitute things like ${version} automatically)"}, {"type": "java.lang.String", "name": "download.url", "reconfigurable": false, "description": "URL pattern for downloading the installer (will substitute things like ${version} automatically)"}, {"type": "java.lang.Boolean", "name": "entity.running", "reconfigurable": false, "description": "Skip the startup process entirely, if service already running"}, {"type": "java.lang.Boolean", "name": "entity.started", "reconfigurable": false, "description": "Skip the startup process entirely, for running services"}, {"defaultValue": "R15B", "type": "java.lang.String", "name": "erlang.version", "reconfigurable": false, "description": "Erlang runtime version"}, {"type": "java.lang.String", "name": "expandedinstall.dir", "reconfigurable": false, "description": "Directory for installed artifacts (e.g. expanded dir after unpacking .tgz)"}, {"type": "java.util.Map", "name": "files.install", "reconfigurable": false, "description": "Mapping of files, to be copied before install, to destination name relative to installDir"}, {"type": "java.util.Map", "name": "files.preinstall", "reconfigurable": false, "description": "Mapping of files, to be copied before install, to destination name relative to installDir"}, {"type": "java.util.Map", "name": "files.runtime", "reconfigurable": false, "description": "Mapping of files, to be copied before customisation, to destination name relative to runDir"}, {"defaultValue": "8080,18080-65535", "type": "org.apache.brooklyn.api.location.PortRange", "name": "http.port", "reconfigurable": false, "description": "HTTP port"}, {"defaultValue": "8443,18443-65535", "type": "org.apache.brooklyn.api.location.PortRange", "name": "https.port", "reconfigurable": false, "description": "HTTP port (with SSL/TLS)"}, {"defaultValue": true, "type": "java.lang.Boolean", "name": "inboundPorts.autoInfer", "reconfigurable": false, "description": "If set to false turns off the opening of ports based on naming convention, and also those that are of type PortRange in Java entities"}, {"defaultValue": ".*\\.port", "type": "java.lang.String", "name": "inboundPorts.configRegex", "reconfigurable": false, "description": "Regex governing the opening of ports based on config names"}, {"defaultValue": "${config['onbox.base.dir']!config['brooklyn.datadir']!'/<ERROR>-ONBOX_BASE_DIR-not-set'}/installs/${(config['install.unique_label']??)?string(config['install.unique_label']!'X',(entity.entityType.simpleName)+((config['install.version']??)?string('_'+(config['install.version']!'X'),'')))}", "type": "java.lang.String", "name": "install.dir", "reconfigurable": false, "description": "Directory for this software to be installed in"}, {"type": "java.lang.Boolean", "name": "install.latch", "reconfigurable": false, "description": "Latch for blocking install until ready"}, {"type": "java.lang.Boolean", "name": "install.skip", "reconfigurable": false, "description": "Skip the driver install commands entirely, for pre-installed software"}, {"type": "java.lang.String", "name": "install.unique_label", "reconfigurable": false, "description": "Provides a label which uniquely identifies an installation, used in the computation of the install dir; this should include something readable, and must include a hash of all data which differentiates an installation (e.g. version, plugins, etc), but should be the same where install dirs can be shared to allow for re-use"}, {"defaultValue": "1.2.1", "type": "java.lang.String", "name": "install.version", "reconfigurable": false, "description": "Suggested version"}, {"type": "java.lang.Boolean", "name": "launch.latch", "reconfigurable": false, "description": "Latch for blocking launch until ready"}, {"defaultValue": true, "type": "java.lang.Boolean", "name": "metrics.usage.retrieve", "reconfigurable": false, "description": "Whether to retrieve the usage (e.g. performance) metrics"}, {"defaultValue": false, "type": "java.lang.Boolean", "name": "openIptables", "reconfigurable": false, "description": "Whether to open the INBOUND_PORTS via iptables rules; if true then ssh in to run iptables commands, as part of machine provisioning"}, {"type": "java.lang.String", "name": "post.customize.command", "reconfigurable": false, "description": "Command to be run after the customize method being called on the driver"}, {"type": "java.lang.String", "name": "post.install.command", "reconfigurable": false, "description": "Command to be run after the install method being called on the driver"}, {"type": "java.lang.String", "name": "post.launch.command", "reconfigurable": false, "description": "Command to be run after the launch method being called on the driver"}, {"type": "java.lang.String", "name": "pre.customize.command", "reconfigurable": false, "description": "Command to be run prior to the customize method being called on the driver"}, {"type": "java.lang.String", "name": "pre.install.command", "reconfigurable": false, "description": "Command to be run prior to the install method being called on the driver"}, {"type": "java.lang.String", "name": "pre.launch.command", "reconfigurable": false, "description": "Command to be run prior to the launch method being called on the driver"}, {"defaultValue": {}, "type": "java.util.Map", "name": "provisioning.properties", "reconfigurable": false, "description": "Custom properties to be passed in when provisioning a new machine"}, {"defaultValue": [22], "type": "java.util.Collection", "name": "requiredOpenLoginPorts", "reconfigurable": false, "description": "The port(s) to be opened, to allow login"}, {"type": "java.lang.Boolean", "name": "resources.install.latch", "reconfigurable": false, "description": "Latch for blocking install resources until ready"}, {"type": "java.lang.Boolean", "name": "resources.runtime.latch", "reconfigurable": false, "description": "Latch for blocking runtime resources until ready"}, {"defaultValue": "${config['onbox.base.dir']!config['brooklyn.datadir']!'/<ERROR>-ONBOX_BASE_DIR-not-set'}/apps/${entity.applicationId}/entities/${entity.entityType.simpleName}_${entity.id}", "type": "java.lang.String", "name": "run.dir", "reconfigurable": false, "description": "Directory for this software to be run from"}, {"type": "java.lang.Boolean", "name": "setup.latch", "reconfigurable": false, "description": "Latch for blocking setup until ready"}, {"defaultValue": {}, "type": "java.util.Map", "name": "shell.env", "reconfigurable": false, "description": "Map of environment variables to pass to the runtime shell"}, {"defaultValue": "org.apache.brooklyn.entity.software.base.SoftwareProcessDriverLifecycleEffectorTasks@5d59d69c", "type": "org.apache.brooklyn.entity.software.base.SoftwareProcessDriverLifecycleEffectorTasks", "name": "softwareProcess.lifecycleTasks", "reconfigurable": false, "description": "An object that handles lifecycle of an entity's associated machine."}, {"defaultValue": "10s", "type": "org.apache.brooklyn.util.time.Duration", "name": "softwareProcess.maxSensorRebindDelay", "reconfigurable": false, "description": "The maximum delay to apply when reconnecting sensors when rebinding to this entity. Brooklyn will wait a random amount of time, up to the value of this config key, to avoid a thundering herd problem when the entity shares its machine with several others. Set to null or to 0 to disable any delay."}, {"type": "java.lang.Boolean", "name": "start.latch", "reconfigurable": false, "description": "Latch for blocking start until ready"}, {"defaultValue": "2m", "type": "org.apache.brooklyn.util.time.Duration", "name": "start.timeout", "reconfigurable": false, "description": "Time to wait for process and for SERVICE_UP before failing (in seconds, default 2m)"}, {"defaultValue": false, "type": "java.lang.Boolean", "name": "stopIptables", "reconfigurable": false, "description": "Whether to stop iptables entirely; if true then ssh in to stop the iptables service, as part of machine provisioning"}, {"type": "java.util.Map", "name": "templates.install", "reconfigurable": false, "description": "Mapping of templates, to be filled in and copied before install, to destination name relative to installDir"}, {"type": "java.util.Map", "name": "templates.preinstall", "reconfigurable": false, "description": "Mapping of templates, to be filled in and copied before pre-install, to destination name relative to installDir"}, {"type": "java.util.Map", "name": "templates.runtime", "reconfigurable": false, "description": "Mapping of templates, to be filled in and copied before customisation, to destination name relative to runDir"}, {"defaultValue": ["http"], "type": "java.util.Set", "name": "webapp.enabledProtocols", "reconfigurable": false, "description": "List of enabled protocols (e.g. http, https)"}, {"type": "org.apache.brooklyn.entity.webapp.HttpsSslConfig", "name": "webapp.https.ssl", "reconfigurable": false, "description": "SSL Configuration for HTTPS"}], "description": "Apache CouchDB is a database that uses JSON for documents, JavaScript for MapReduce queries, and regular HTTP for an API"}]}