README.md 5.36 KB
Newer Older
1
# Centreon Connectors
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
2
3
4
5

Centreon Connectors are extremely fast open-source monitoring check
execution daemons designed to work with
[Centreon Engine](https://github.com/centreon/centreon-engine).
6
7
8

It is a low-level component of the
[Centreon software suite](https://www.centreon.com).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
9

10
Centreon Connectors are released under the Apache Software License version 2
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
11
12
13
14
and is endorsed by the [Centreon company](https://www.centreon.com).

There are currently two open-source connectors :

15
- **Centreon Connector Perl** : persistent Perl interpreter that
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
16
  executes Perl plugins very fast
17
- **Centreon Connector SSH** : maintain SSH connexions opened to reduce
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
18
19
  overhead of plugin execution over SSH

20
## Documentation
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
21

22
*Coming soon on https://docs.centreon.com*
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
23

24
## Installing from binaries
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
25

26
27
28
> Centreon Connectors is a low-level component of the Centreon
> software suite. If this is your first installation you would probably
> want to [install it entirely](https://docs.centreon.com/current/en/installation/installation-of-a-central-server/using-sources.html).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
29
30
31

Centreon ([the company behind the Centreon software suite](http://www.centreon.com))
provides binary packages for RedHat / CentOS. They are available either
32
33
as part of the [Centreon Platform](https://www.centreon.com/en/platform/)
or as individual packages on [our RPM repository](https://docs.centreon.com/current/en/installation/installation-of-a-poller/using-packages.html).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
34
35

Once the repository installed a simple command will be needed to install
36
the connectors:
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
37

38
39
40
```shell
yum install centreon-connector-perl centreon-connector-ssh
```
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
41

42
## Fetching sources
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
43
44
45
46

Beware that the repository hosts in-developement sources and that it
might not work at all.

47
48
Stable releases are available as gziped tarballs on [Centreon's
download site](https://download.centreon.com).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
49

50
## Compilation
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
51
52

This paragraph is only a quickstart guide for the compilation of
53
Centreon Clib.
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
54
55
56
57

Centreon Connectors need Centreon Clib to be build. You should
[install it first](https://github.com/centreon/centreon-clib).

58
### CentOS / Debian / Raspbian
59
60

Compilation of this distribution is pretty straightforward.
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
61

62
63
64
65
66
67
68
69
You'll need to download the project and launch the *cmake.sh* script
to prepare the compilation environment:

```shell
git clone https://github.com/centreon/centreon-connectors
cd centreon-connectors
./cmake.sh
```
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
70
71

Now launch the compilation using the *make* command and then install the
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
software by running *make install* as priviledged user:

```shell
cd build
make
make install
```

### Other distributions

If you are on another distribution, then follow the steps below.

Check if you have these packages installed (Note that packages names
come from CentOS distributions, so if some packages names don't match
on your distribution try to find their equivalent names): git, make,
cmake, gcc-c++.

For the projet compilation you need to have conan installed. Try to use
the package manager given by your OS to install conan. ('apt' for
Debian, 'rpm' for Red Hat, 'pacman' for Arch Linux, ...). It is prefered
to install gcc before conan.

Example:

```shell
apt install conan
```

If it does not work, conan can be installed with pip3:
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
101

102
103
104
```shell
pip3 install conan
```
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
105

106
107
108
> All the dependencies pulled by conan are located in conanfile.txt. If
> you want to use a dependency from your package manager instead of conan,
> you need to remove it from conanfile.txt.
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
109

110
111
112
113
114
115
You can now prepare the compilation environment:

```shell
git clone https://github.com/centreon/centreon-connectors
mkdir -p centreon-connectors/build
cd centreon-connectors/build
116
conan install --build missing ..
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
cmake -DCMAKE_BUILD_TYPE=Release -DWITH_PREFIX_BINARY=/usr/lib64/centreon-connector -DWITH_TESTING=On ..
```

This will look for required dependencies and print a summary of the
compilation parameters if everything went fine.

Now launch the compilation using the *make* command and then install the
software by running *make install* as priviledged user:

```shell
make
make install
```

You're done!

## Bug reports / Feature requests
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
134

135
136
The best way to report a bug or to request a feature is to open an issue
in GitHub's [issue tracker](https://github.com/centreon/centreon-connectors/issues/).
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
137

138
Please note that Centreon Connectors follows the
139
[same workflow as Centreon](https://github.com/centreon/centreon/issues/new/choose)
140
141
to process issues.

142
For a quick resolution of a bug your message should contain:
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
143

144
145
- The problem description
- Precise steps on how to reproduce the issue (if you're using Centreon
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
146
  web UI tell us where you click)
147
148
149
150
- The expected behavior
- The Centreon product**s** version**s**
- The operating system you're using (name and version)
- If possible configuration, log and debug files
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
151

152
## Contributing
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
153

154
Contributions are much welcome! If possible provide them as
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
155
pull-requests on GitHub. If not, patches will do but describe against
156
which version/commit they apply.
Matthieu Kermagoret's avatar
Matthieu Kermagoret committed
157
158

For any question or remark feel free to send a mail to the project
159
160
161
162
163
maintainers:

<a href="https://github.com/bouda1"><img src="https://avatars1.githubusercontent.com/u/6324413?s=400&v=4" title="David Boucher" width="80" height="80"></a> &nbsp;
<a href="https://github.com/rem31"><img src="https://avatars.githubusercontent.com/u/73845199?s=460&v=4" title="Rémi Gres" width="80" height="80"></a> &nbsp;
<a href="https://github.com/centreonpm"><img src="https://avatars.githubusercontent.com/u/73105891?s=460&v=4" title="Pierre Margale" width="80" height="80"></a> &nbsp;