Skip to content

Remove trailing whitespaces in the markdown files of the documentation #10152

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

Merged
merged 1 commit into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all 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 doc/01-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,3 @@ Read more about development builds in the [development chapter](21-development.m
Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU
General Public License Version 2. You will find a copy of this license in the
LICENSE file included in the source package.

2 changes: 1 addition & 1 deletion doc/10-icinga-template-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -3512,7 +3512,7 @@ thola_identify_discover_timeouts | **Optional.** The number of discover timeou

> **Note**:
>
> One of the variables `thola_identify_model`, `thola_identify_os_version`,
> One of the variables `thola_identify_model`, `thola_identify_os_version`,
> `thola_identify_vendor` or `thola_identify_serial_number` must be set

##### thola-memory-usage <a id="plugin-contrib-command-thola-memory-usage"></a>
Expand Down
2 changes: 1 addition & 1 deletion doc/11-cli-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Supported commands:
* api setup (setup for API)
* ca list (lists all certificate signing requests)
* ca restore (restores a removed certificate request)
* ca remove (removes an outstanding certificate request)
* ca remove (removes an outstanding certificate request)
* ca sign (signs an outstanding certificate request)
* console (Icinga debug console)
* daemon (starts Icinga 2)
Expand Down
12 changes: 6 additions & 6 deletions doc/12-icinga2-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ You can also use [jq](https://stedolan.github.io/jq/) or `python -m json.tool`
in combination with curl on the CLI.

```bash
curl ... | jq
curl ... | jq
curl ... | python -m json.tool
```

Expand Down Expand Up @@ -1658,14 +1658,14 @@ Send a `POST` request to the URL endpoint `/v1/actions/execute-command`.
--------------|------------|--------------
ttl | Number | **Required.** The time to live of the execution expressed in seconds.
command_type | String | **Optional.** The command type: `CheckCommand` or `EventCommand` or `NotificationCommand`. Default: `EventCommand`
command | String | **Optional.** The command to execute. Its type must the same as `command_type`. It can be a macro string. Default: depending on the `command_type` it's either `$check_command$`, `$event_command$` or `$notification_command$`
command | String | **Optional.** The command to execute. Its type must the same as `command_type`. It can be a macro string. Default: depending on the `command_type` it's either `$check_command$`, `$event_command$` or `$notification_command$`
endpoint | String | **Optional.** The endpoint to execute the command on. It can be a macro string. Default: `$command_endpoint$`.
macros | Dictionary | **Optional.** Macro overrides. Default: `{}`
user | String | **Optional.** The user used for the notification command.
user | String | **Optional.** The user used for the notification command.
notification | String | **Optional.** The notification used for the notification command.

Example:

```bash
curl -k -s -S -i -u root:icinga -H 'Accept: application/json' \
-X POST 'https://localhost:5665/v1/actions/execute-command' \
Expand Down Expand Up @@ -2638,7 +2638,7 @@ Name | Language | Description
[BitBar for OSX](https://getbitbar.com/plugins/Dev/Icinga2/icinga2.24m.py) | Python | macOS tray app for highlighting the host/service status
[Icinga 2 Multistatus](https://chrome.google.com/webstore/detail/icinga-multi-status/khabbhcojgkibdeipanmiphceeoiijal/related) | - | Chrome Extension
[Naglite4](https://github.com/wftech/icinga2-naglite4) | Python | Naglite3 rewrite using the Icinga 2 REST API.
[icinga-telegram-bot](https://github.com/joni1993/icinga-telegram-bot) | Python | Telegram Bot using the Icinga 2 REST API
[icinga-telegram-bot](https://github.com/joni1993/icinga-telegram-bot) | Python | Telegram Bot using the Icinga 2 REST API

### Manage Objects <a id="icinga2-api-clients-management"></a>

Expand Down
2 changes: 1 addition & 1 deletion doc/14-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Icinga DB is a set of components for publishing, synchronizing and
visualizing monitoring data in the Icinga ecosystem, consisting of:

* Icinga 2 with its `icingadb` feature enabled,
responsible for publishing monitoring data to a Redis server, i.e. configuration and its runtime updates,
responsible for publishing monitoring data to a Redis server, i.e. configuration and its runtime updates,
check results, state changes, downtimes, acknowledgements, notifications, and other events such as flapping
* The [Icinga DB daemon](https://icinga.com/docs/icinga-db),
which synchronizes the data between the Redis server and a database
Expand Down
6 changes: 3 additions & 3 deletions doc/18-library-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1648,9 +1648,9 @@ Example:
function set_x(val) {
this.x = val
}

dict = {}

set_x.call(dict, 7) /* Invokes set_x using `dict` as `this` */
```

Expand All @@ -1671,7 +1671,7 @@ Example:
function set_x(val) {
this.x = val
}

var dict = {}

var args = [ 7 ]
Expand Down
8 changes: 4 additions & 4 deletions doc/19-technical-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -1887,7 +1887,7 @@ source | String | The execution UUID

Special handling, calls `ClusterEvents::EnqueueCheck()` for command endpoint checks.
This function enqueues check tasks into a queue which is controlled in `RemoteCheckThreadProc()`.
If the `endpoint` parameter is specified and is not equal to the local endpoint then the message is forwarded to the correct endpoint zone.
If the `endpoint` parameter is specified and is not equal to the local endpoint then the message is forwarded to the correct endpoint zone.

##### Permissions

Expand Down Expand Up @@ -1932,7 +1932,7 @@ executions | Dictionary | Executions to be updated
##### Functions

**Event Sender:** `ClusterEvents::ExecutedCommandAPIHandler`, `ClusterEvents::UpdateExecutionsAPIHandler`, `ApiActions::ExecuteCommand`
**Event Receiver:** `ClusterEvents::UpdateExecutionsAPIHandler`
**Event Receiver:** `ClusterEvents::UpdateExecutionsAPIHandler`

##### Permissions

Expand Down Expand Up @@ -1962,15 +1962,15 @@ Key | Type | Description
host | String | Host name.
service | String | Service name.
execution | String | The execution ID executed.
exitStatus | Number | The command exit status.
exitStatus | Number | The command exit status.
output | String | The command output.
start | Number | The unix timestamp at the start of the command execution
end | Number | The unix timestamp at the end of the command execution

##### Functions

**Event Sender:** `ClusterEvents::ExecuteCheckFromQueue`, `ClusterEvents::ExecuteCommandAPIHandler`
**Event Receiver:** `ClusterEvents::ExecutedCommandAPIHandler`
**Event Receiver:** `ClusterEvents::ExecutedCommandAPIHandler`

##### Permissions

Expand Down
8 changes: 4 additions & 4 deletions doc/22-selinux.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,19 +116,19 @@ The policy provides a role `icinga2adm_r` for confining an user which enables an

SELinux is based on the least level of access required for a service to run. Using booleans you can grant more access in a defined way. The Icinga 2 policy package provides the following booleans.

**icinga2_can_connect_all**
**icinga2_can_connect_all**

Having this boolean enabled allows icinga2 to connect to all ports. This can be necessary if you use features which connect to unconfined services, for example the [influxdb writer](14-features.md#influxdb-writer).

**icinga2_run_sudo**
**icinga2_run_sudo**

To allow Icinga 2 executing plugins via sudo you can toogle this boolean. It is disabled by default, resulting in error messages like `execvpe(sudo) failed: Permission denied`.

**httpd_can_write_icinga2_command**
**httpd_can_write_icinga2_command**

To allow httpd to write to the command pipe of icinga2 this boolean has to be enabled. This is enabled by default, if not needed you can disable it for more security.

**httpd_can_connect_icinga2_api**
**httpd_can_connect_icinga2_api**

Enabling this boolean allows httpd to connect to the API of icinga2 (Ports labeled `icinga2_port_t`). This is enabled by default, if not needed you can disable it for more security.

Expand Down
2 changes: 1 addition & 1 deletion doc/23-migrating-from-icinga-1x.md
Original file line number Diff line number Diff line change
Expand Up @@ -804,7 +804,7 @@ define service {
}
```

Icinga 2 supports objects and (global) variables, but does not make a difference
Icinga 2 supports objects and (global) variables, but does not make a difference
between the main configuration file or any other included file.

icinga2.conf:
Expand Down
1 change: 0 additions & 1 deletion doc/24-appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -692,4 +692,3 @@ the [servicegroups](24-appendix.md#schema-livestatus-servicegroups-table-attribu

All [services](24-appendix.md#schema-livestatus-services-table-attributes) table attributes grouped with
the [hostgroups](24-appendix.md#schema-livestatus-hostgroups-table-attributes) table prefixed with `hostgroup_`.

Loading