Commit Graph

39 Commits

Author SHA1 Message Date
pancho horrillo
1e63f3c104 feat: Control API uses automatic cross-pinning mTLS (Closes #119)
. kapow server generates on startup a pair of certificates
that will use to secure communications to its control server.
It will communicate the server and client certificates as well
as the client private key to the init programs it launches,
via environment variables.

. kapow server now understands a new flag --control-reachable-addr
which accepts either a IP address or a DNS name, that can be used
to ensure that the generated server certificate will be appropiate
in case the control server must be accessed from something other
than localhost.

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2021-03-12 17:24:17 +01:00
Roberto Abdelkader Martínez Pérez
0ffb28c3d6 chore: test documentation (#145)
* chore: Test documentation

* docs: fix broken links
2020-12-30 16:59:22 +01:00
pancho horrillo
76725555d2 doc: /server/log/<prefix> endpoint
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2020-12-18 12:22:41 +01:00
Héctor Hurtado
a17cc4838d Add ssl/client/i/dn resource. Closes #113 2020-09-10 16:35:41 +02:00
Héctor Hurtado
6c3bee9ae0 Add route/id resource. Closes #10 2020-09-09 14:12:53 +02:00
Héctor Hurtado
774b9202b5 Add routes for /request/version and /request/remote in data server. Add resource tree documentation for /request/version and /request/remote. Closes #85 2020-09-09 14:11:46 +02:00
Héctor Hurtado
fc19b921be Add request/remote resource 2020-09-09 08:53:40 +02:00
Héctor Hurtado
9988d0e0d4 Add request/version resource 2020-09-08 15:27:51 +02:00
Patrick Pelletier
8edde476e0 Fix return value for resource params
In the example, the param name is "myparam" and the value is "bar", but the output for the value is "myparam"...
s/myparam/bar/
2020-08-20 00:29:50 -04:00
pancho horrillo
2e5e11cc47 doc: fix typo 2020-06-16 11:23:47 +02:00
Roberto Abdelkader Martínez Pérez
da50501428 Proper form file upload. https://medium.com/@petehouston/upload-files-with-curl-93064dcccc76 2020-02-13 12:25:58 +01:00
Roberto Abdelkader Martínez Pérez
e6c6edf6b0 doc: Link data api section 2019-12-19 11:38:21 +01:00
Roberto Abdelkader Martínez Pérez
197f91821a doc: Missing subsection in philosophy section 2019-12-19 11:32:49 +01:00
Roberto Abdelkader Martínez Pérez
01726df4e8 doc: Restructure to allow better latex rendering 2019-12-16 11:00:36 +01:00
Héctor Hurtado
9a52a7192a Resolve conflicts 2019-12-16 10:42:30 +01:00
pancho horrillo
3c05e3b580 doc: drop already resolved todo block 2019-12-13 16:09:52 +01:00
pancho horrillo
24f0597c95 doc: add link 2019-12-13 16:07:47 +01:00
pancho horrillo
3149554ff1 doc: add links and style fixes 2019-12-13 16:03:49 +01:00
pancho horrillo
74d9129d27 doc: add link 2019-12-13 15:43:51 +01:00
pancho horrillo
66eda3c6bd doc: drop stale todo block 2019-12-13 15:36:41 +01:00
pancho horrillo
b32d670251 doc: style fix 2019-12-13 15:35:20 +01:00
pancho horrillo
04ec4f2c41 doc: style fixes 2019-12-13 15:33:17 +01:00
pancho horrillo
b0d0c12981 doc: add links and roles 2019-12-13 15:27:21 +01:00
pancho horrillo
2847073519 doc: drop explicit :tech: role 2019-12-13 15:10:17 +01:00
pancho horrillo
dea72cbe3a doc: style fixes and links 2019-12-13 15:08:02 +01:00
pancho horrillo
0fd3cfb665 doc: add internal links
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 17:44:10 +01:00
pancho horrillo
ecaea23d40 doc: markup stdin as tech role
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 16:05:55 +01:00
pancho horrillo
ab615e2276 doc: markup :any: role as default role, which is now :tech: (custom)
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 15:59:27 +01:00
pancho horrillo
cb5ba7db43 doc: markup {User,Control,Data} HTTP Interface as role any
Also markup localhost:8080 as code, for consistency.

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 14:41:14 +01:00
pancho horrillo
bd1ea8f746 doc: markup 'kapow server' as code
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 14:32:12 +01:00
pancho horrillo
578e4c3b30 doc: markup envvars as such, HANDLER_ID as variable
HANDLER_ID represents a variable name in this case, and the docs¹, first Note,
suggest using the default role (`content`) for variable names.

¹: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 13:29:18 +01:00
pancho horrillo
8b3417000d doc: style fix 2019-12-11 13:16:46 +01:00
pancho horrillo
90f97f63fa doc: markup Docker{,file} as any role
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 13:15:45 +01:00
pancho horrillo
171f8c0410 doc: markup kapow as program role
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 12:41:18 +01:00
pancho horrillo
b1d0e9c92f doc: use valid language in code-blocks
See ¹ for the valid values.

¹: https://www.sphinx-doc.org/en/1.5/markup/code.html#directive-code-block
2019-12-11 03:23:56 +01:00
pancho horrillo
c974e7787e doc: tweak code-block to fix render glitch at readthedocks.io 2019-12-11 03:10:55 +01:00
pancho horrillo
16639ba44b doc: style fixes 2019-12-11 02:32:52 +01:00
pancho horrillo
bb4aa1a00f doc: normalize style of Kapow!, to be shown italicized
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-10 10:34:39 +01:00
pancho horrillo
166c767317 doc: add section on security and misc fixes
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-05 18:30:35 +01:00