Skip to content

Commit

Permalink
fix hedgehog images
Browse files Browse the repository at this point in the history
  • Loading branch information
mmguero committed Sep 23, 2022
1 parent c576497 commit 5758e6f
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 38 deletions.
8 changes: 4 additions & 4 deletions docs/hedgehog-boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Each time the sensor boots, a grub boot menu will be shown briefly, after which

## <a name="HedgehogKioskMode"></a>Kiosk mode

![Kiosk mode sensor menu: resource statistics](./docs/images/kiosk_mode_sensor_menu.png)
![Kiosk mode sensor menu: resource statistics](./docs/images/hedgehog/images/kiosk_mode_sensor_menu.png)

The sensor automatically logs in as the sensor user account and runs in **kiosk mode**, which is intended to show an at-a-glance view of the its resource utilization. Clicking the **** icon in allows you to switch between the resource statistics view and the services view.

![Kiosk mode sensor menu: services](./docs/images/kiosk_mode_services_menu.png)
![Kiosk mode sensor menu: services](./docs/images/hedgehog/images/kiosk_mode_services_menu.png)

The kiosk's services screen (designed with large clickable labels for small portable touch screens) can be used to start and stop essential services, get a status report of the currently running services, and clean all captured data from the sensor.

!["Clean Sensor" confirmation prompt before deleting sensor data](./docs/images/kiosk_mode_wipe_prompt.png)
!["Clean Sensor" confirmation prompt before deleting sensor data](./docs/images/hedgehog/images/kiosk_mode_wipe_prompt.png)

!["Sensor Status" report from the kiosk services menu](./docs/images/kiosk_mode_status.png)
!["Sensor Status" report from the kiosk services menu](./docs/images/hedgehog/images/kiosk_mode_status.png)
16 changes: 8 additions & 8 deletions docs/hedgehog-config-root.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,42 @@ The first step of sensor configuration is to configure the network interfaces an

You may next select whether to configure the network interfaces, hostname, or time synchronization.

![Selection to configure network interfaces, hostname, or time synchronization](./docs/images/root_config_mode.png)
![Selection to configure network interfaces, hostname, or time synchronization](./docs/images/hedgehog/images/root_config_mode.png)

Selecting **Hostname**, you will be presented with a summary of the current sensor identification information, after which you may specify a new sensor hostname. This name will be used to tag all events forwarded from this sensor in the events' **host.name** field.

![Specifying a new sensor hostname](./docs/images/hostname_setting.png)
![Specifying a new sensor hostname](./docs/images/hedgehog/images/hostname_setting.png)

## <a name="HedgehogConfigIface"></a>Interfaces

Returning to the configuration mode selection, choose **Interface**. You will be prompted if you would like help identifying network interfaces. If you select **Yes**, you will be prompted to select a network interface, after which that interface's link LED will blink for 10 seconds to help you in its identification. This network interface identification aid will continue to prompt you to identify further network interfaces until you select **No**.

You will be presented with a list of interfaces to configure as the sensor management interface. This is the interface the sensor itself will use to communicate with the network in order to, for example, forward captured logs to an aggregate server. In order to do so, the management interface must be assigned an IP address. This is generally **not** the interface used for capturing data. Select the interface to which you wish to assign an IP address. The interfaces are listed by name and MAC address and the associated link speed is also displayed if it can be determined. For interfaces without a connected network cable, generally a `-1` will be displayed instead of the interface speed.

![Management interface selection](./docs/images/select_iface.png)
![Management interface selection](./docs/images/hedgehog/images/select_iface.png)

Depending on the configuration of your network, you may now specify how the management interface will be assigned an IP address. In order to communicate with an event aggregator over the management interface, either **static** or **dhcp** must be selected.

![Interface address source](./docs/images/iface_mode.png)
![Interface address source](./docs/images/hedgehog/images/iface_mode.png)

If you select static, you will be prompted to enter the IP address, netmask, and gateway to assign to the management interface.

![Static IP configuration](./docs/images/iface_static.png)
![Static IP configuration](./docs/images/hedgehog/images/iface_static.png)

In either case, upon selecting **OK** the network interface will be brought down, configured, and brought back up, and the result of the operation will be displayed. You may choose **Quit** upon returning to the configuration tool's welcome screen.

## <a name="HedgehogConfigTime"></a>Time synchronization

Returning to the configuration mode selection, choose **Time Sync**. Here you can configure the sensor to keep its time synchronized with either an NTP server (using the NTP protocol) or a local [Malcolm](https://github.com/idaholab/Malcolm) aggregator or another HTTP/HTTPS server. On the next dialog, choose the time synchronization method you wish to configure.

![Time synchronization method](./docs/images/time_sync_mode.png)
![Time synchronization method](./docs/images/hedgehog/images/time_sync_mode.png)

If **htpdate** is selected, you will be prompted to enter the IP address or hostname and port of an HTTP/HTTPS server (for a Malcolm instance, port `9200` may be used) and the time synchronization check frequency in minutes. A test connection will be made to determine if the time can be retrieved from the server.

![*htpdate* configuration](./docs/images/htpdate_setup.png)
![*htpdate* configuration](./docs/images/hedgehog/images/htpdate_setup.png)

If *ntpdate* is selected, you will be prompted to enter the IP address or hostname of the NTP server.

![NTP configuration](./docs/images/ntp_host.png)
![NTP configuration](./docs/images/hedgehog/images/ntp_host.png)

Upon configuring time synchronization, a "Time synchronization configured successfully!" message will be displayed, after which you will be returned to the welcome screen.
Loading

0 comments on commit 5758e6f

Please sign in to comment.