Rudder

The list of attributes on which we currently look

  //common
  final case object Name             extends QSAttribute { override val name = "displayName" }
  final case object Description      extends QSAttribute { override val name = "description" }
  final case object ShortDescription extends QSAttribute { override val name = "shortDescription" }
  final case object LongDescription  extends QSAttribute { override val name = "longDescription" }
  final case object IsEnabled        extends QSAttribute { override val name = "isEnabled" }

  //Nodes
  final case object NodeId          extends QSAttribute { override val name = "id" }
  final case object Fqdn            extends QSAttribute { override val name = "hostname" }
  final case object OsType          extends QSAttribute { override val name = "os.type" }
  final case object OsName          extends QSAttribute { override val name = "os.name" }
  final case object OsVersion       extends QSAttribute { override val name = "os.version" }
  final case object OsFullName      extends QSAttribute { override val name = "os.fullName" }
  final case object OsKernelVersion extends QSAttribute { override val name = "os.kernelVersion" }
  final case object OsServicePack   extends QSAttribute { override val name = "os.servicePack" }
  final case object Arch            extends QSAttribute { override val name = "architectureDescription" }
  final case object Ram             extends QSAttribute { override val name = "ram" }
  final case object IpAddresses     extends QSAttribute { override val name = "ipAddresses" }
  final case object PolicyServerId  extends QSAttribute { override val name = "policyServerId" }
  final case object Properties      extends QSAttribute { override val name = "properties" }
  final case object RudderRoles     extends QSAttribute { override val name = "rudderRoles" }

  //Groups
  final case object GroupId   extends QSAttribute { override val name = "id" }
  final case object IsDynamic extends QSAttribute { override val name = "isDynamic" }

  //Directives
  final case object DirectiveId       extends QSAttribute { override val name = "id" }
  final case object DirectiveVarName  extends QSAttribute { override val name = "var.name" }
  final case object DirectiveVarValue extends QSAttribute { override val name = "var.value" }
  final case object TechniqueName     extends QSAttribute { override val name = "techniqueName" }
  final case object TechniqueVersion  extends QSAttribute { override val name = "techniqueVersion" }

  //Parameters
  final case object ParameterName  extends QSAttribute { override val name = "id" }
  final case object ParameterValue extends QSAttribute { override val name = "value" }

  //Rules
  final case object RuleId       extends QSAttribute { override val name = "id" }
  final case object DirectiveIds extends QSAttribute { override val name = "directives" }
  final case object Targets      extends QSAttribute { override val name = "targets" }

With their aliases:

    val attributeNames = QSAttribute.all.map { a => a match {
      case Name              => (a, Set(Name.name, "name") )
      case Description       => (a, descriptions)
      case ShortDescription  => (a, descriptions)
      case LongDescription   => (a, descriptions)
      case IsEnabled         => (a, Set(IsEnabled.name, "enabled") )
      case NodeId            => (a, Set(NodeId.name, "nodeid") )
      case Fqdn              => (a, Set(Fqdn.name, "hostname") )
      case OsType            => (a, Set(OsType.name, "ostype", "os"))
      case OsName            => (a, Set(OsName.name, "osname", "os") ) //not also full name because osFullname contains osName, not the reverse
      case OsVersion         => (a, Set(OsVersion.name, "osversion", "os") )
      case OsFullName        => (a, Set(OsFullName.name, "osfullname", OsName.name, "osname", "os") )
      case OsKernelVersion   => (a, Set(OsKernelVersion.name, "oskernelversion", "oskernel", "kernel", "version", "os") )
      case OsServicePack     => (a, Set(OsServicePack.name, "osservicepack", "ossp", "sp", "servicepack", "os") )
      case Arch              => (a, Set(Arch.name, "architecture", "arch") )
      case Ram               => (a, Set(Ram.name, "memory") )
      case IpAddresses       => (a, Set(IpAddresses.name, "ip", "ips", "networkips") )
      case PolicyServerId    => (a, Set(PolicyServerId.name, "policyserver") )
      case Properties        => (a, Set(Properties.name, "node.props", "nodeprops", "node.properties", "nodeproperties") )
      case RudderRoles       => (a, Set(RudderRoles.name, "serverrole", "serverroles", "role", "roles") )
      case GroupId           => (a, Set(GroupId.name, "groupid") )
      case IsDynamic         => (a, Set(IsDynamic.name, "isdynamic") )
      case DirectiveId       => (a, Set(DirectiveId.name, "directiveid") )
      case DirectiveVarName  => (a, Set(DirectiveVarName.name, "directivevar", "parameter", "parameters", "variable", "variables") )
      case DirectiveVarValue => (a, Set(DirectiveVarValue.name,"directivevalue", "parameter", "parameters", "variable", "variables") )
      case TechniqueName     => (a, Set(TechniqueName.name, "technique", "techniqueid") )
      case TechniqueVersion  => (a, Set(TechniqueVersion.name, "technique", "techniqueid", "version") )
      case ParameterName     => (a, Set(ParameterName.name, "parametername", "paramname", "name", "parameter", "param") )
      case ParameterValue    => (a, Set(ParameterValue.name, "parametervalue", "paramvalue", "value", "parameter", "param") )
      case RuleId            => (a, Set(RuleId.name, "ruleid") )
      case DirectiveIds      => (a, Set(DirectiveIds.name, "directiveids", "id", "ids") )
      case Targets           => (a, Set(Targets.name, "target", "group", "groups") )
    } } 

<pre>

i'd really like to keep this simple. Object is clearly not an intuitive name for a "normal" user.
we could mimic the google search system : https://www.google.com/advanced_search

so, rather than object, we could use "in" :

security policy in:directives

oracle in:nodes

security policy in:directivesdescription

what do you think ?

Nicolas CHARLES wrote:

we could mimic the google search system : https://www.google.com/advanced_search
what do you think ?

it sounds very promising!

François ARMAND wrote:

The list of attributes on which we currently look

 case Fqdn              => (a, Set(Fqdn.name, "hostname") ) 

Could you also add fqdn for FQDN ? :)

For me, on a single input text box you write only keyword. And search engine automatically says find on node or directive or rule. Please not include langage tag on this search. Simple is better. If i want complex search engine i'm going to a form with more input.

Regards

Maybe if it could be enabled/disabled as a feature? Not sure currently there is such a thing as user profile settings, where one could enable/disable this on a per-user basis, but a global checkbox would also be nice if not everyone want so use such a feature...

Nicolas CHARLES wrote:

i'd really like to keep this simple. Object is clearly not an intuitive name for a "normal" user.
we could mimic the google search system : https://www.google.com/advanced_search

so, rather than object, we could use "in" :
[...]
with node being node or nodes; directive being directive or directive (so always accept singular and plural); and for a specific attribute we could concatenate it (with nothing, with _, with -,etc)

what do you think ?

I like the "in" for object, but not that much the concatenation idea. Because if I want to look in all description (because I need to change a business word to another, for ex. I need to remove a client name), it will be cumbersome. But having a mighy "in", sufficiently smart to know what is an object and what is an attibute by itself allows:

security policy in:directives

oracle in:nodes

security policy in:directives,description

security policy in:descriptions

Janos Mattyasovszky wrote:

François ARMAND wrote:

The list of attributes on which we currently look

[...]

Could you also add fqdn for FQDN ? :)

Ah, that was the intent :) Good catch :)

Janos Mattyasovszky wrote:

Maybe if it could be enabled/disabled as a feature? Not sure currently there is such a thing as user profile settings, where one could enable/disable this on a per-user basis, but a global checkbox would also be nice if not everyone want so use such a feature...

We don't have user profile, but the new search bar is behind a feature switch, i.e a configuration checkbox in administration -> settings screen, saying something like "do you want to enable the new search?". Default is to keep the current bar for existing version, and use the new bar by default for next major Rudder version.

Maxime Longuet wrote:

For me, on a single input text box you write only keyword. And search engine automatically says find on node or directive or rule. Please not include langage tag on this search. Simple is better. If i want complex search engine i'm going to a form with more input.

It is the actual behavior. If you just write a keywords, it's search everywhere. The tags are here to help filter results. A typical use case is when you want to search on directive parameter something quite common elsewhere, like "root" which happens to be the Rudder server id (and it is everywhere: in groups, system directive names and values, rules, as policy server id of a lot of nodes, etc etc). So to limit the noise, you can specify that you only want to look at some place.

PR updated to add "fqdn" alias to "hostname" and change the filter mode into "in:directives,name,descriptions" mode.

Work in progess here: https://github.com/VinceMacBuche/rudder/commit/46580ed1ad1ad14d215db22f4c806c7253cf4ba5

Work in progess here: https://github.com/VinceMacBuche/rudder/commit/ef2d32676edb8e018a848f03973149b77a1869b8