Skip to content

Commit

Permalink
Merge branch 'staging' into MON-24024-debian-12
Browse files Browse the repository at this point in the history
  • Loading branch information
kduret authored Mar 18, 2024
2 parents 812fa51 + 8c1f559 commit 14aa8da
Show file tree
Hide file tree
Showing 628 changed files with 46,596 additions and 13,200 deletions.
14 changes: 13 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,20 @@ updates:
- package-ecosystem: github-actions
directory: '/'
schedule:
interval: weekly
interval: monthly
open-pull-requests-limit: 10
labels:
- 'dependencies'
- 'gha'

- package-ecosystem: npm
directory: '/'
schedule:
interval: weekly
open-pull-requests-limit: 10
labels:
- 'dependencies'
- 'javascript'
allow:
- dependency-type: "direct"
- dependency-type: "production"
4 changes: 2 additions & 2 deletions .github/workflows/archive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ jobs:
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Set up Node
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
with:
node-version: 20

- name: Install dependencies
uses: borales/actions-yarn@v4
uses: borales/actions-yarn@3766bb1335b98fb13c60eaf358fe20811b730a88 # v5.0.0
with:
cmd: install --frozen-lockfile

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Get changes
uses: dorny/paths-filter@0bc4621a3135347011ad047f9ecf449bf72ce2bd # v3.0.0
uses: dorny/paths-filter@ebc4d7e9ebcb0b1eb21480bb8f43113e996ac77a # v3.0.1
id: changes
with:
token: ${{ github.token }}
Expand Down Expand Up @@ -172,13 +172,13 @@ jobs:
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Set up Node
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
with:
node-version: 20
cache: yarn

- name: Install dependencies
uses: borales/actions-yarn@v4
uses: borales/actions-yarn@3766bb1335b98fb13c60eaf358fe20811b730a88 # v5.0.0
with:
cmd: install --frozen-lockfile

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ don't see something that should be in the docs, or you see something incorrect
or confusing in the docs.

- If your problem is a general question about how to configure or use Centreon,
ask in the [Slack channel](https://centreon.github.io/register-slack/) instead.
ask on [our community platform The Watch](https://thewatch.centreon.com/) instead.

- If you have an idea for a new feature or behavior change in a specific aspect
of Centreon, or have found a bug in part of Centreon, file that issue in
Expand Down
21 changes: 21 additions & 0 deletions cloud/administration/media.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
id: media
title: Managing media
---

Media are images used by the Centreon web interface. These images are used to
represent the monitored resource in a more intuitive way, propose backgrounds
for cartography modules, etc.

> You must be logged into Centreon with an administrator or editor profile.
## Adding images

To add an image in Centreon, go to **Administration > Parameters > Images** and
click **Add**.

The **Images** page is displayed.

- **Existing or new directory:** add a new folder in the image folder or choose an existing folder into which the image can be copied.
- **Image or archive:** select the image or the set of images contained in an archive that will be imported.
- **Comments:** add a description of the image.
16 changes: 16 additions & 0 deletions cloud/alerts-notifications/dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Click the **three vertical dots** menu at the top right of the widget to edit it

> In edition mode, you can easily organize your widgets by moving or resizing them. Make sure to save your changes.
### Link to Resources Status page

From the dashboard, you can click a screen pictogram at the top right of a widget: this button allows you to **See more on the Resources Status page**. It opens a new tab on the Resources Status page, with detailed information regarding the specific widget.

## Managing dashboards

> You must be in the **Dashboard library** page to get an overview of your dashboards.
Expand Down Expand Up @@ -88,3 +92,15 @@ You are using the Dashboards feature with a **viewer** or an **editor** profile:
The users you have just added now have access to your dashboard sharing, according to the profile you have set for them.

> Use the **Copy link** feature to share the dashboard URL directly with users who have access to your platform.
## List of widgets

| Widget | Description |
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Generic text | Allows you to add free text to your dashboards (section titles, information, etc.). |
| MAP - Display a view | Allows you to select and visualize a map created from the MAP module. |
| Metrics graph | Displays metrics for a given time period. |
| Resource table | Displays data on resource status and events, centralized in a table.
| Single metric | Displays the value of a single metric as a text, a gauge or a bar chart. |
| Status grid | Displays the current status of selected resources, as a grid. |
| Top/bottom | Displays the top or bottom x hosts, for a selected metric. |
Binary file modified cloud/assets/getting-started/cv_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/assets/getting-started/cv_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/assets/getting-started/cv_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/assets/getting-started/cv_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/assets/getting-started/cv_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/assets/getting-started/cv_6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/assets/getting-started/cv_7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/assets/getting-started/cv_8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/assets/getting-started/infra3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 23 additions & 16 deletions cloud/getting-started/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,28 @@ id: architecture
title: Architecture of Centreon Cloud
---

Your Centreon Cloud platform consists of a central server provided by Centreon and pollers that you install in your infrastructure.

* **Central server**:
* The central server is provided to you by Centreon, ready to use.
* The central server does not monitor resources in your infrastructure (the pollers do).
* The central server has a [user interface](interface.md), in which you can see the resources monitored by all pollers.
* You can reach the user interface from anywhere, using a web browser, at `<organization>.<region>.centreon.cloud`.
* The central server is hosted in the cloud.
* Centreon installs and upgrades central servers.

* **One or more pollers**:
* Pollers monitor resources in your infrastructure. They should be in the same network as the resources they will monitor.
* Pollers do not have a user interface (you see the pollers' activity on the central server's interface).
* Pollers are part of your infrastructure, which means better security, latency and bandwidth.
* You [install your pollers](../installation/deploy-poller.md) using a simple script.
* The communication between the central and the pollers uses HTTPS.
Your Centreon Cloud platform consists mainly of a central server provided by Centreon and pollers that you install in your infrastructure. In addition, the Centreon [CIAM](../ciam/ciam.md) module allows you to manage organizations and users, and to log in to Centreon Cloud.

![image](../assets/getting-started/infra3.png)

## Central server

* The central server is provided to you by Centreon, ready to use.
* The central server does not monitor resources in your infrastructure (the pollers do).
* The central server has a [user interface](interface.md), in which you can see the resources monitored by all pollers.
* You can reach the user interface from anywhere, using a web browser, at `<organization>.<region>.centreon.cloud`.
* The central server is hosted in the cloud.
* Centreon installs and upgrades central servers.

## One or more pollers

* Pollers monitor resources in your infrastructure. They should be in the same network as the resources they will monitor.
* Pollers do not have a user interface (you see the pollers' activity on the central server's interface).
* Pollers are part of your infrastructure, which means better security, latency and bandwidth.
* You [install your pollers](../installation/deploy-poller.md) using a simple script.
* The communication between the central and the pollers uses HTTPS.

## Centreon CIAM

* The [CIAM](../ciam/ciam.md) has a user interface that is separate from the central server's.
* Before you can use Centreon Cloud, you need to configure your organization in the CIAM, and invite your users to your platform.
26 changes: 26 additions & 0 deletions cloud/getting-started/cloud-beyond-basics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
id: cloud-beyond-basics
title: Centreon Cloud beyond basics
---

Now that you have learned the basics about Centreon Cloud, you are ready to know more about how to use it.

This list of features allows you to extend the experience!

## Organize your monitoring

Optimize your monitoring by grouping your resources strategically. Follow our [recommendations](../monitoring/groups.md) to better organize your hosts and services.

## Get an email when an alert occurs

Benefit from the [notification](../alerts-notifications/notif-configuration.md) feature to be informed when the status of your resource becomes critical for instance.

## Experiment Auto Discovery

Add your new hosts and services automatically to your platform using a discovery mechanism. Find out about the [Auto Discovery](../monitoring/discovery/introduction.md) module.

## Discover Business Edition features

The Centreon platform also provides Business modules (such as service mapping, graphical views) allowing you to monitor more complex business IT flows. These modules help you handle IT issues more efficiently and respect your SLAs.

Visit [the Centreon Editions page](https://www.centreon.com/centreon-editions/) for more information.
7 changes: 0 additions & 7 deletions cloud/getting-started/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@ id: concepts
title: Centreon basics
---

## How do I get my monitoring platform up and running?

Centreon provides you with a ready-to-use [central server](architecture.md). Before you can [start monitoring resources](monitoring.md), all you have to do is to:

1. [Install your pollers](../installation/deploy-poller.md) (following the [prerequisites](../installation/prerequisites.md)). They will monitor your resources.
2. Install the [Monitoring Connectors](../monitoring/pluginpacks.md) you will need to monitor your resources.

## What does Centreon monitor?

Centreon allows you to monitor resources. Resources can be hosts or services:
Expand Down
4 changes: 1 addition & 3 deletions cloud/getting-started/create-custom-view.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
id: create-custom-view
title: How do I create a custom view?
title: Creating your first custom view
---

## Create your first custom view

Go to the **Home > Custom Views** menu and click the pencil icon located on the far right of the interface to enable
editing mode.

Expand Down
8 changes: 2 additions & 6 deletions cloud/getting-started/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,9 @@ title: Overview of the Centreon interface

## Accessing the central server's interface

When you first connect to Centreon Cloud, use the URL and credentials that the Centreon support team has given you. The connection URL looks like this: `https://<organization>.<region>.centreon.cloud`.
To connect to Centreon Cloud for the first time, connect to the [CIAM](../ciam/ciam.md) and click on your platform in the **Applications** list on your organization's home page. You can then mark the URL as a favorite to access the platform faster.

Fill in your user name and associated password (defined via [Centreon CIAM](../ciam/ciam.md)) and click the **Connect** button:

![image](../assets/getting-started/aconnection.png)

You are now connected to the Centreon web interface.
A Centreon Cloud URL looks like this: `https://<organization>.<region>.centreon.cloud`.

## Menus

Expand Down
12 changes: 12 additions & 0 deletions cloud/getting-started/monitor-in-real-time.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: monitor-in-real-time
title: Monitoring resources in real time
---

Once you have set up your first host, go to **Monitoring > Resources Status** to follow the status of its resources in real time.

On the **Resources Status** page you can perform the following actions:

* [Acknowledge an event](../alerts-notifications/acknowledge.md), to notify your team that you have taken the problem into account.
* [Plan a downtime](../alerts-notifications/downtimes.md) on resources that you know will be offline at a certain time, to avoid receiving unnecessary alerts.
* [Perform a check on a resource](../alerts-notifications/resources-status.md#refresh-a-status) so as to refresh its status quickly.
12 changes: 6 additions & 6 deletions cloud/getting-started/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ id: monitoring
title: How do I monitor a resource?
---

Make sure you have read [Centreon basics](concepts.md) before monitoring your first resource.

## Monitoring a resource

To monitor a resource in Centreon Cloud:

1. Create the resource.
2. Link the resource to the poller you want it to be monitored by.
3. Link the resource to the correct template provided by a [Monitoring Connector](../monitoring/pluginpacks.md).
4. [Export the configuration](../monitoring/monitoring-servers/deploying-a-configuration.md). The resource appears in the **Monitoring > Resources status** page, where you can track any changes in status.

Here are a few tutorials to help you get started with your monitoring:
## See also

* [Monitor your first Linux host](monitor-linux-server-with-snmp.md)
* [Monitor your first Windows host](monitor-windows-server-with-snmp.md)
* [Monitor your first Cisco router](monitor-cisco-router-with-snmp.md)
* [Monitor a MySQL or MariaDB database](mysql_tuto.md)
* [Monitor AWS EC2 instances using autodiscovery](autodisco-aws.md)
[Tutorials](tutorials.md) are provided to help you set up your monitoring.

You may also find the following articles interesting (on our community platform The Watch):

Expand Down
12 changes: 12 additions & 0 deletions cloud/getting-started/platform.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: platform
title: Getting your platform ready
---

## How do I get my monitoring platform up and running?

1. Create your organization in Centreon [CIAM](../ciam/ciam.md). Be careful when you choose a name, as this will be part of the URL of your Centreon platform.
2. Wait while your [central server](architecture.md) is being built.
3. Invite users into your organization. They will be able to log in to your Cloud platform.
4. [Install your pollers](../installation/deploy-poller.md) (following the [prerequisites](../installation/prerequisites.md)). They will monitor your resources.
5. On your pollers, install the [Monitoring Connectors](../monitoring/pluginpacks.md) you will need to monitor your resources.
19 changes: 19 additions & 0 deletions cloud/getting-started/start-with-connectors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: start-with-connectors
title: Getting started with Monitoring Connectors
---

## Definition

Monitoring Connectors are the easiest way to monitor resources. They provide ready-to-use monitoring templates (i.e., a "pack"), and a plugin to execute checks. Read [more about Monitoring Connectors here](../monitoring/pluginpacks.md).

## Procedure

Install the Monitoring Connectors you need on each poller that will monitor resources using it.

1. To access the Monitoring Connectors catalog, go to **Configuration > Monitoring Connector Manager**.
2. To install a pack, click the **+** button in the corresponding tile.

## Troubleshooting

In case of a problem, a troubleshooting section is available in the [Monitoring Connectors section](/pp/integrations/plugin-packs/getting-started/how-to-guides/troubleshooting-plugins/). Also, feel free to ask any questions you may have on our community platform [The Watch](https://thewatch.centreon.com/).
20 changes: 20 additions & 0 deletions cloud/getting-started/start-with-pollers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: start-with-pollers
title: Getting started with pollers
---

## Definition and architecture

- Read the definition of a poller [here](../resources/glossary.md#poller).

- Go to [**Architecture of Centreon Cloud**](./architecture.md) to understand how the poller works in the Centreon Cloud infrastructure.

## Installation

1. Before you install a poller, you need to make sure the [requirements](../installation/prerequisites.md) are met.

2. Then you can follow the [installation](../installation/deploy-poller.md) procedure.

## Troubleshooting

Feel free to ask any questions you may have on our community platform [The Watch](https://thewatch.centreon.com/).
8 changes: 8 additions & 0 deletions cloud/getting-started/tutorials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: tutorials
title: Tutorials
---

import DocCardList from '@theme/DocCardList';

<DocCardList />
8 changes: 1 addition & 7 deletions cloud/graph-views/map-web-create-geoview.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,7 @@ For example, to fill in geographic coordinates for the **Central** host:
3. Click **Add**.
The new view is added to the **Geographic views** section. Click it to complete its configuration.

4. Click the **Edit** button and fill in the following **Edit view parameters**:
- Hosts
- Hosts belonging to hostgroup(s)
- Business Activity belonging to Business View(s)
- Latitude
- Longitude
- Zoom
4. Click the **Edit** button and fill in the **Edit view parameters**.

5. Click **Edit** to confirm the parameters.

Expand Down
22 changes: 18 additions & 4 deletions cloud/graph-views/map-web-create-standard-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,18 @@ The display of the **Add a Map** button in the **Map** page means that you are a
3. Click **Add** to confirm the map's creation.

The new map opens directly in the editor interface.
Now you can customize your map using the MAP editor features.

## Create a map from an existing container

You can create a view directly from a [container](#container). This is useful when you want to share the sublevel of a view to a different profile without duplicating its contents or assigning full access to the main view.

1. Right-click the container and click **Create map from container**.
2. Name the container.
3. Click Add.

Your map has been created. You can find it in the MAP homepage.

> Now you can customize your map using the MAP editor features.
## Use the MAP editor

Expand Down Expand Up @@ -69,7 +80,7 @@ Use **Widget** elements to display graphical data about the resources you monito
#### Media elements

Use **Media** elements to add:
- **Url:** allows you to add an access to a specified link.
- **URL:** allows you to add an access to a specified link.
- **Image:** allows you to customize your diagram by adding images.

1. Drag and drop the element into the drawing canvas.
Expand All @@ -92,8 +103,11 @@ Use **Link** elements to make connections between items (with anchor points):
- Service group
- Meta service

- **MAP** elements:
- Container
- **MAP** element:
- ### Container
Use containers when you want to create multiple levels of your map. Each level is represented by a container.
- In the view mode, each container becomes a map with its own status.
- In the editor mode, each level becomes a tab. Then you can navigate between containers using the different tabs.

- **BAM** elements:
- Business activity
Expand Down
Loading

0 comments on commit 14aa8da

Please sign in to comment.