Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Scalr VersionParameterDescriptionTypeExample value(s)

Default value

*scalr.system.instances_connection_timeoutThe duration (in seconds) Scalr should wait before timing out when attempting to establish a connection with Scalarizr on a Scalr host.Integer44
*scalr.system.server_terminate_timeout 

The duration Scalr should wait before terminating a server that was not forcefully terminated.

This should be a relative date format usable for the PHP strtotime function.

String
"+3 minutes"
>= 5.1scalr.system.default_disable_firewall_management

Whether Scalr should, by default, disable the automated management of iptables in Scalarizr.

Users can override this setting in the Farm Designer: Advanced Tab - General.

Booleantrue, falsefalse
>= 5.1
scalr.system.scripting.default_abort_init_on_script_fail

The default for the option to fail Servers when a Blocking BeforeHostUp Script fails.

Users can override this setting in the Farm Designer: Advanced Tab - Orchestration




*
scalr.system.global_variables.format

Formatting for Scalr System Global Variables. This should be a mapping of Scalr System Global Variables names to the format that should be used for them.

The format string should be a printf format string.

Note: System GVs MUST be uppercase.

Mapping
app[:configuration] = { "scalr" => {
  "system" => {
    "global_variables" => {
      "format" => {
        "SCALR_CLOUD_SERVER_ID" => "%.15s",
      }
    }
  }
}}

or

app[:configuration] = {
"scalr" => {
"system" => {
    "global_variables" => {
      "format" => {
        "SCALR_INSTANCE_FARM_INDEX" => "%03d",
        "SCALR_EVENT_INSTANCE_FARM_INDEX" => "%03d"
      }
    }
  }
}}

{}

*scalr.aws.security_group_name

The name Scalr should use for its IP Pool Security Group.

This security group is used to allow access from Scalr to the instances it manages.

THIS IS USED FOR ALL CLOUDS, NOT ONLY FOR AWS.

String
"scalr.ip-pool"
*scalr.aws.ip_pool

The IPs that Scalr should whitelist as part of its IP Pool Security Group.

See: scalr.aws.security_group_name.

THIS IS USED FOR ALL CLOUDS, NOT ONLY FOR AWS.

Array
[]
*scalr.aws.plugins.enabled

The list of AWS Scalr plugins that should be enabled.

The only supported plugin as of Scalr 4.5 is statistics.

THIS IS USED FOR ALL CLOUDS, NOT ONLY FOR AWS.

Array
[]
*scalr.aws.plugins.statistics.storage_max_size

The maximum storage size (in bytes) that should be allocated for statistics collected by the AWS statistics plugin.

THIS IS USED FOR ALL CLOUDS, NOT ONLY FOR AWS.

Integer
268435456
*scalr.openstack.user_data_method

The method Scalr should use to communicate user data (including Scalarizr connection details) to OpenStack instances.

String"meta-data" = Use Metadata API
"personality = Server Personalities
"both" = Use both
 
"both"
>=6.0.1scalr.openstack.use_config_driveEnable or Disable Config Drive for OpenstackBooleantrue, falsetrue
*
scalr.connections.mysql.driver

The driver Scalr should use to connect to MySQL.

This driver should be compatible for use in a data source name for ADOdb.

String
"mysqli"
*
scalr.connections.mysql.host
The host for the MySQL server Scalr should use.String
"127.0.0.1"
*
scalr.connections.mysql.port
The port for the MySQL server Scalr should use.Integerany TCP port

3306

*
scalr.connections.mysql.name
The name of the MySQL database Scalr should use.String
"scalr"
*
scalr.connections.mysql.user

The username Scalr should use to authenticate to MySQL.

String
"scalr"
*
scalr.connections.mysql.pass
The password Scalr should use to authenticate to MySQL.String"s3cur3pa55w0rd"
*scalr.email.addressThe Email Address Scalr should use for outbound email notifications.String"email@example.com"
*scalr.email.nameThe From Name Scalr should use for outbound email notifications.String"My Name"
*scalr.email.delimiter

The line delimiter Scalr should use for outound email notifications.

Use crlf for Windows-style line-endings, and lf for UNIX-style line-endings.

String
"crlf"
*scalr.endpoint.scheme

The protocol the Scalarizr agent should use to connect to the Scalr host.

Use http for the HTTP Protocol, and https for the HTTPS protocol.

String
"http"
*scalr.endpoint.host

The host the Scalarizr agent should connect to to reach the Scalr host. This should be the IP or hostname for the Scalr host.

Ensure this host is accessible by Scalarizr-managed hosts. Failing to do will result in a non-functional Scalr installation.

String
"my.scalr.com"
>=7.6.0scalr.gce.instance_usernameOptionally configure a custom username for GCE instancesString'cloud-user'"scalr'
*scalr.instances_connection_policy

The IP that Scalr should use when connecting to the Scalarizr agent on managed instances.

String"public" = Use public IP
"local" = Use private IP
"auto" = Use public IP with fallback to private IP 
"auto"
>= 5.1

scalr.<cloud>.instances_connection_policy

View valid values for <cloud> in: API Constants.

Controls the instances connection policy on a per-cloud basis.


*scalr.script.timeout.syncThe default timeout (in seconds) Scalr should use for blocking scripts.Integer
180
*scalr.script.timeout.asyncThe default timeout (in seconds) Scalr should use for non-blocking scripts.Integer
1200
>= 5.0scalr.ui.server_display_convention

The Server identifier Scalr should use in the UI (e.g. in the Script Execute Menu).

String"auto" = Use external IP, fallback to internal IP
"hostname" = Use hostname
"public" = Use external IP
"private" = Use internal IP 
"auto"
>=5.11.12scalr.ui.login_warning
Warning text to be displayed to users on the login page.  Formatted with HTML tags.String"You are accessing a secure system.  <p>Unauthorized use may result in disciplinary action.</p> By using this information system, you understand and consent to the following: <ul><li>You have no expectation of privacy on this system. </li> <li>At any time we may monitor data transiting or stored on this system.</li></ul>
*scalr.ui.support_urlThe URL the support button should link to in Scalr.String
"https://groups.google.com/d/forum/scalr-discuss"
*scalr.ui.wiki_urlThe URL the documentation button should link to in Scalr.String
"http://wiki.scalr.com"
*scalr.ui.recaptcha.public_keyThe public key Scalr should use for reCAPTCHA login bruteforce protection.String

*scalr.ui.recaptcha.private_key
The private key Scalr should use for reCAPTCHA login bruteforce protection.String

*scalr.ui.mindterm_enabledWhether server login through MindTerm should be enabled.Booleantrue, falsetrue
>= 5.0scalr.scalarizr_update.mode

The update mode for Scalairzr.

client uses update.scalr.net for Scalarizr to discover new updates.

solo uses a Scalr cronjob to notify Scalarizr of new updates.

Choices
"solo"
>= 5.0scalr.scalarizr_update.default_repo

The default repository to use for Scalarizr. Repositories must be defined as sub-keys of the key scalr.scalarizr_update.repos.

The default repository must exist in the repos list.

String

>=6.1.2 , Agent >= 4.9.4scalr.scalarizr_update.ssl_verify_peerThe default setting for ssl_verify_peerBooleantrue, falsetrue
>= 5.0scalr.scalarizr_update.repos.[repo_name].deb_repo_urlThe URL for this repository's Debian Scalarizr packages.String

>= 5.0scalr.scalarizr_update.repos.[repo_name].rpm_repo_urlThe URL for this repository's RPM Scalarizr packages.String

>= 5.0scalr.scalarizr_update.repos.[repo_name].win_repo_urlThe URL for this repository's Windows Scalarizr packages.String

>= 5.11.4scalr.security.user.session.timeoutScalr UI will be locked if a user has been inactive for the defined period of time.String
"+30 minutes"
>= 5.11.4scalr.security.user.session.lifetimeSession will expire after this time, regardless of activity.String
"+8 hours"
>= 5.11.4scalr.security.user.session.cookie_lifetimeIf user chooses to "remember me" upon login, the session cookie will be kept this long.String
"+30 days"
>= 5.10.17scalr.security.user.suspension.inactivity_daysSuspend user accounts that have not been used for this number of days. (0=disable)Integer
0
>= 5.10.17scalr.security.user.suspension.failed_login_attemptsUser account will be suspended after this number of failed login attempts. (0=disable)Integer
10
>= 5.11.12scalr.%PLATFORM%.action_on_missing_serverDefines what action should be taken if the cloud API reports a server missing compared to what's in the Scalr Database. Substitute %PLATFORM% with one of the following values: [hpcloud, mirantis, azure, ec2, openstack, cloudstack, idcf, gce, ocs, rackspacenguk, rackspacengus, cisco]String"terminate" = Terminate instance
"flag" = Mark as missing
"ignore" = Ignore
"terminate"
>= 7.3.0scalr.%PLATFORM%.action_on_failed_serverDefines what action should be taken if the cloud API reports a server as failed compared to what's in the Scalr Database. Substitute %PLATFORM% with one of the following values: [hpcloud, mirantis, azure, ec2, openstack, cloudstack, idcf, gce, ocs, rackspacenguk, rackspacengus, cisco]String

"terminate" = Terminate instance

"alert" = Same as Ignore, but will later support additional alerts in the UI

"ignore" = Ignore

"terminate"

scalr.system.api.enabledDefines if the APIv2 should be enabled or not.Booleantrue, falsetrue

>=7.2.0

scalr.system.api.oauth.enabled
Set to true to enable oauth.Booleantrue, false
>=6.1.2scalr.system.api.disable_v1Set to true to disable APIv1Booleantrue, falsefalse
>= 5.11.13scalr.system.api.allowed_originsDefines which domain(s) to allow in the Access-Control-Allow-Origin header. This header is not sent by default.Array or String["domain1.com", "domain2.com"] or "*"

disabled


scalr.allowed_cloudsList of Cloud Platforms that are available in this Scalr installation.Array["hpcloud", "mirantis", "azure", "ec2", "openstack", "cloudstack", "idcf", "gce", "ocs", "rackspacenguk", "rackspacengus", "cisco"]["hpcloud", "mirantis", "azure", "ec2", "openstack", "cloudstack", "idcf", "gce", "ocs", "rackspacenguk", "rackspacengus", "cisco"]
>=7.5.3
scalr.license_manager.use_proxy
Sets the License manager to use proxyBooloeanBooleantrue, falsefalse
>=7.6.X
scalr.license_manager.ssl_verify
Sets the License manager to verify sslBooleantrue, falsetrue