Fix some formatting bugs 'The Project' section
This commit is contained in:
Héctor Hurtado
@@ -40,111 +40,108 @@ So, the next step is to **analyze how to perform the ping.**
|
||||
Accessing via SSH to :samp:`External Host`
|
||||
++++++++++++++++++++++++++++++++++++++++++
|
||||
|
||||
If we choose this option then we need to create a user and grant him access via :samp:`SSH` to :samp:`External Host` for every person that needs to check for :samp:`Internal host` status.
|
||||
If we choose this option then we need to create a user and grant him access via :samp:`SSH` to :samp:`External Host` for every person that needs to check for :samp:`Internal host` status.
|
||||
|
||||
Conclusion: **Not a good idea.**
|
||||
Conclusion: **Not a good idea.**
|
||||
|
||||
Reasons:
|
||||
Reasons:
|
||||
|
||||
1. We need to manage users (violates a constraint.)
|
||||
2. We need to grant access for users to system (violates a constraint.)
|
||||
3. We can't control what :samp:`ping` options the user can use to ping :samp:`Internal Host` (violates a constraint.)
|
||||
1. We need to manage users (violates a constraint.)
|
||||
2. We need to grant access for users to system (violates a constraint.)
|
||||
3. We can't control what :samp:`ping` options the user can use to ping :samp:`Internal Host` (violates a constraint.)
|
||||
|
||||
|
||||
Develop and deploy a custom solution
|
||||
++++++++++++++++++++++++++++++++++++
|
||||
|
||||
Ok, this approach could maybe be the better choice for our organization but:
|
||||
Ok, this approach could maybe be the better choice for our organization but:
|
||||
|
||||
1. We'll need to create a new project, develop, test, manage and maintain it.
|
||||
2. We need to wait for for the development to be production ready.
|
||||
3. We need a bucket, even we have developers in our organization.
|
||||
1. We'll need to create a new project, develop, test, manage and maintain it.
|
||||
2. We need to wait for for the development to be production ready.
|
||||
3. We need a bucket, even we have developers in our organization.
|
||||
|
||||
Conclusion: **Not a good idea.**
|
||||
Conclusion: **Not a good idea.**
|
||||
|
||||
Reasons:
|
||||
Reasons:
|
||||
|
||||
1. Need to spend money (violates a constraint.)
|
||||
2. Need to spend time.
|
||||
1. Need to spend money (violates a constraint.)
|
||||
2. Need to spend time.
|
||||
|
||||
|
||||
Using Kapow! (Spoiler: the winner!)
|
||||
+++++++++++++++++++++++++++++++++++
|
||||
|
||||
Ok, lets analyze Kapow! and check it for our constraints:
|
||||
Ok, lets analyze Kapow! and check it for our constraints:
|
||||
|
||||
1. Kapow! is Open Source, so **it's free**.
|
||||
2. By using kapow! we don't need to program our own solution, so we **don't waste time**.
|
||||
3. By using Kapow! we can run any command in the :samp:`External Host` limiting the command parameters, so **it's safe**.
|
||||
4. By using Kapow! we can launch any system command as an HTTP API easily, so **we don't need to grant login access to anybody to** :samp:`External Host`.
|
||||
1. Kapow! is Open Source, so **it's free**.
|
||||
2. By using kapow! we don't need to program our own solution, so we **don't waste time**.
|
||||
3. By using Kapow! we can run any command in the :samp:`External Host` limiting the command parameters, so **it's safe**.
|
||||
4. By using Kapow! we can launch any system command as an HTTP API easily, so **we don't need to grant login access to anybody to** :samp:`External Host`.
|
||||
|
||||
Conclusion: **Kapow! is the best choice.**
|
||||
Conclusion: **Kapow! is the best choice.**
|
||||
|
||||
Reasons: It satisfies all of our requirements.
|
||||
Reasons: It satisfies all of our requirements.
|
||||
|
||||
|
||||
Using Kapow!
|
||||
------------
|
||||
|
||||
In order to get our example :ref:`Scenario <quickstart_image>` working we need to follow the below steps.
|
||||
In order to get our example :ref:`Scenario <quickstart_image>` working we need to follow the below steps.
|
||||
|
||||
|
||||
Install Kapow!
|
||||
++++++++++++++
|
||||
|
||||
Follow :doc:`Install Kapow! <install_and_configure>` instructions.
|
||||
Follow :doc:`Install Kapow! <install_and_configure>` instructions.
|
||||
|
||||
|
||||
Write ping.pow file
|
||||
+++++++++++++++++++
|
||||
|
||||
Kapow! use plain text files (called ``POW`` files) so you can define the endpoints you want to expose the system command with. For our example we need a file like this:
|
||||
Kapow! use plain text files (called ``POW`` files) so you can define the endpoints you want to expose the system command with. For our example we need a file like this:
|
||||
|
||||
.. code-block:: console
|
||||
.. code-block:: console
|
||||
|
||||
$ cat ping.pow
|
||||
kapow route add /ping -c 'ping -c 1 10.10.10.100 | kapow set /response/body'
|
||||
$ cat ping.pow
|
||||
kapow route add /ping -c 'ping -c 1 10.10.10.100 | kapow set /response/body'
|
||||
|
||||
Explanation:
|
||||
Explanation:
|
||||
|
||||
1. :samp:`kapow route add /ping` - adds a new HTTP API endpoint at :samp:`/ping` path in the Kapow! server. You have to use GET method to invoke the endpoint.
|
||||
2. :samp:`-c` - after this parameter we write the system command that Kapow! will run each time the endpint is invoked.
|
||||
3. :samp:`ping -c 1 10.10.10.100` - sends 1 ping package to the host *10.10.10.100*, i.e. :samp:`Internal Host`.
|
||||
4. :samp:`| kapow set /response/body` - writes the ping output to the response so you can see it.
|
||||
1. :samp:`kapow route add /ping` - adds a new HTTP API endpoint at :samp:`/ping` path in the Kapow! server. You have to use GET method to invoke the endpoint.
|
||||
2. :samp:`-c` - after this parameter we write the system command that Kapow! will run each time the endpint is invoked.
|
||||
3. :samp:`ping -c 1 10.10.10.100` - sends 1 ping package to the host *10.10.10.100*, i.e. :samp:`Internal Host`.
|
||||
4. :samp:`| kapow set /response/body` - writes the ping output to the response so you can see it.
|
||||
|
||||
|
||||
Launch the service
|
||||
++++++++++++++++++
|
||||
|
||||
At this point we only need to launch kapow! with our :samp:`simple.pow`:
|
||||
At this point we only need to launch kapow! with our :samp:`ping.pow`:
|
||||
|
||||
.. code-block:: console
|
||||
.. code-block:: console
|
||||
|
||||
$ kapow server ping.pow
|
||||
$ kapow server ping.pow
|
||||
|
||||
|
||||
Consume the service
|
||||
+++++++++++++++++++
|
||||
|
||||
Now we can call our new created endpoint by using our favorite HTTP client.
|
||||
In this example we're using :samp:`curl`:
|
||||
Now we can call our new created endpoint by using our favorite HTTP client. In this example we're using :samp:`curl`:
|
||||
|
||||
.. code-block:: console
|
||||
.. code-block:: console
|
||||
|
||||
$ curl http://external.host/ping
|
||||
PING 10.10.100 (10.10.100): 56 data bytes
|
||||
64 bytes from 10.10.100: icmp_seq=0 ttl=55 time=1.425 ms
|
||||
$ curl http://external.host/ping
|
||||
PING 10.10.100 (10.10.100): 56 data bytes
|
||||
64 bytes from 10.10.100: icmp_seq=0 ttl=55 time=1.425 ms
|
||||
|
||||
|
||||
Under the hoods
|
||||
++++++++++++++++
|
||||
|
||||
To understand what's happening under the hoods with Kapow! lets see the
|
||||
picture:
|
||||
To understand what's happening under the hoods with Kapow! lets see the picture:
|
||||
|
||||
.. image:: /_static/sequence.png
|
||||
:align: center
|
||||
:width: 80%
|
||||
.. image:: /_static/sequence.png
|
||||
:align: center
|
||||
:width: 80%
|
||||
|
||||
As you can see, Kapow! performs the *magic* between system commands and HTTP
|
||||
API.
|
||||
As you can see, Kapow! performs the *magic* between system commands and HTTP API.
|
||||
|
||||
Reference in New Issue
Block a user