Rulebase Repository Management in Hawk Console

The Hawk Console contains a rulebase repository that stores configuration objects and then distributes and deploys them to Hawk agents. The configuration objects include rulebases, schedules, and rulebase map. You can create new objects or update existing objects in the repository. Hawk Console deploys the configuration objects from the repository to Hawk agents when they start.

Rulebase Mapping

A rulebase mapping defines a mapping between rulebases and Hawk agents. The Hawk Console deploys the mapped rulebases to the Hawk agent during start. The mapping can be between a rulebase and Hawk agent, or between a rulebase and a group of Hawk agents. You can create a rulebase mapping by using the Hawk Console.

For details about creating a rulebase mapping, see Creating Rulebase Mapping.

Agent Groups

The Hawk agents that have similar rulebase needs are grouped together in an agent group. The agent groups are of two types: system-defined and user-defined.

System-defined groups
Hawk Container Edition automatically creates the following agent groups:
  • Operating system group - Hawk Container Edition groups Hawk agents based on their operating system. The name of agent groups starts with "++" symbol followed by the operating system name. For example, all the Hawk agent running on the Solaris operating system are part of the ++Solaris group.
  • All group - Hawk Container Edition groups all registered Hawk agents into one group. The name of the agent group is ++.
User-defined groups
You can group any Hawk agent into a group. The name of the group starts with the '+' symbol.

For details about creating an agent group, see Creating Agent Groups.

Rulebases and Schedules

In the rulebase repository, rulebase and schedule in a rulebase repository works in the same way as they work in Hawk agents. For details about rulebases and schedules in Hawk Console, see TIBCO Hawk Console User's Guide in TIBCO Hawk documentation.

You can also use existing rulebases and schedules from Hawk agents and store them in a rulebase repository. For details, see Migrating Rulebases and Schedules from Hawk Agent to Rulebase Repository.

Also, for details about the effect of actions performed on rulebases and schedules in the rulebase repository, see Actions on Rulebase Repository Configuration Objects.

Rulebase Repository Configuration

You must configure the repository in the Hawk Console by using the hawk_console_repository_path environment variable. It specifies the path of repository inside the hawk_console container. Hawk Console loads and saves the configuration objects in the repository at <hawk_console_repository_path>/<domain_name>.

Note: The hkce_console container hosts the rulebase repository and removing the container results in loss of configuration object of the repository. To avoid this, you must use the Docker volume to persist the rulebase repository. Also, you must set the hawk_console_repository_path environment variable to destination of the Docker volume in the hkce_console container.

Rulebase Repository Actions

Hawk Console updates the configuration objects based on the action performed on the configuration objects.

For details about the effect of actions performed in repository, see Actions on Rulebase Repository Configuration Objects.

  • Creating Agent Groups
    The Hawk agents that have similar rulebase needs are grouped together in an agent group. You can create an agent group by using the Hawk Console.
  • Creating Rulebase Mapping
    A rulebase mapping defines a mapping between rulebases and Hawk agents. You can create a rulebase mapping by using the Hawk Console.
  • Migrating Rulebases and Schedules from Hawk Agent to Rulebase Repository
    For the optimized use of the rulebase repository, you must migrate existing rulebases and schedules from Hawk agents to the rulebase repository. In Hawk Console, you can create a rulebase mapping for these migrated rulebases. Based on these rulebase mapping, the rulebase repository deploys the rulebases and schedules to Hawk agents.
  • Actions on Rulebase Repository Configuration Objects
    Hawk Console contains a rulebase repository that stores configuration objects and then distributes and deploys them to Hawk agents. The configuration objects include rulebases, schedules, and rulebase map.