Skip to content
Snippets Groups Projects
Commit 62292a0a authored by Benjamin Bertrand's avatar Benjamin Bertrand
Browse files

Update documentation

parent 3f3b43a7
No related branches found
No related tags found
No related merge requests found
docs/_static/add_interface.png

421 KiB | W: | H:

docs/_static/add_interface.png

442 KiB | W: | H:

docs/_static/add_interface.png
docs/_static/add_interface.png
docs/_static/add_interface.png
docs/_static/add_interface.png
  • 2-up
  • Swipe
  • Onion skin
docs/_static/create_item.png

402 KiB | W: | H:

docs/_static/create_item.png

138 KiB | W: | H:

docs/_static/create_item.png
docs/_static/create_item.png
docs/_static/create_item.png
docs/_static/create_item.png
  • 2-up
  • Swipe
  • Onion skin
docs/_static/create_vioc.png

411 KiB

docs/_static/create_vm.png

400 KiB

docs/_static/create_vm_confirmation.png

404 KiB

docs/_static/csentry-test.png

329 KiB

docs/_static/edit_item_stack_member.png

419 KiB

docs/_static/item_created.png

393 KiB | W: | H:

docs/_static/item_created.png

135 KiB | W: | H:

docs/_static/item_created.png
docs/_static/item_created.png
docs/_static/item_created.png
docs/_static/item_created.png
  • 2-up
  • Swipe
  • Onion skin
docs/_static/register_host.png

404 KiB | W: | H:

docs/_static/register_host.png

433 KiB | W: | H:

docs/_static/register_host.png
docs/_static/register_host.png
docs/_static/register_host.png
docs/_static/register_host.png
  • 2-up
  • Swipe
  • Onion skin
docs/_static/view_host_network.png

407 KiB

...@@ -19,9 +19,12 @@ You need to login with your ESS username to access the application. ...@@ -19,9 +19,12 @@ You need to login with your ESS username to access the application.
.. image:: _static/login.png .. image:: _static/login.png
Note that some screenshos might show the https://csentry-test.esss.lu.se address. This is a test instance of CSEntry. 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! 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. 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.
.. image:: _static/csentry-test.png
Please use the navigation sidebar on the left to begin. Please use the navigation sidebar on the left to begin.
......
...@@ -3,12 +3,14 @@ ...@@ -3,12 +3,14 @@
Network Network
======= =======
Overview
--------
CSEntry allows to register networks and hosts. CSEntry allows to register networks and hosts.
A **network scope** defines a range of VLAN and a supernet where **networks** can be assigned. A **network scope** defines a range of VLAN and a supernet where **networks** can be assigned.
A **host** can be a physical or virtual machine. It includes one or more **interfaces**. A **host** can be a physical or virtual machine. It includes one or more **interfaces**.
.. image:: _static/network.png .. image:: _static/network.png
Clicking on an **hostname** will take you to the *View host* page. Clicking on an **hostname** will take you to the *View host* page.
...@@ -18,6 +20,18 @@ Clicking on an **hostname** will take you to the *View host* page. ...@@ -18,6 +20,18 @@ Clicking on an **hostname** will take you to the *View host* page.
On that page you can see all the host's details. On that page you can see all the host's details.
You can add extra interfaces, edit the existing interfaces or edit the host information. You can add extra interfaces, edit the existing interfaces or edit the host information.
For network switches, you can see the list of stack members.
.. image:: _static/view_host_network.png
Stack members should be defined by linking an item to an host from the inventory *Edit item* page:
.. image:: _static/edit_item_stack_member.png
Register a new host
-------------------
To register a new host, you should: To register a new host, you should:
1. Enter a hostname. 1. Enter a hostname.
...@@ -26,10 +40,33 @@ To register a new host, you should: ...@@ -26,10 +40,33 @@ To register a new host, you should:
4. Choose the network for the primary interface. The first available IP address on that network is automatically filled. 4. Choose the network for the primary interface. The first available IP address on that network is automatically filled.
You should not modify it except if you have a specific reason. You should not modify it except if you have a specific reason.
5. For physical machines, you have to enter the MAC address. A random one is automatically generated for virtual machines. 5. For physical machines, you have to enter the MAC address. A random one is automatically generated for virtual machines.
6. Click Submit. 6. If the host is an IOC, you should select the **IOC** tag. It should be selected by default depending on the device type. Unselect it otherwise.
7. Click Submit.
.. image:: _static/register_host.png .. 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. If you need more than one interface, you should go to the *Add interface* pane from the *View host* page.
.. image:: _static/add_interface.png .. image:: _static/add_interface.png
DNS and DHCP update
-------------------
Any creation or update of an host will automatically trigger an update of the core services on the Technical Network (DNS and DHCP).
VM creation
-----------
This is currently restricted to admin users!
From the *View host* page, you can trigger the creation of a Virtual machine:
.. image:: _static/create_vm.png
If the host is an IOC (the interface should have the **IOC** tag), the form will be slightly different:
.. image:: _static/create_vioc.png
In both case, a confirmation dialog will be displayed when you submit the form.
.. image:: _static/create_vm_confirmation.png
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment