Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(content): add databases & instances #145

Open
wants to merge 14 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion source/modules/assets/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Available types
racks
pdus
cables
databases
sim
global

Expand Down
3 changes: 0 additions & 3 deletions source/modules/management/database_instances.rst

This file was deleted.

29 changes: 12 additions & 17 deletions source/modules/management/databases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Databases list databases discovered by automatic inventory and those entered man
:scale: 43%


Databases can be grouped into :doc:`instances </modules/management/database_instances>`.
Databases can be grouped into :doc:`instances <tabs/database_instances>`.
An instance groups together all the databases retrieved from the same server (for example, all the databases in a MySQL instance).
This data can also be retrieved by automatic inventory or entered manually

Expand All @@ -27,67 +27,62 @@ Database
* **Active** : Yes/No
* **Database instance** : determines the database instance
* Size (Mio)
* Has backup :
* Last backup date :



The different tabs
------------------
* Has backup : Ye/No
* Last backup date :*date*


Management
~~~~~~~~~~
----------

:doc:`Management </modules/tabs/management>` of financial and administrative information,
this information is visible in the 'Management' tab on the Database's form.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
this information is visible in the 'Management' tab on the Database's form.
this information is visible in the 'Management' tab on the item's form.


Documents
~~~~~~~~~
---------

The :doc:`document </modules/management/documents>` tab lets you link different types of file to a material (PDF, txt, png, etc.)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The :doc:`document </modules/management/documents>` tab lets you link different types of file to a material (PDF, txt, png, etc.)
The :doc:`document </modules/management/documents>` tab lets you link different types of file to the current item (PDF, txt, png, etc.)

You can attach a document already uploaded to GLPI or add a new one directly from this tab.


Knowledge Base
~~~~~~~~~~~~~~
--------------

Lists all the articles in the :doc:`knowledge base </tabs/knowledgebase>` relating to the database.


Tickets
~~~~~~~
-------

View all :doc:`tickets </modules/tabs/tickets>` linked to the database


Problems
~~~~~~~~
--------

This tab refers to all databases :doc:`problems </modules/assistance/problems>`.
Problems can also be linked to tickets, projects, etc. This allows you to have a complete scenario when necessary.

Changes
~~~~~~~
-------

:doc:`Changes </modules/assistance/changes>` lists all changes related to a database. From this tab, you can't link a change directly, you can do it from **Assistance** > **Changes** > **Items**.
You can create a new change from this page, which will be linked to the material you have selected.


Notes
~~~~~
-----

:doc:`Note </modules/tabs/notes>` lets you add enriched text and attach a document.


Domains
~~~~~~~
-------

You can attach :doc:`Domains </modules/management/domains>` to the database. Domains are also linked to other objects such as records, problems, etc.


Appliances
~~~~~~~~~~
----------

:doc:`Appliances </modules/management/appliance>` include all business applications managed within GLPI and the databases linked
to them.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion source/modules/management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ The GLPI Management module is used to manage the following items:
domains
domains_records
appliance
Databases
databases
143 changes: 143 additions & 0 deletions source/modules/management/tabs/database_instances.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
Database instances
==================

A database instance groups together all the databases retrieved from the same server (for example, all the databases in a MySQL instance).


.. image:: ../images/bdd_instances_view.png
:alt: Bdd instances - global view
:align: center
:scale: 42%

.. note:: These instances can be added using the automatic inventory or manually

.. tip:: Note that if you modify a field manually, it will be considered locked.
This will prevent it from being modified the next time the automatic inventory is uploaded.

For more information, see :doc:`lock </modules/configuration/locks>`

In a database instance form, the following information is available:

.. image:: ../images/bdd_instances_details_view.png
:alt: Bdd instances - details view
:align: center
:scale: 42%

* Item type : defines the **type of item** on which the database is installed
* Item : Defines the **item** on which the database installed
* Name
* :doc:`Status </tabs/common_fields/status>`
* Associable to a ticket : Yes / Note
* :doc:`Location </tabs/common_fields/location>`
* :doc:`Database instance type </tabs/common_fields/asset_type>` (MySQL, PostgreSQL, MariaDB, etc.)
* :doc:`Technician in charge </tabs/common_fields/technician_in_charge>`
* :doc:`Manufacturer </tabs/common_fields/manufacturer>`
* :doc:`User </tabs/common_fields/user>`
* Version
* :doc:`Comments </tabs/common_fields/comments>`
* :doc:`Update source </tabs/common_fields/update_source>`
* Active : Yes / No
* Database instance category
* Has backup : Ye/No
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Has backup : Ye/No
* Has backup : Yes/No

* Last backup date :*date*
* Port
* Path


Impact Analysis
---------------

:doc:`Impact analysis <../../../tabs/impact_analysis>` enables an infrastructure diagram to be drawn up, showing the dependencies and impacts in the event of equipment loss.
This can be saved and exported


Databases
---------

:doc:`Databases <../databases>` lists all the databases present on the instance

Management
----------

:doc:`Management <../../tabs/management>` of financial and administrative information, this information is visible in the 'Management' tab on the computer's form.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:doc:`Management <../../tabs/management>` of financial and administrative information, this information is visible in the 'Management' tab on the computer's form.
:doc:`Management <../../tabs/management>` of financial and administrative information, this information is visible in the 'Management' tab on the current item's form.



Contracts
---------

GLPI supports :doc:`contracts <../contract>` management, in order to manage contract types such as loan, maintenance, support...

Contracts management allows to:

* make an inventory of all contracts related to the organization assets
* integrate contracts in GLPI financial management
* anticipate and follow contract renewal.


Documents
---------

The :doc:`document <../documents>` tab lets you link different types of file to a material (PDF, txt, png, etc.)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The :doc:`document <../documents>` tab lets you link different types of file to a material (PDF, txt, png, etc.)
The :doc:`document <../documents>` tab lets you link different types of file to the current item (PDF, txt, png, etc.)

You can attach a document already uploaded to GLPI or add a new one directly from this tab.


Knowledge Base
--------------

Lists all the articles in the :doc:`knowledge base <../../../tabs/knowledgebase>` relating to the material.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Lists all the articles in the :doc:`knowledge base <../../../tabs/knowledgebase>` relating to the material.
Lists all the articles in the :doc:`knowledge base <../../../tabs/knowledgebase>` relating to the current item.


Tickets
-------

View all :doc:`tickets <../../tabs/tickets>` linked to the computer
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
View all :doc:`tickets <../../tabs/tickets>` linked to the computer
View all :doc:`tickets <../../tabs/tickets>` linked to the current item


Problems
--------

This tab refers to all hardware-related :doc:`problems <../../assistance/problems>`.
Problems can also be linked to tickets, projects, etc. This allows you to have a complete scenario when necessary.

Changes
-------

:doc:`Changes <../../assistance/changes>` lists all changes related to a material. From this tab, you can't link a change directly, you can do it from **Assistance** > **Changes** > **Items**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:doc:`Changes <../../assistance/changes>` lists all changes related to a material. From this tab, you can't link a change directly, you can do it from **Assistance** > **Changes** > **Items**.
:doc:`Changes <../../assistance/changes>` lists all changes related to the current item. From this tab, you can't link a change directly, you can do it from **Assistance** > **Changes** > **Items**.

You can create a new change from this page, which will be linked to the material you have selected.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can create a new change from this page, which will be linked to the material you have selected.
You can create a new change from this page, which will be linked to the current item you have selected.


Links
-----

:doc:`Links <../../configuration/external_links>` offer several possibilities. Send the GLPI object file to another URL of your choice, or generate an RDP file, for example.

Certificates
------------

Link a :doc:`certificate </modules/management/certificates>` to your registration. You can manage certificates in **Management** > **Certificates**


Locks
-----

:doc:`Locks </modules/assets/tabs/locks>` are used to prevent a field from being modified when the inventory is uploaded.
You can lock/unlock the fields you wish in a GLPI object.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can lock/unlock the fields you wish in a GLPI object.
You can lock/unlock the fields you wish in a GLPI item.



Notes
-----

:doc:`Note </modules/tabs/notes>` lets you add enriched text and attach a document.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:doc:`Note </modules/tabs/notes>` lets you add enriched text and attach a document.
:doc:`Note </modules/tabs/notes>` lets you add rich-text text and attach a document.


Domains
-------

You can attach :doc:`Domains </modules/management/domains>` to your computer. Domains are also linked to other objects such as records, problems, etc.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can attach :doc:`Domains </modules/management/domains>` to your computer. Domains are also linked to other objects such as records, problems, etc.
You can attach :doc:`Domains </modules/management/domains>` to the current item. Domains are also linked to other items such as records, problems, etc.



Appliances
----------

:doc:`Appliances </modules/management/appliance>` includes all business applications managed within GLPI.
They can be linked to another GLPI object (computer, application, etc.) as well as to another appliance.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
They can be linked to another GLPI object (computer, application, etc.) as well as to another appliance.
They can be linked to another GLPI item (computer, application, etc.) as well as to another appliance.


.. include:: ../../tabs/historical.rst

.. include:: ../../tabs/all.rst
2 changes: 1 addition & 1 deletion source/modules/tabs/all.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
All Information
~~~~~~~~~~~~~~~
---------------

For an item, all information is displayed on one page from the *All* tab. This shows all of the tabs of an object's form in one view, one below the other.
2 changes: 1 addition & 1 deletion source/modules/tabs/historical.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
History
~~~~~~~
-------

The *History* tab is used to show any changes made to an item. The following information about the changes is available:

Expand Down