... | @@ -5,6 +5,14 @@ This page describes a self-demo that you can run on Stork. To run it you need on |
... | @@ -5,6 +5,14 @@ This page describes a self-demo that you can run on Stork. To run it you need on |
|
- access to http://stork.lab.isc.org:8080 (ISC employees only for now)
|
|
- access to http://stork.lab.isc.org:8080 (ISC employees only for now)
|
|
- an Ubuntu box (download stork, type ``rake docker_up``, connect to http://locahost:8080)
|
|
- an Ubuntu box (download stork, type ``rake docker_up``, connect to http://locahost:8080)
|
|
|
|
|
|
|
|
In addition, in order to have access to the features which require Kea premium hooks, an access token to the Kea premium repository is required. The access token can be found on the following page https://cloudsmith.io/~isc/repos/kea-1-7-prv/setup/#formats-deb which is available to ISC employees and paid ISC customers. The access token is found within the following link https://dl.cloudsmith.io/<access token>/isc/kea-1-7-prv/cfg/setup/bash.deb.sh after logging in to the Cloudsmith.
|
|
|
|
|
|
|
|
In order to start the demo with the premium Kea features run the following:
|
|
|
|
|
|
|
|
```
|
|
|
|
rake docker_up cs_repo_access_token=<access token>
|
|
|
|
```
|
|
|
|
|
|
Once Stork becomes a bit more mature, we're planning to have a public demo site. Stork documentation is available at https://stork.readthedocs.io. It may be useful during this self-guided tour.
|
|
Once Stork becomes a bit more mature, we're planning to have a public demo site. Stork documentation is available at https://stork.readthedocs.io. It may be useful during this self-guided tour.
|
|
|
|
|
|
# Existing functionality
|
|
# Existing functionality
|
... | @@ -63,11 +71,23 @@ Stork fully supports IPv6 from the day one. Add another machine called `agent-ke |
... | @@ -63,11 +71,23 @@ 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. **DNS traffic**.
|
|
11. **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 `Hosts`. 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 number 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`.
|
|
|
|
|
|
|
|
12. **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.
|
|
|
|
|
|
|
|
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**.
|
|
|
|
|
|
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 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.
|
|
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 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.
|
|
|
|
|
|
12. **Pool utilization**.
|
|
14. **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:
|
|
|
|
|
... | @@ -85,11 +105,11 @@ With a little bit of juggling around, you can see something like this: |
... | @@ -85,11 +105,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!
|
|
|
|
|
|
13. **Shared networks**.
|
|
15. **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.
|
|
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.
|
|
|
|
|
|
14. **Grafana**
|
|
16. **Grafana**
|
|
|
|
|
|
Stork 0.5 features a very early Grafana integration. 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.
|
|
Stork 0.5 features a very early Grafana integration. 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.
|
|
|
|
|
... | @@ -106,19 +126,19 @@ We're currently using third party exporter together with a Stork embedded export |
... | @@ -106,19 +126,19 @@ We're currently using third party exporter together with a Stork embedded export |
|
Click on Home and then Stork Bind DNS dashboard. You will have some generic statistics, as well as the Cache Hit statistics provided by
|
|
Click on Home and then Stork Bind DNS dashboard. You will have some generic statistics, as well as the Cache Hit statistics provided by
|
|
Stork.
|
|
Stork.
|
|
|
|
|
|
15. **You can change your own password**.
|
|
17. **You can change your own password**.
|
|
|
|
|
|
Go to `Profile` -> `Settings`.
|
|
Go to `Profile` -> `Settings`.
|
|
|
|
|
|
16. **Change other users password**.
|
|
18. **Change other users password**.
|
|
|
|
|
|
If you're a super-admin, you can change others passwords. Log in as super-admin (e.g. admin user), click on `Configuration` -> `Users` and then on the user you want to modify. Click `Edit`.
|
|
If you're a super-admin, you can change others passwords. Log in as super-admin (e.g. admin user), click on `Configuration` -> `Users` and then on the user you want to modify. Click `Edit`.
|
|
|
|
|
|
17. **You can delete machines**.
|
|
19. **You can delete machines**.
|
|
|
|
|
|
Go to `Services` -> `Machines` and pick a machine you want to have deleted. Click on the hamburger button (three horizontal lines) on the right hand and choose `Delete` from the menu. Note anything running on the machine will disappear from Stork. The actual services running won't be affected, Stork simply stopped monitoring them. You can re-add them to see that they're doing fine.
|
|
Go to `Services` -> `Machines` and pick a machine you want to have deleted. Click on the hamburger button (three horizontal lines) on the right hand and choose `Delete` from the menu. Note anything running on the machine will disappear from Stork. The actual services running won't be affected, Stork simply stopped monitoring them. You can re-add them to see that they're doing fine.
|
|
|
|
|
|
18. **Check Stork version**.
|
|
20. **Check Stork version**.
|
|
|
|
|
|
You can hover your mouse over the Stork logo. It will display some information about Stork itself (version, compilation time).
|
|
You can hover your mouse over the Stork logo. It will display some information about Stork itself (version, compilation time).
|
|
|
|
|
... | | ... | |