... | @@ -9,43 +9,43 @@ Once Stork becomes a bit more mature, we're planning to have a public demo site. |
... | @@ -9,43 +9,43 @@ Once Stork becomes a bit more mature, we're planning to have a public demo site. |
|
|
|
|
|
# Existing functionality
|
|
# Existing functionality
|
|
|
|
|
|
1. Log in using admin/admin credentials. Note the version displayed. It is not hardcoded. This is a version of the Stork server that is retrieved over REST API.
|
|
1. **Log in using admin/admin credentials**. Note the version displayed. It is not hardcoded. This is a version of the Stork server that is retrieved over REST API.
|
|
|
|
|
|
2. Check your role in the system. You logged in as admin, which is an account with super-admin role. You can check you currently assigned roles by going to `Profile` -> `Settings`.
|
|
2. **Check your role in the system**. You logged in as admin, which is an account with super-admin role. You can check you currently assigned roles by going to `Profile` -> `Settings`.
|
|
|
|
|
|
Note: as of 0.3 there are currently two roles defined: super-admin (can do everything including managing and adding new users) and admin (can do everything, except managing or adding users).
|
|
Note: as of 0.3 there are currently two roles defined: super-admin (can do everything including managing and adding new users) and admin (can do everything, except managing or adding users).
|
|
|
|
|
|
3. Add new user. Since you're logged in as super-admin, you can see the `Configuration` menu and `Users` within it. Click on it and you'll see a list of all users. Click on `Create User Account` to create a new account. It's recommended to create a new account role admin, so the new user can't create more users. Go ahead and try it.
|
|
3. **Add new user**. Since you're logged in as super-admin, you can see the `Configuration` menu and `Users` within it. Click on it and you'll see a list of all users. Click on `Create User Account` to create a new account. It's recommended to create a new account role admin, so the new user can't create more users. Go ahead and try it.
|
|
|
|
|
|
4. Add new BIND9 machine to monitor. Go to `Services`->`Machines` and click `Add New Machine`, type in `agent-bind9`.
|
|
4. **Add new BIND9 machine to monitor**. Go to `Services`->`Machines` and click `Add New Machine`, type in `agent-bind9`.
|
|
|
|
|
|
Normally you would type in an FQDN or an IP address of the machine you want to monitor. By default Stork is being deployed using Docker. There are some example docker containers that run several sample machines that run Kea, BIND9 and two Kea instances running in failover pair. agent-bind9 is a name of one of such containers. Note that you didn't specify what kind of software is running on the `agent-bind9` machine. Stork server connected to the stork agent running that and the agent looked for Kea and BIND9 and found only bind. It should detect BIND9 app running there.
|
|
Normally you would type in an FQDN or an IP address of the machine you want to monitor. By default Stork is being deployed using Docker. There are some example docker containers that run several sample machines that run Kea, BIND9 and two Kea instances running in failover pair. agent-bind9 is a name of one of such containers. Note that you didn't specify what kind of software is running on the `agent-bind9` machine. Stork server connected to the stork agent running that and the agent looked for Kea and BIND9 and found only bind. It should detect BIND9 app running there.
|
|
|
|
|
|
5. Inspect the agent-bind9 machine. Click around. As of 0.3 the BIND9 capabilities are basic. Stork is able to check if bind9 process is running and display its version. Much more coming up in 0.4.
|
|
5. **Inspect the agent-bind9 machine**. Click around. As of 0.3 the BIND9 capabilities are basic. Stork is able to check if bind9 process is running and display its version. Much more coming up in 0.4.
|
|
|
|
|
|
6. Add new Kea machine to minitor. Go to `Services`->`Machines` and click `Add New Machine`, type in `agent-kea`. The procedure is the same as before, but this time Stork detected Kea servers running. Notice that a problem is reported.
|
|
6. **Add new Kea machine to monitor**. Go to `Services`->`Machines` and click `Add New Machine`, type in `agent-kea`. The procedure is the same as before, but this time Stork detected Kea servers running. Notice that a problem is reported.
|
|
|
|
|
|
Kea is being shipped with CA (Control Agent) preconfigured with control sockets for DHCPv4, DHCPv6 and DDNS. This simplifies deployment. CA tries to connect to all of those daemons and continues with only those that respond. That makes it easy to deploy daemons selectively. However, Stork looks at the CA config and determines that there are 3 daemons expected, but only DHCPv4 is running. Therefore it reports a problem of non-running DHCPv6 and DDNS daemons.
|
|
Kea is being shipped with CA (Control Agent) preconfigured with control sockets for DHCPv4, DHCPv6 and DDNS. This simplifies deployment. CA tries to connect to all of those daemons and continues with only those that respond. That makes it easy to deploy daemons selectively. However, Stork looks at the CA config and determines that there are 3 daemons expected, but only DHCPv4 is running. Therefore it reports a problem of non-running DHCPv6 and DDNS daemons.
|
|
|
|
|
|
Stork developers have several ideas how to deal with the situation, but we'd love to hear your thoughts on this. We could simply modify the docker container to run all daemons. This would nice feeling of seeing all green, but wouldn't demonstrate that Stork is able to detect problems. Second alternative would be to modify the CA config, so it would attempt only to connect to daemons that are actually running (DHCPv4 only). Third, we could add an **Ignore** or **That's ok** button that the user could click to indicate that it's ok that DHCPv6 or DDNS is not running. Ultimately, the network admin is the source of truth that knows whether the daemon is supposed to be running or not.
|
|
Stork developers have several ideas how to deal with the situation, but we'd love to hear your thoughts on this. We could simply modify the docker container to run all daemons. This would nice feeling of seeing all green, but wouldn't demonstrate that Stork is able to detect problems. Second alternative would be to modify the CA config, so it would attempt only to connect to daemons that are actually running (DHCPv4 only). Third, we could add an **Ignore** or **That's ok** button that the user could click to indicate that it's ok that DHCPv6 or DDNS is not running. Ultimately, the network admin is the source of truth that knows whether the daemon is supposed to be running or not.
|
|
|
|
|
|
7. Inspect Kea details. You can either click on the Version on the Kea apps list or click of the machine and the link to details in the Kea app panel on the machine details page. Note the Kea version being returned and a list of currently loaded hooks. Stork 0.3 has the capability to retrieve the full currently running configuration of Kea. It is now used to do a modest task - list currently loaded hooks. We expect this capability to be heavily used for great variety of things.
|
|
7. **Inspect Kea details**. You can either click on the Version on the Kea apps list or click of the machine and the link to details in the Kea app panel on the machine details page. Note the Kea version being returned and a list of currently loaded hooks. Stork 0.3 has the capability to retrieve the full currently running configuration of Kea. It is now used to do a modest task - list currently loaded hooks. We expect this capability to be heavily used for great variety of things.
|
|
|
|
|
|
Note that the Kea app running on agent-kea does not have HA enabled, so HA status is not displayed.
|
|
Note that the Kea app running on agent-kea does not have HA enabled, so HA status is not displayed.
|
|
|
|
|
|
8. Add two Kea servers that work as HA pair. Go to `Services`->`Machines` and click `Add New Machine`, and add `agent-kea-ha1`. Repeat for `agent-kea-ha2`.
|
|
8. **Add two Kea servers that work as HA pair**. Go to `Services`->`Machines` and click `Add New Machine`, and add `agent-kea-ha1`. Repeat for `agent-kea-ha2`.
|
|
|
|
|
|
You can now inspect the HA status of those servers.
|
|
You can now inspect the HA status of those servers.
|
|
|
|
|
|
9. You can change your own password. Go to `Profile` -> `Settings`.
|
|
9. **You can change your own password**. Go to `Profile` -> `Settings`.
|
|
|
|
|
|
10. 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`.
|
|
10. **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`.
|
|
|
|
|
|
11. 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.
|
|
11. **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 there's a bug in 0.3 that deletes the machines, but not the apps running on it. It is expected to be fixed shortly.
|
|
Note there's a bug in 0.3 that deletes the machines, but not the apps running on it. It is expected to be fixed shortly.
|
|
|
|
|
|
12. Check Stork version. You can hover your mouse over the Stork logo. It will display some information about Stork itself (version, compilation time). This works only in the latest git version and will be made available in upcoming 0.4.
|
|
12. **Check Stork version**. You can hover your mouse over the Stork logo. It will display some information about Stork itself (version, compilation time). This works only in the latest git version and will be made available in upcoming 0.4.
|
|
|
|
|
|
# Feedback
|
|
# Feedback
|
|
|
|
|
... | | ... | |