diff --git a/docs/_static/CS_entry_v02_blue.svg b/docs/_static/CS_entry_v02_blue.svg new file mode 100755 index 0000000000000000000000000000000000000000..c3cbf0e9249e38af272f0e417a6f4ebaeaa6e7d3 --- /dev/null +++ b/docs/_static/CS_entry_v02_blue.svg @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 23.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) --> +<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" + viewBox="0 0 2560 854" style="enable-background:new 0 0 2560 854;" xml:space="preserve"> +<style type="text/css"> + .st0{fill:#0094CA;} +</style> +<g id="Layer_1"> + <g> + <path class="st0" d="M886.8,303.7c-67.8-15.7-130.9-36.1-130.9-66.2c0-18.1,18.5-44.6,72.4-44.6c75.5,0,78.5,36.1,80.1,50.6h251 + c-21.6-175.8-215.6-210.8-328-210.8c-82.9,0-160.7,19.3-220.1,53.9c2,1.5,3.9,3,5.9,4.6c67.8,54.1,114.8,131,132.4,216.5l6.2,30.1 + H527.8c35.5,45.9,101.4,77.4,175.7,95.9c163.2,49.4,226.4,55.4,226.4,101.2c0,32.5-46.2,51.8-89.3,51.8c-10.8,0-86.2,0-97-61.4 + h-8.6c-23.9,61.6-63.3,116.7-114.1,158.7c-4.1,3.4-8.4,6.7-12.6,10c70.8,39.7,159.6,52.9,229.2,52.9c189.4,0,348-86.7,348-233.6 + C1185.5,368.8,1031.5,335,886.8,303.7z"/> + <g> + <path class="st0" d="M726.2,469.6c-36.2,152-170.1,276.2-351,276.2C172.6,745.8,17,586.6,17,387.6C17,191,170.2,31.8,370.4,31.8 + c177.3,0,320.8,117,354.6,281H522.3c-21.7-45.8-61.5-94.1-144.7-94.1c-47-2.4-86.8,15.7-115.8,47c-27.7,31.4-43.4,74.8-43.4,123 + c0,97.7,63.9,170.1,159.2,170.1c83.2,0,123-48.2,144.7-89.2H726.2z"/> + </g> + <g> + <path class="st0" d="M1312.9,628.4c3.5,29.7,31.8,49.4,64.5,49.4c26.7,0,40.8-11.6,50.9-26.2h85.7c-13.6,31.3-33.3,55.5-57,71.6 + c-23.2,16.6-50.9,25.2-79.7,25.2c-80.2,0-148.2-65-148.2-148.2c0-78.2,61.5-150.3,146.7-150.3c42.9,0,79.7,16.6,105.9,44.4 + c35.3,37.8,45.9,82.7,39.3,134.1H1312.9z M1438.9,564.9c-2-13.1-19.2-44.4-62.5-44.4c-43.4,0-60.5,31.3-62.5,44.4H1438.9z"/> + <path class="st0" d="M1559.9,459.5h78.2v29.7c9.6-13.6,27.2-39.3,77.1-39.3c94.3,0,103.9,76.6,103.9,114.5v175h-83.7V586.6 + c0-30.8-6.6-58-43.9-58c-41.3,0-47.9,29.7-47.9,58.5v152.3h-83.7V459.5z"/> + <path class="st0" d="M1895.2,523.1h-41.3v-63.5h41.3v-93.3h83.7v93.3h40.3v63.5h-40.3v216.3h-83.7V523.1z"/> + <path class="st0" d="M2055.1,459.5h78.7v31.3c8.1-15.1,22.7-40.8,71.1-40.8v84.2h-3c-42.9,0-63,15.6-63,55v150.3h-83.7V459.5z"/> + <path class="st0" d="M2332.9,725.2L2229,459.5h89.2l57,162.4l53.4-162.4h88.7l-140.2,373.1h-88.7L2332.9,725.2z"/> + </g> + </g> +</g> +<g id="lines"> +</g> +<g id="rest"> +</g> +</svg> diff --git a/docs/_static/access_profile.png b/docs/_static/access_profile.png index ca4db1c0a96d54d06f74d161edf1aae1193d1c54..07d42b7dec885ab801a262292b91a49ec0e90fc2 100644 Binary files a/docs/_static/access_profile.png and b/docs/_static/access_profile.png differ diff --git a/docs/_static/add_interface.png b/docs/_static/add_interface.png index e496d4ae9a94b9c39e14cae3cbd356ce03401b4e..db7f70c92b7bc8a7a6d494fd2b3c6b8c2c783e89 100644 Binary files a/docs/_static/add_interface.png and b/docs/_static/add_interface.png differ diff --git a/docs/_static/ansible/create_ansible_group_of_groups.png b/docs/_static/ansible/create_ansible_group_of_groups.png index 9eb635c318b60d75a2ed7309e83a879ce58983f8..07fb7e921d1e4502d04c1306a92b6bc5878db31b 100644 Binary files a/docs/_static/ansible/create_ansible_group_of_groups.png and b/docs/_static/ansible/create_ansible_group_of_groups.png differ diff --git a/docs/_static/ansible/create_ansible_network_group.png b/docs/_static/ansible/create_ansible_network_group.png index 57ea2ad76e33c22c1787a42988bd6c5188a2951c..2e816861f6c9ff3ebb12bcac770feab5743bdd76 100644 Binary files a/docs/_static/ansible/create_ansible_network_group.png and b/docs/_static/ansible/create_ansible_network_group.png differ diff --git a/docs/_static/ansible/edit_ansible_group.png b/docs/_static/ansible/edit_ansible_group.png index 7ffba42a48885db038fb641f2834823fef765031..c08e89bb84fb9ba0d0728c306943850976cbcf34 100644 Binary files a/docs/_static/ansible/edit_ansible_group.png and b/docs/_static/ansible/edit_ansible_group.png differ diff --git a/docs/_static/ansible/edit_ansible_host_vars.png b/docs/_static/ansible/edit_ansible_host_vars.png index 356616f3a17319d11abc88fd131fd3f3e2335035..7405654aeff20f52f703653ae800c1027799fac3 100644 Binary files a/docs/_static/ansible/edit_ansible_host_vars.png and b/docs/_static/ansible/edit_ansible_host_vars.png differ diff --git a/docs/_static/ansible/enter_vault_variable.png b/docs/_static/ansible/enter_vault_variable.png index e9b1e8d7776cf1355c9d07623fc129575d645607..e6f1fdc9559fb7795402c47d824ef31d07a81555 100644 Binary files a/docs/_static/ansible/enter_vault_variable.png and b/docs/_static/ansible/enter_vault_variable.png differ diff --git a/docs/_static/ansible/list_ansible_groups.png b/docs/_static/ansible/list_ansible_groups.png index 000a7ea179f372a8f49c63e522140a08bf62d88a..e4cff205794d2440e359d802d5d6f3a9acb28fea 100644 Binary files a/docs/_static/ansible/list_ansible_groups.png and b/docs/_static/ansible/list_ansible_groups.png differ diff --git a/docs/_static/ansible/register_ansible_group.png b/docs/_static/ansible/register_ansible_group.png index feebaa60e3b1554a231d1e03fb09a4561f463cbd..2a827fdf1d6f0b291372f6470c577e943f79e0df 100644 Binary files a/docs/_static/ansible/register_ansible_group.png and b/docs/_static/ansible/register_ansible_group.png differ diff --git a/docs/_static/ansible/saved_vault_variable.png b/docs/_static/ansible/saved_vault_variable.png index a03083a6f9bef86930ed47f663864ef1035607ca..057d72ce935ef11e45310ee913d4cd8b84353ac2 100644 Binary files a/docs/_static/ansible/saved_vault_variable.png and b/docs/_static/ansible/saved_vault_variable.png differ diff --git a/docs/_static/ansible/view_ansible_network_group.png b/docs/_static/ansible/view_ansible_network_group.png index 408ff78c68217d35892679b58de61d88ff2dc92d..b380319d65d95022c6a34eef9e564c7157433c75 100644 Binary files a/docs/_static/ansible/view_ansible_network_group.png and b/docs/_static/ansible/view_ansible_network_group.png differ diff --git a/docs/_static/create_item.png b/docs/_static/create_item.png index 5e8cd0a0a61e1ca414524fe6c6e9682818521060..900c86c6a22b38452f024b333e277f28b5c738d2 100644 Binary files a/docs/_static/create_item.png and b/docs/_static/create_item.png differ diff --git a/docs/_static/create_vioc.png b/docs/_static/create_vioc.png index a55c47ef04c60916b0c0641f5c1fd127d12d1b86..8febd8a537f74bb0d371a39c07a9c42c604231cc 100644 Binary files a/docs/_static/create_vioc.png and b/docs/_static/create_vioc.png differ diff --git a/docs/_static/create_vm.png b/docs/_static/create_vm.png index 33282990d7b599af26adf7e6add6aeaf5a4596bd..df0b4f85b6df2fc8a4bc1d7abb0567a17124eb0f 100644 Binary files a/docs/_static/create_vm.png and b/docs/_static/create_vm.png differ diff --git a/docs/_static/create_vm_confirmation.png b/docs/_static/create_vm_confirmation.png index 32f50b5377c3221bd49bc2279dc386aaef3b9ab8..1ec33d60b6b5bd333b04b24560d703b6fb645607 100644 Binary files a/docs/_static/create_vm_confirmation.png and b/docs/_static/create_vm_confirmation.png differ diff --git a/docs/_static/csentry-test.png b/docs/_static/csentry-test.png index dca9493187e324e285f2f58b8b5fe304e889c94d..e1db46ec4d2ce8b54d89dc9c7a3c4b69eeaca1b4 100644 Binary files a/docs/_static/csentry-test.png and b/docs/_static/csentry-test.png differ diff --git a/docs/_static/edit_item_stack_member.png b/docs/_static/edit_item_stack_member.png index 621ed9a84d1c294da7d901aa8269b1b61f691202..a07ceac2f53a35b17269c40b2ca62801115c6c46 100644 Binary files a/docs/_static/edit_item_stack_member.png and b/docs/_static/edit_item_stack_member.png differ diff --git a/docs/_static/home.png b/docs/_static/home.png index 5214a2853f6b3b3af3f1900e2f47f957987e2bda..304ec9e96bd8840ca505dc8f91ad12c381bd5e0d 100644 Binary files a/docs/_static/home.png and b/docs/_static/home.png differ diff --git a/docs/_static/inventory/export_to_excel.png b/docs/_static/inventory/export_to_excel.png index ce6831139b5d8132d7223e3c8403c9b713032582..5277cf5ea84198ba47d25bd3135b9c67af775fa1 100644 Binary files a/docs/_static/inventory/export_to_excel.png and b/docs/_static/inventory/export_to_excel.png differ diff --git a/docs/_static/inventory/inventory.png b/docs/_static/inventory/inventory.png index fac85f5a0be0ec96a698b477ea5a0041fa601f67..b0b1531129e009c0116a73f823b60a8cdbe82221 100644 Binary files a/docs/_static/inventory/inventory.png and b/docs/_static/inventory/inventory.png differ diff --git a/docs/_static/inventory/search_exists_parent.png b/docs/_static/inventory/search_exists_parent.png index 3599f315900b8d6144f73f3cceac91107171f7db..257e6faff08f1662e24367e85359892b786151c8 100644 Binary files a/docs/_static/inventory/search_exists_parent.png and b/docs/_static/inventory/search_exists_parent.png differ diff --git a/docs/_static/inventory/search_ics_id_field.png b/docs/_static/inventory/search_ics_id_field.png index 52178ebfe37bca15034e96920439d06132dd3180..8e3e3b7321ec9318f337c4e63f8f05e4405ee90e 100644 Binary files a/docs/_static/inventory/search_ics_id_field.png and b/docs/_static/inventory/search_ics_id_field.png differ diff --git a/docs/_static/inventory/search_ics_id_multiple.png b/docs/_static/inventory/search_ics_id_multiple.png index 8b2b74482955d54a27f50710933a786792e02ede..0446639e200645ed9ba508430b1f56e4e47cce9e 100644 Binary files a/docs/_static/inventory/search_ics_id_multiple.png and b/docs/_static/inventory/search_ics_id_multiple.png differ diff --git a/docs/_static/inventory/search_juniper.png b/docs/_static/inventory/search_juniper.png index 64873eca028cf946d9d6c84a9d2c5a97401ea6d6..b431bbc70d8a495f50c817372b543d7fe71d22dc 100644 Binary files a/docs/_static/inventory/search_juniper.png and b/docs/_static/inventory/search_juniper.png differ diff --git a/docs/_static/inventory/search_juniper_and_rats.png b/docs/_static/inventory/search_juniper_and_rats.png index 1b7bce009fd639c3c8fb47aee7a81a0aac862a90..e032db8b361442199760025d80817c8a8842ea76 100644 Binary files a/docs/_static/inventory/search_juniper_and_rats.png and b/docs/_static/inventory/search_juniper_and_rats.png differ diff --git a/docs/_static/inventory/search_juniper_not_rats.png b/docs/_static/inventory/search_juniper_not_rats.png index 1915f8d42f7490354e134bbf5c4ebf1e7c3d4e40..935e8a5487a6dc1a28fc0e51b0e9ab7c14a279e8 100644 Binary files a/docs/_static/inventory/search_juniper_not_rats.png and b/docs/_static/inventory/search_juniper_not_rats.png differ diff --git a/docs/_static/inventory/search_quote_mac.png b/docs/_static/inventory/search_quote_mac.png index d0b4ac0db0780b0d6fd1d3d5757d65f674e36a95..f35e3def1ecec4038ad68a1794eb619368661660 100644 Binary files a/docs/_static/inventory/search_quote_mac.png and b/docs/_static/inventory/search_quote_mac.png differ diff --git a/docs/_static/inventory/search_quote_tag.png b/docs/_static/inventory/search_quote_tag.png index 7b5e2806da2ba9a2dbfe9379e8e719fa510730cd..ce0f0db0c00ad5941194572a39a12df543ab673b 100644 Binary files a/docs/_static/inventory/search_quote_tag.png and b/docs/_static/inventory/search_quote_tag.png differ diff --git a/docs/_static/inventory/search_serial_number.png b/docs/_static/inventory/search_serial_number.png index e6ddfb911fc3ad7588dca8331ce44409dc10d3e0..ba8b25859511ceaa62a8bf73f9d18b3475eecd4d 100644 Binary files a/docs/_static/inventory/search_serial_number.png and b/docs/_static/inventory/search_serial_number.png differ diff --git a/docs/_static/inventory/search_wildcard.png b/docs/_static/inventory/search_wildcard.png index e02241650126838e8766e545ab0f478750af73b5..d2f897ab6f8c7b3e1469a291adf9b0abddef336d 100644 Binary files a/docs/_static/inventory/search_wildcard.png and b/docs/_static/inventory/search_wildcard.png differ diff --git a/docs/_static/item_created.png b/docs/_static/item_created.png index ac12d2c674a71d7905260b9abaf44d72c6a08825..9921855ce19b407831c5ed0ced938efb9bfa996e 100644 Binary files a/docs/_static/item_created.png and b/docs/_static/item_created.png differ diff --git a/docs/_static/login.png b/docs/_static/login.png index 9e4a43e5f03607406d9c066428e7d37558c111ca..23f66b5886b7497d6437bcc1ff3e301cb357c8c7 100644 Binary files a/docs/_static/login.png and b/docs/_static/login.png differ diff --git a/docs/_static/network/delete_host_confirmation.png b/docs/_static/network/delete_host_confirmation.png index ac8383deffc4e51707f7f9ec11dac1fa0cd7374f..b9ed0dd58fb4a482f299e2afe7a0d94387514270 100644 Binary files a/docs/_static/network/delete_host_confirmation.png and b/docs/_static/network/delete_host_confirmation.png differ diff --git a/docs/_static/network/list_hosts.png b/docs/_static/network/list_hosts.png index 9965b1ffc3e95cf51116db9eb34266d047fb0217..54ca32d4fea25ed93fc21a543a46137718a90f35 100644 Binary files a/docs/_static/network/list_hosts.png and b/docs/_static/network/list_hosts.png differ diff --git a/docs/_static/network/search_host_ip.png b/docs/_static/network/search_host_ip.png index 2be3ed725f0af9e30c78f960288fee4a99212823..ee4bb4971001dc713d72f08a53c4b5d262ac911d 100644 Binary files a/docs/_static/network/search_host_ip.png and b/docs/_static/network/search_host_ip.png differ diff --git a/docs/_static/network/search_host_name_field.png b/docs/_static/network/search_host_name_field.png index de03700a1bf2eaaf00696b2a1492ac5caf6d6cc6..7e0054c69ae76f4e0b588a31aece90a23f19ef00 100644 Binary files a/docs/_static/network/search_host_name_field.png and b/docs/_static/network/search_host_name_field.png differ diff --git a/docs/_static/network/search_host_quote_name.png b/docs/_static/network/search_host_quote_name.png index 619a4309958857d56527b9ccf86d65c1f67c0155..83bad446d7634ae925edba23bfb9249fe4291d6a 100644 Binary files a/docs/_static/network/search_host_quote_name.png and b/docs/_static/network/search_host_quote_name.png differ diff --git a/docs/_static/network/search_host_ts2.png b/docs/_static/network/search_host_ts2.png index 7a8fd47bb104fe191028be9a7b3ee1b53211ee72..f56cfcef2f43d412c76a65a1c232b19ca3cbd08b 100644 Binary files a/docs/_static/network/search_host_ts2.png and b/docs/_static/network/search_host_ts2.png differ diff --git a/docs/_static/network/search_host_wildcard.png b/docs/_static/network/search_host_wildcard.png index c8ffb6d6fdc16345b89feb84c04ceb92359de6bb..96329e66027d4ac0b5ed10b800d8cb2431794308 100644 Binary files a/docs/_static/network/search_host_wildcard.png and b/docs/_static/network/search_host_wildcard.png differ diff --git a/docs/_static/network/view_host_delete.png b/docs/_static/network/view_host_delete.png index 04479fbf503495fafcdb018f9caf5c99b7a65816..576de795138b6cc1d17946b7315f7193eeeb986a 100644 Binary files a/docs/_static/network/view_host_delete.png and b/docs/_static/network/view_host_delete.png differ diff --git a/docs/_static/profile.png b/docs/_static/profile.png index 44d86fc1f716fa43b920d403062885eaa21fbf7e..cee9aee2bcee25245471303e9a58e7b9f50e03c8 100644 Binary files a/docs/_static/profile.png and b/docs/_static/profile.png differ diff --git a/docs/_static/register_host.png b/docs/_static/register_host.png index 8ae0d4cc9819e2a48d468bc5930e9b7ad02be00f..e7feab21ce44588dea4ec6b0b0f928229aa1b423 100644 Binary files a/docs/_static/register_host.png and b/docs/_static/register_host.png differ diff --git a/docs/_static/revoke_token.png b/docs/_static/revoke_token.png index e5ffec2b6874091d6a25a6aeb1cad52e74fcf093..69c8bbc8ce593720a84372da0909c59e8a841c2c 100644 Binary files a/docs/_static/revoke_token.png and b/docs/_static/revoke_token.png differ diff --git a/docs/_static/tasks.png b/docs/_static/tasks.png index b79a9195f3989f0b88fd89721d078bb5677bd2b2..b008b94d6e249d92dd49cb0c7468f1e3efb1e544 100644 Binary files a/docs/_static/tasks.png and b/docs/_static/tasks.png differ diff --git a/docs/_static/token_copied.png b/docs/_static/token_copied.png index 71c428103bf3ef3aae78e7dc4f70088e9ba87e67..118d62edd8bf8a3059bd87d2d4223141a9cb3776 100644 Binary files a/docs/_static/token_copied.png and b/docs/_static/token_copied.png differ diff --git a/docs/_static/token_revoked.png b/docs/_static/token_revoked.png index aee71fb302be45910d3c80c974fff3da3f1328c0..f6f0e552c5aa9f0f28317597b6b45600fbb81acf 100644 Binary files a/docs/_static/token_revoked.png and b/docs/_static/token_revoked.png differ diff --git a/docs/_static/view_host.png b/docs/_static/view_host.png index a4d0a0d955f6847c4d9e8eab44b9ba2284b631d9..3d699fa78ab98aaaf285f34bffe0388cc04ece58 100644 Binary files a/docs/_static/view_host.png and b/docs/_static/view_host.png differ diff --git a/docs/_static/view_host_network.png b/docs/_static/view_host_network.png index 4db1aa481f5e932b5ef575724bfbc4fd82b36f26..7b51ef398a1b95e1069dd8046bb220dc92b2bde7 100644 Binary files a/docs/_static/view_host_network.png and b/docs/_static/view_host_network.png differ diff --git a/docs/_static/view_item.png b/docs/_static/view_item.png index bc03120e0c1cc5e14d12a7c738fe24e994dbd78d..e572556ca9d5749ccdc0ded6ac9ff6514c1ec1b8 100644 Binary files a/docs/_static/view_item.png and b/docs/_static/view_item.png differ diff --git a/docs/_static/view_task.png b/docs/_static/view_task.png index d728c577ae0f4fd89a5ff9c2cde6afcf01f97474..d9c6a7f97373f13a1a1afe2ad936734ec7b9daf9 100644 Binary files a/docs/_static/view_task.png and b/docs/_static/view_task.png differ diff --git a/docs/_static/view_task_failed.png b/docs/_static/view_task_failed.png index 12094e3b48bd7aa939e8d8ed319c1053362e8c1e..e7abe422c874e7650061099796777830ba30c514 100644 Binary files a/docs/_static/view_task_failed.png and b/docs/_static/view_task_failed.png differ diff --git a/docs/conf.py b/docs/conf.py index aca2f36a76dd1fd8588e95c2133f5d91e00a84fe..55ae990703ec0f4b9a44353ec94e5e3493b91707 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -102,7 +102,11 @@ html_theme = "alabaster" # further. For a list of options available for each theme, see the # documentation. # -html_theme_options = {"description": "Control System Entry", "fixed_sidebar": True} +html_theme_options = { + "logo": "CS_entry_v02_blue.svg", + "description": "Control System Entry", + "fixed_sidebar": True, +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/index.rst b/docs/index.rst index 70033b8fa85da012ae590fae9894e1ef7a1b33cb..7e06cce6a6cdee988abf712e7c54fe88e4ba373c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to CSEntry's documentation! -=================================== +Control System Entry +==================== Release v\ |version|. @@ -22,7 +22,7 @@ You need to login with your ESS username to access the application. Note that some screenshots might show the https://csentry-test.esss.lu.se address. This is a test instance of CSEntry. It can be used by anyone for testing. You can add and edit data. But the database might be erased at any time! Don't rely on it to keep your data and don't mix it with the official application. -You can easily identify it by the **CSEntry-test** displayed in red in the navigation bar. +You can easily identify it by the animated **TEST!** displayed next to the logo in the navigation bar. .. image:: _static/csentry-test.png diff --git a/docs/inventory.rst b/docs/inventory.rst index f74a93920989563b786f4b8e55f3136d7413b7dd..877db21190ec478c12098b0960481b8cb44db753 100644 --- a/docs/inventory.rst +++ b/docs/inventory.rst @@ -85,7 +85,6 @@ The complete list of fields that can be searched is the following: - macs - host - stack_member - - history - comments Check the elasticsearch `query string syntax`_ for more details. diff --git a/docs/network.rst b/docs/network.rst index fa7f70874e34de7abe8edc9e907ddc67b1868fa9..050d6bb54d9c102d1a6308af3df1bf415e72d54c 100644 --- a/docs/network.rst +++ b/docs/network.rst @@ -70,7 +70,6 @@ The complete list of fields that can be searched is the following: - description - items - interfaces - - ansible_vars - ansible_groups Check the elasticsearch `query string syntax`_ for more details. @@ -92,6 +91,7 @@ To register a new host, you should: .. image:: _static/register_host.png If you need more than one interface, you should go to the *Add interface* pane from the *View host* page. +**Note that the main interface shall have the same name as the host.** .. image:: _static/add_interface.png