Configuring forecasting and migration planning reports

Home

Configuring forecasting and migration planning reports

Important

If your cluster manager is Ambari, you must have the Ambari Metrics System (AMS) installed and running to generate these reports.
HTTPS support is available only for Unravel 4.5.1.0 and above. See Importing a private certificate into Unravel truststore.
The multi-cluster feature is supported for on-prem platforms from Unravel 4.6.2.0 onwards. However, for the Forecasting and Migration reports, you can configure only one cluster at a time and thereby generate reports for that single cluster.

The following properties are used to configure Migration planning reports:

Note

Note: As of 29 July 2019, the default is false for new installations for Unravel 4.5.3.0 and later.

Property/Description	Set by user	Unit	Default
unravel.python.reporting.cloudreport.enable Controls the generation of Migration Reports. `true`: Reports can be created. `false`: Reports cannot be created.		boolean	true (See note.)

Property/Description

Set by user

Unit

Default

unravel.python.reporting.cloudreport.enable

Controls the generation of Migration Reports.

true: Reports can be created.

false: Reports cannot be created.

boolean

true (See note.)

Note

Make sure the cluster type is set correctly, the default is CDH.

Property/Description	Set by user	Unit	Default
com.unraveldata.cluster.name Cluster to connect to if multiple options exist. Required in multi-cluster environments only. Unravel first attempts to match on the cluster ID, and then falls back to matching on the display name. For Ambari, the cluster ID and the display name are equivalent, which is the "cluster_name" attribute from the "/clusters" endpoint, for example, http://HOST:8080/api/v1/clusters/. For Cloudera Manager, the cluster ID is the "name" attribute from the "/clusters" endpoint, for example, http://HOST:7180/api/v17/clusters/.	Required	CSL	default
com.unraveldata.cluster.type Possible values are `DB`, `CDH`, `HDP`, or `MAPR`.		set member	CDH

Property/Description

Set by user

Unit

Default

com.unraveldata.cluster.name

Cluster to connect to if multiple options exist.

Required in multi-cluster environments only. Unravel first attempts to match on the cluster ID, and then falls back to matching on the display name.

For Ambari, the cluster ID and the display name are equivalent, which is the "cluster_name" attribute from the "/clusters" endpoint, for example, http://HOST:8080/api/v1/clusters/.

For Cloudera Manager, the cluster ID is the "name" attribute from the "/clusters" endpoint, for example, http://HOST:7180/api/v17/clusters/.

Required

CSL

default

com.unraveldata.cluster.type

Possible values are DB, CDH, HDP, or MAPR.

set member

CDH

Property/Description	Set by user	Unit	Default
com.unraveldata.ambari.manager.url URL of Ambari Manager, for example, https://$ambariserver:8083. It must start with http:// or https://.	Required	string	-
com.unraveldata.ambari.manager.username Ambari username. The User must have cluster operator role.	Required	string	-
com.unraveldata.ambari.manager.password Ambari password.	Required	string	-

Property/Description

Set by user

Unit

Default

com.unraveldata.ambari.manager.url

URL of Ambari Manager, for example, https://$ambariserver:8083. It must start with http:// or https://.

Required

string

com.unraveldata.ambari.manager.username

Ambari username. The User must have cluster operator role.

Required

string

com.unraveldata.ambari.manager.password

Ambari password.

Required

string

Property/Description	Set by user	Unit	Default
com.unraveldata.cloudera.manager.url URL of Cluster Manager, for example, http://$clouderaserver:port For Impala jobs to be tracked you must enter a port number.	Required	string	-
com.unraveldata.cloudera.manager.username Cloudera manager username. This user must have one of the following roles: Full Administrator, Cluster Administrator, Operator, or Configurator.	Required	string	-
com.unraveldata.cloudera.manager.password Cloudera manager password.	Required	string	-
com.unraveldata.cloudera.manager.api_version Optional and only valid for Cloudera Manager. Specifies the API version number to use, such as "17". When not set, Unravel attempts to auto discover the version within the range 16-19. Important Do not set this property if you are using Impala.	Optional	integer	-
com.unraveldata.cloudera.manager.api.version Returns the clusters managed by the Cloudera Manager (CM), when the default CM API version fails to do so. CM API version is provided by the CM via API: http\|https://`<CM_HOST>`:`<CM_PORT>`/api/version.	-	string	null

In this section:

Would you like to provide feedback? Just click here to suggest edits.

Home

Configuring forecasting and migration planning reports

Important

Note

Note

Important

Search results