Configuration
Below you will find a list of available options and their appropriate defaults for the Blur Console component. All options can be set in the blur-site.properties file.
Base Settings
Property | Default | Description |
---|---|---|
blur.console.port | 8080 | The port that the embedded Jetty server will run on when started. |
blur.console.authentication.provider | org.apache.blur.console.providers.AllAuthenticated | The class name that will implement the IAuthenticationProvider interface and provide security to the tool. |
blur.console.authorization.provider | org.apache.blur.console.providers.EmptyAuthorization | The class name that will implement the IAuthorizationProvider interface and provide authorization to the data. |
blur.console.authentication.roles.admin | admin | Used to aide in the mapping of custom provider roles to console roles. This maps the administrator role. |
blur.console.authentication.roles.searcher | searcher | Used to aide in the mapping of custom provider roles to console roles. This maps the searcher role. |
blur.console.authentication.roles.manager | manager | Used to aide in the mapping of custom provider roles to console roles. This maps the manager role. |
blur.console.refreshtime | 5000 | Time to indicate how long calls to Blur should be cached (in milliseconds). |
blur.console.ssl.enabled | false | Whether to enable ssl directly in the console. |
blur.console.ssl.hostname.match | true | Indicates if the hostname should match an incoming certificate. |
blur.console.ssl.keystore.path | The path to a keystore for ssl. | |
blur.console.ssl.keystore.password | The password to the keystore (used with blur.console.ssl.keystore.path). | |
blur.console.ssl.truststore.path | The path to a truststore for ssl. | |
blur.console.ssl.truststore.password | The password to the truststore (used with blur.console.ssl.truststore.path). |
Included Security Provider Settings
Provider | Property | Description |
---|---|---|
org.apache.blur.console.providers.TomcatUsers | blur.console.authentication.provider.tomcat.usersfile | The location of the file containing the users, passwords, and roles. |
org.apache.blur.console.providers.GlobalJsonAuthorization | blur.console.authorization.provider.globaljson.file | The location of the file containing the access control to the data for various "users" that can be used during searching. |
Security
Blur Console itself provides some hooks and default implementations to allow for authentication and authorization to both the tool as well as the data.
Authentication Provider
The Authentication Provider (interface org.apache.blur.console.providers.IAuthenticationProvider) provides the ability to lock down the console tool to privileged users. The interface allows for logging in, retrieving a User, and providing roles for that user that give access to functionality within the tool.
Authorization Provider
The Authorization Provider (interface org.apache.blur.console.providers.IAuthorizationProvider) provides the ability to apply Blur level access control to the users of the console.
Roles
Role | Description |
---|---|
admin | Grants permission to ALL functionality of the console. |
manager | Grants permission to Read, Search, and perform destructive actions (i.e. Disable/Delete tables). |
searcher | Grants permission to Read and Search |
Available Implementations
Provider | Interface | Description |
---|---|---|
org.apache.blur.console.providers.AllAuthenticated | IAuthenticationProvider | Allows anyone to access all functionality of the console. Bypasses user login. |
org.apache.blur.console.providers.EmptyAuthorization | IAuthorizationProvider | This provider does not set up any attributes for Blur security for the users of the console. |
org.apache.blur.console.providers.GlobalJsonAuthorization | IAuthorizationProvider |
Provides a list of users and their security attributes defined in a JSON file. These users can be selected from the search screen and will have their access applied during searching.
"user1":{
|
org.apache.blur.console.providers.TomcatUsers | IAuthenticationProvider | Provides a list of users, roles, and passwords in an xml file. The format of this file is identical to a tomcat-users file. |
Dev Mode
To try the console without having a full Blur Cluster setup you can add --dev to the arguments when starting the console. This will run a MiniCluster in the process and attach to it. In order to access the running MiniCluster you will need to grab the controller uri from the Dashboard and access through the shell.