... | @@ -103,23 +103,47 @@ Stork fully supports IPv6 from the day one. Add another machine called `agent-ke |
... | @@ -103,23 +103,47 @@ Stork fully supports IPv6 from the day one. Add another machine called `agent-ke |
|
|
|
|
|
Stork lets you view and search through the subnets and pools. Go to `DHCP` and then `Subnets`. You will see all the subnets with pools in them. You can filter the subnets by type (any, DHCPv4 or DHCPv6). You can also type any string. For example, to limit the subnet to 192.0.3.0, you can search for `0.3`. Note that strings shorter than 4 characters require you to confirm with Enter (strings of 4 chars or longer does not require that). You can search for specific subnets, pools or pool boundaries.
|
|
Stork lets you view and search through the subnets and pools. Go to `DHCP` and then `Subnets`. You will see all the subnets with pools in them. You can filter the subnets by type (any, DHCPv4 or DHCPv6). You can also type any string. For example, to limit the subnet to 192.0.3.0, you can search for `0.3`. Note that strings shorter than 4 characters require you to confirm with Enter (strings of 4 chars or longer does not require that). You can search for specific subnets, pools or pool boundaries.
|
|
|
|
|
|
11. **Host reservations on monitored machines**
|
|
11. **Shared networks**.
|
|
|
|
|
|
|
|
Grouping subnets into shared networks is a very popular feature in Kea and other DHCP servers. Stork supports this ability by showing networks. You can go to `DHCP` -> `Shared networks`. It offers the same filtering mechanism as subnets.
|
|
|
|
|
|
|
|
12. **Host reservations on monitored machines**
|
|
|
|
|
|
After adding `agent-kea` machine all host reservations configured on the Kea app running on this machine will be fetched into Stork can be presented in the UI. Navigate to `DHCP` and then `Host Reservations`. All host reservations detected on the monitored machines will be listed, including the DHCP identifiers, reserved IP addresses and the subnets that each reservation belongs to. Finally, the last column comprises the list of servers that the particular host reservation is configured on.
|
|
After adding `agent-kea` machine all host reservations configured on the Kea app running on this machine will be fetched into Stork can be presented in the UI. Navigate to `DHCP` and then `Host Reservations`. All host reservations detected on the monitored machines will be listed, including the DHCP identifiers, reserved IP addresses and the subnets that each reservation belongs to. Finally, the last column comprises the list of servers that the particular host reservation is configured on.
|
|
|
|
|
|
The filtering box placed above the list of host reservations can be used to search hosts by DHCP identifier types, DHCP identifier values and/or reserved IP addresses. Just type a part of the searched phrase and the list of reservations will be adjusted to display only those matching the filtering text. For example, typing `clien` should result in displaying only those reservations which DHCP identifier type is `client-id`.
|
|
The filtering box placed above the list of host reservations can be used to search hosts by DHCP identifier types, DHCP identifier values and/or reserved IP addresses. Just type a part of the searched phrase and the list of reservations will be adjusted to display only those matching the filtering text. For example, typing `clien` should result in displaying only those reservations which DHCP identifier type is `client-id`.
|
|
|
|
|
|
12. **Host reservations within Kea host backends**
|
|
13. **Host reservations within Kea host backends**
|
|
|
|
|
|
The reservations observed in the previous step were only those that are specified within the Kea configuration files. Kea also supports defining host reservations within a database via `host_cmds` premium hooks library. Those reservations are available in the same view as previously. They are fetched when the Kea app is configured to use `host_cmds` hooks library. The demo setup optionally includes such machine if the demo is started with the `cs_repo_access_token` variable.
|
|
The reservations observed in the previous step were only those that are specified within the Kea configuration files. Kea also supports defining host reservations within a database via `host_cmds` premium hooks library. Those reservations are available in the same view as previously. They are fetched when the Kea app is configured to use `host_cmds` hooks library. The demo setup optionally includes such machine if the demo is started with the `cs_repo_access_token` variable.
|
|
|
|
|
|
In order to see the reservations stored in the host database on this machine, start monitoring this machine by adding it to Stork. The machine name is `agent-kea-hosts`. Stork is currently configured to fetch and refresh the reservations from the hosts backend at the 60 seconds interval. Thus, you may need to wait a little while before the host reservations appear on the list. If the fetch is successful, you should observe new IPv4 reservations starting with IP address of 192.0.2.200 and higher.
|
|
In order to see the reservations stored in the host database on this machine, start monitoring this machine by adding it to Stork. The machine name is `agent-kea-hosts`. Stork is currently configured to fetch and refresh the reservations from the hosts backend at the 60 seconds interval. Thus, you may need to wait a little while before the host reservations appear on the list. If the fetch is successful, you should observe new IPv4 reservations starting with IP address of 192.0.2.200 and higher.
|
|
|
|
|
|
13. **DNS traffic**.
|
|
14. **DHCP Dashboard**.
|
|
|
|
|
|
Open a new tab in your browser and connect to the Stork Environment Simulator on http://localhost:5000 (if running locally) or http://stork.lab.isc.org:5000 to take a look at the DNS traffic generator. This is not part of the Stork itself, it's a tool we developed to simulate some traffic. It retrieves the DNS servers known by stork and enables to generate traffic to it. You can send a simple query with `Dig` or start a query stream with the `Start` button. This is quite basic and may be extended in the future with the option to query different names, replay a pcap, and emulate different clients. Go ahead and experiment. Once you got some traffic, go to Grafana and see the BIND dashboard.
|
|
One of easily missed features of Stork is its dashboard. Make sure you click on the Stork logo (or the Stork name next to it). Since 0.10, there is also an explicit link in the DHCP menu. This is a high level overview of all the things being currently monitored. If you followed the demo, you should see something similar to this:
|
|
|
|
|
|
|
|
![dashboard](uploads/2edf278e2c20f5558c230551e0764c2c/dashboard.png)
|
|
|
|
|
|
14. **Pool utilization**.
|
|
The list of subnets shows top 5 subnets with highest pool utilization. There's a list of events on the right hand side. If you configured Grafana, you will see links to Grafana to inspect historic values for subnets and how they changed over time.
|
|
|
|
|
|
|
|
15. **Grafana**
|
|
|
|
|
|
|
|
An early Grafana integration was introduced in 0.5. In 0.9, you can go to `Configuration` and `Settings` and set up the link to your Grafana. In case of demo, type in `http://localhost:3000` (if running the demo locally) or `http://stork.lab.isc.org:3000` (if using on stork.lab). Go to http://localhost:3000 or http://stork.lab.isc.org:3000 and log in using admin/admin credentials. Please don't change the password, so the next person viewing the demo can take a look, too.
|
|
|
|
|
|
|
|
There are two dashboards. One for Kea and another one for BIND 9.
|
|
|
|
|
|
|
|
**Kea**
|
|
|
|
|
|
|
|
Click on Home and then Stork Kea DHCPv4 dashboard. You have plenty of statistics being shown here. Make sure to use the traffic generator, otherwise you'll see boring zeros all the time. Note the pool utilization with two thresholds (80% and 90%) set up.
|
|
|
|
|
|
|
|
**BIND 9**
|
|
|
|
|
|
|
|
We're currently using third party exporter together with a Stork embedded exporter. If you don't see the BIND dashboard, you need to add it yourself. This is a limitation of 0.6 that will be improved in 0.7. You need to get the BIND dashboard (a single JSON file) from here: https://gitlab.isc.org/isc-projects/stork/-/tree/master/grafana. Go to Grafana homepage (http://stork.lab.isc.org:3000), click `Home`, then `Import dashboard`, then `Upload .json file` and upload it. Alternatively, you can paste this link `https://gitlab.isc.org/isc-projects/stork/-/raw/master/grafana/bind9-resolver.json` there.
|
|
|
|
|
|
|
|
Click on Home and then Stork Bind DNS dashboard. There are some generic statistics, as well as the Cache Hit Ratio/Hit/Miss statistics provided by Stork. More are coming in future Stork releases.
|
|
|
|
|
|
|
|
16. **DHCP address pool utilization**.
|
|
|
|
|
|
Open a new tab in your browser and connect to http://localhost:5000 (if running locally) or to http://stork.lab.isc.org:5000 to take a look at the traffic generator. This is not part of the Stork itself, it's a tool we developed to simulate actual networks. It's a bit simple, but sufficient enough to generate traffic. It retrieves list of subnets known by Stork and enables to generate traffic for each subnet. You may want to experiment with it. Things to play with it:
|
|
Open a new tab in your browser and connect to http://localhost:5000 (if running locally) or to http://stork.lab.isc.org:5000 to take a look at the traffic generator. This is not part of the Stork itself, it's a tool we developed to simulate actual networks. It's a bit simple, but sufficient enough to generate traffic. It retrieves list of subnets known by Stork and enables to generate traffic for each subnet. You may want to experiment with it. Things to play with it:
|
|
|
|
|
... | @@ -137,19 +161,11 @@ With a little bit of juggling around, you can see something like this: |
... | @@ -137,19 +161,11 @@ With a little bit of juggling around, you can see something like this: |
|
|
|
|
|
Make sure you take a look at the shared networks, too!
|
|
Make sure you take a look at the shared networks, too!
|
|
|
|
|
|
15. **Shared networks**.
|
|
17. **DNS traffic**.
|
|
|
|
|
|
Grouping subnets into shared networks is a very popular feature in Kea and other DHCP servers. Stork supports this ability by showing networks. You can go to `DHCP` -> `Shared networks`. It offers the same filtering mechanism as subnets.
|
|
Open a new tab in your browser and connect to the Stork Environment Simulator on http://localhost:5000 (if running locally) or http://stork.lab.isc.org:5000 to take a look at the DNS traffic generator. This is not part of the Stork itself, it's a tool we developed to simulate some traffic. It retrieves the DNS servers known by stork and enables to generate traffic to it. You can send a simple query with `Dig` or start a query stream with the `Start` button. This is quite basic and may be extended in the future with the option to query different names, replay a pcap, and emulate different clients. Go ahead and experiment. Once you got some traffic, go to Grafana and see the BIND dashboard.
|
|
|
|
|
|
16. **DHCP Dashboard**.
|
|
|
|
|
|
|
|
One of easily missed features of Stork is its dashboard. Make sure you click on the Stork logo (or the Stork name next to it). Since 0.10, there is also an explicit link in the DHCP menu. This is a high level overview of all the things being currently monitored. If you followed the demo, you should see something similar to this:
|
|
|
|
|
|
|
|
![dashboard](uploads/2edf278e2c20f5558c230551e0764c2c/dashboard.png)
|
|
|
|
|
|
|
|
The list of subnets shows top 5 subnets with highest pool utilization. There's a list of events on the right hand side. If you configured Grafana, you will see links to Grafana to inspect historic values for subnets and how they changed over time.
|
|
|
|
|
|
|
|
17. **Events**
|
|
18. **Events**
|
|
|
|
|
|
Stork records various events in the system. There are several places where you can observe events;
|
|
Stork records various events in the system. There are several places where you can observe events;
|
|
|
|
|
... | @@ -159,23 +175,6 @@ Stork records various events in the system. There are several places where you c |
... | @@ -159,23 +175,6 @@ Stork records various events in the system. There are several places where you c |
|
|
|
|
|
![events-viewer](uploads/11439438bb815b1f4e6a93d76177d082/events-viewer.png)
|
|
![events-viewer](uploads/11439438bb815b1f4e6a93d76177d082/events-viewer.png)
|
|
|
|
|
|
|
|
|
|
18. **Grafana**
|
|
|
|
|
|
|
|
An early Grafana integration was introduced in 0.5. In 0.9, you can go to `Configuration` and `Settings` and set up the link to your Grafana. In case of demo, type in `http://localhost:3000` (if running the demo locally) or `http://stork.lab.isc.org:3000` (if using on stork.lab). Go to http://localhost:3000 or http://stork.lab.isc.org:3000 and log in using admin/admin credentials. Please don't change the password, so the next person viewing the demo can take a look, too.
|
|
|
|
|
|
|
|
There are two dashboards. One for Kea and another one for BIND 9.
|
|
|
|
|
|
|
|
**Kea**
|
|
|
|
|
|
|
|
Click on Home and then Stork Kea DHCPv4 dashboard. You have plenty of statistics being shown here. Make sure to use the traffic generator, otherwise you'll see boring zeros all the time. Note the pool utilization with two thresholds (80% and 90%) set up.
|
|
|
|
|
|
|
|
**BIND 9**
|
|
|
|
|
|
|
|
We're currently using third party exporter together with a Stork embedded exporter. If you don't see the BIND dashboard, you need to add it yourself. This is a limitation of 0.6 that will be improved in 0.7. You need to get the BIND dashboard (a single JSON file) from here: https://gitlab.isc.org/isc-projects/stork/-/tree/master/grafana. Go to Grafana homepage (http://stork.lab.isc.org:3000), click `Home`, then `Import dashboard`, then `Upload .json file` and upload it. Alternatively, you can paste this link `https://gitlab.isc.org/isc-projects/stork/-/raw/master/grafana/bind9-resolver.json` there.
|
|
|
|
|
|
|
|
Click on Home and then Stork Bind DNS dashboard. There are some generic statistics, as well as the Cache Hit Ratio/Hit/Miss statistics provided by Stork. More are coming in future Stork releases.
|
|
|
|
|
|
|
|
19. **Other tasks**.
|
|
19. **Other tasks**.
|
|
|
|
|
|
Here's a list of smaller things you can do.
|
|
Here's a list of smaller things you can do.
|
... | | ... | |