A sample installation of Stork can be used to demonstrate its capabilities, and can also be used for its development.
The demo installation uses Docker and Docker Compose to set up all Stork services. It contains:
Stork Agent with Kea DHCPv4
Stork Agent with Kea DHCPv6
Stork Agent with Kea HA-1 (high availability server 1)
Stork Agent with Kea HA-2 (high availability server 2)
Stork Agent with Kea Using Many Subnets
Stork Agent with BIND 9
Stork Agent with BIND 9-2
Stork Environment Simulator
Prometheus & Grafana
These services allow observation of many Stork features.
Running the Stork demo requires the same dependencies as building Stork, which are described in the Installing From Sources chapter.
Besides the standard dependencies, the Stork demo requires:
For details, please see the Stork wiki at https://gitlab.isc.org/isc-projects/stork/-/wikis/Processes/development-Environment
6.2. Setup Steps
The following command retrieves all required software (Go, go-swagger, Node.js, Angular dependencies, etc.) to the local directory. No root password is necessary. It then prepares Docker images and starts them.
$ rake demo:up
Once the build process finishes, the Stork UI is available at http://localhost:8080/. Use any browser to connect.
stork-demo.sh script can be used to start the demo without the Ruby toolkit:
6.2.2. Detached Mode
It is possible to start the demo in detached mode. In that case, it
does not depend on the terminal and runs in the background until the
rake demo:down call. To enable the detached mode, specify the
DETACH variable set to
$ rake demo:up DETACH=true
6.3. Demo Containers
The setup procedure creates several Docker containers. Their definition
is stored in the
docker-compose.yaml file in the Stork source code repository.
These containers have Stork production services and components:
This container is essential. It runs
stork-server, which interacts with all the agents and the database and exposes the API. Without it, Stork is not able to function.
This container is essential in most circumstances. It provides the front-end web interface. It is potentially unnecessary with the custom development of a Stork API client. The content is served by Nginx.
This container is similar to the previous one, except Apache serves it, and the web UI is available under the /stork sub-directory, port 8081.
This container runs a BIND 9 server. With this container, the agent can be added as a machine and Stork will begin monitoring its BIND 9 service.
This container also runs a BIND 9 server, for the purpose of experimenting with two different DNS servers.
This container runs a Kea DHCPv4 server. With this container, the agent can be added as a machine and Stork will begin monitoring its Kea DHCPv4 service.
This container runs a Kea DHCPv6 server.
- agent-kea-ha1 and agent-kea-ha2
These two containers should, in general, be run together. They each have a Kea DHCPv4 server instance configured in an HA pair. With both instances running and registered as machines in Stork, users can observe certain HA mechanisms, such as one partner taking over the traffic if the other partner becomes unavailable.
This container runs an agent with a Kea DHCPv4 server that has many (nearly 7000) subnets defined in its configuration.
- agent-kea-premium-one and agent-kea-premium-two
These containers run agents with Kea DHCPv4 and DHCPv6 servers connected to a MySQL database containing host reservations. They are only available when premium features have been enabled during the demo build.
These are containers with third-party services that are required by Stork:
This container is essential. It runs the PostgreSQL database that is used by
stork-serverand the Kea containers. Without it,
stork-serverproduces error messages about an unavailable database.
Prometheus, a monitoring solution (https://prometheus.io/), uses this container to monitor applications. It is preconfigured to monitor the Kea and BIND 9 containers.
This is a container with Grafana (https://grafana.com/), a dashboard for Prometheus. It is preconfigured to pull data from a Prometheus container and show Stork dashboards.
This container is essential. It runs the MariaDB database that is used by the Kea containers.
There is also a supporting container:
Stork Environment Simulator is a web application that can run DHCP traffic using
perfdhcp(useful to observe non-zero statistics coming from Kea), run DNS traffic using
flamethrower(useful to observe non-zero statistics coming from BIND 9), and start and stop any service in any other container (useful to simulate, for example, a Kea crash).
Used only when the Stork Agent from container connects to a locally running server. The Kea/Bind containers use internal Docker hostnames that the host cannot resolve. We run the DNS proxy in the background that translates the Docker hostnames to valid IP addresses.
The containers running the Kea and BIND 9 applications are for demonstration purposes only. They allow users to quickly start experimenting with Stork without having to manually deploy Kea and/or BIND 9 instances.
The PostgreSQL database schema is automatically migrated to the latest
version required by the
The setup procedure assumes those images are fully under Stork’s control. Any existing images are overwritten.
stork-server requires some initial information:
Add new machines (leave the default port):
6.5. Stork Environment Simulator
The Stork Environment Simulator demonstrates how Stork:
sends DHCP traffic to Kea applications
sends DNS requests to BIND 9 applications
stops and starts Stork agents and the Kea and BIND 9 daemons
The Stork Environment Simulator allows DHCP traffic to be sent to selected subnets pre-configured in Kea instances, with a limitation: it is possible to send traffic to only one subnet from a given shared network.
The Stork Environment Simulator also allows demonstration DNS traffic to be sent selected DNS servers.
The Stork Environment Simulator can add all the machines available in the demo setup. It can stop and start selected Stork agents and the Kea and BIND 9 applications. This is useful to simulate communication problems between applications, Stork agents, and the Stork server.
The Stork Environment Simulator can be found at port 5000 when the demo is running.
The Prometheus instance is preconfigured in the Stork demo and pulls statistics from:
the node exporters:
the Kea exporters embedded in
the BIND exporters embedded in
The Prometheus web page can be found at: http://localhost:9090/ .
The Grafana instance is also preconfigured in the Stork demo. It pulls data from Prometheus and loads dashboards from the Stork repository, in the Grafana folder.
The Grafana web page can be found at: http://localhost:3000/ .