Skip to content

README.md

Latest commit

 

History

History
106 lines (79 loc) · 5.83 KB

README.md

File metadata and controls

106 lines (79 loc) · 5.83 KB

Configuration

The following section describes different configuration files used in cloudify-stage.

Core configuration (config.json)

  • maintenancePollingInterval - integer, time interval for Manager status polling (milliseconds)

  • github - object, configuration for accessing GitHub resources

    • username - string, GitHub username secret name, eg. "secret(github-username)"
    • password - string, GitHub password secret name, eg. "secret(github-password)"

  • source - object, configuration for files handling

    • browseSourcesDir - string, directory name used to store blueprint source files
    • lookupYamlsDir - string, directory name used to store YAML files

  • widgets - object, configuration for widgets handling

    • ignoreFolders - array of strings, list of directories to be ignored when importing widgets
    • tempDir - string, directory name used to store widgets temporary files
    • requiredFiles - array of strings, list of filenames required to properly load widget
    • backendFilename - string, name of the file containing widget backend inside widget directory (excluding file extension)
    • backendFilenameExtensions - array of strings, list of supported extensions for backend file

  • ssl - object, configuration for SSL connection

    • ca - string, absolute path to SSL CA certificate

Application (app.json)

This file is meant to be updated by manager installer - it is not going to be installed in case of upgrade or patch.

  • backend - object, Stage backend configuration details
    • host - string, backend host
    • port - number, backend port
  • db - object, Stage PostgreSQL DB connection configuration
    • url - string or array, DB URL or array of DB URLs

DB Options (db.options.json)

DB connection options passed to Sequelize constructor.

Logging (logging.json)

  • logsFile - string, logs file path
  • errorsFile - string, errors file path
  • logLevelConf - string, path to Manager log levels configuration file, or blank string if not applicable
  • serviceName - string, service name to look for when reading file specified by logLevelConf
  • logLevel - string, default log level used when logLevelConf is not set, file defined by logLevelConf does not exist, or the file exists but contains no entry for cloudify-stage service

Manager (manager.json)

This file is meant to be updated by manager installer - it is not going to be installed in case of upgrade or patch.

  • ip - string, Manager IP
  • apiVersion - string, Manager REST API version, eg. "v3.1"
  • protocol - string, Manager REST API protocol type, "http" or "https"
  • port - string, Manager REST API port number

User (userConfig.json)

This configuration can be overridden by: /dist/userData/userConfig.json.

  • maps - object, LeafletJS map configuration, see Leaflet-providers preview for allowed Tiles URL templates and Attribution values

    • tilesUrlTemplate - string, template map tiles provider URL, check URL template section at TileLayer page for details
    • attribution - string, attribution data to be displayed as small text box on a map, HTML allowed, it is required by map providers, check Leaflet-providers preview for examples and requirements from different providers
    • accessToken - string, API key to be passed to map tile tiles provider

  • proxy - object, configuration of Stage Backend proxy to Manager

    • timeouts
      • get - integer, GET request timeout (milliseconds)
      • post - integer, POST request timeout (milliseconds)
      • put - integer, PUT request timeout (milliseconds)
      • delete - integer, DELETE request timeout (milliseconds)
    • maxBodySize - string, maximum body size to handle (number + unit, see https://www.npmjs.com/package/bytes)

  • auth - object, authentication configuration

    • type - string, valid values for different authentication types: "local" - local (default), "saml" - SAML, "saas" - SaaS
    • certPath - string, SAML certificate path (relevant only when type is set to "saml")
    • loginPageUrl - string, login page URL (both - absolute and relative URLs are supported)
    • afterLogoutUrl - string, URL to redirect to after logout (both - absolute and relative URLs are supported)

  • whiteLabel - object, UI white-labelling configuration

    • logoUrl - string, relative URL to logo image
    • mainColor - string, main color (CSS color)
    • headerTextColor - string, color of text in page header (CSS color)
    • showVersionDetails - boolean, if set to true, then version and license label will be shown in page header
    • showFirstLoginHint - boolean, if set to true, then default credentials hint will be shown on first login
    • loginPageHeaderColor - string, login page header color (CSS color)
    • loginPageTextColor - string, login page text under header color (CSS color)
    • sidebarColor - string, menu sidebar color (CSS color)
    • sidebarTextColor - string, menu sidebar text color (CSS color)
    • sidebarHoverActiveColor - string, menu sidebar color (CSS color) for active and hovered items
    • sidebarHoverActiveTextColor - string, menu sidebar text color (CSS color) for active and hovered items
    • customCssPath - string, relative path to custom CSS file

  • widgets - object, widget configuration exposed to user

    • allowedModules - array of strings, list of modules allowed to be required from widget backend

Development (me.json)

This file is optional, used only in development environment.

  • app - object, overrides for Core, Application and Logging configurations
  • manager - object, overrides for Manager configuration