Skip to content

Add a few notes to the docs #285

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.

Sign up for GitHub

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
s-newman merged 3 commits into from
Jan 24, 2021
Merged

Add a few notes to the docs #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3318934
Document Kibana sorting method (#270)
s-newman Jan 24, 2021
98aa5e4
Document FreeBSD's SSH quirk (#272)
s-newman Jan 24, 2021
b357b0c
Update CHANGELOG
s-newman Jan 24, 2021
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Each section organizes entries into the following subsections:
- Removed outdated `jvm.options` configurations (#276)
- Fixed permissions for Kibana plugin installation (#282)
- Set default for `fqdn` Terraform variable (#282)
- Explained Kibana sorting method (#285)
- Documented FreeBSD's behavior with SSH check (#285)

#### Removed

Expand Down
4 changes: 4 additions & 0 deletions docs/checks/adding_teams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ Once these values are correct for your environment, you can run `add-team.sh`. E

In this case, three teams will be added: `team01`, `team02`, and `team03`.

> Kibana sorts team names in alphabetical order. If your team names are numbered (i.e., `team01`, `team02`, `team03`, etc.) then you should left-pad with zeros so all teams have the same number of digits. If you don't left-pad, the order in which teams appear in Kibana will be counterintuitive.
>
> For example, if you have 12 teams you should number them like `team01`, `team05`, `team10`, etc. instead of `team1`, `team5`, `team10` for sorting to appear correctly.

Adding Multiple Teams
---------------------

Expand Down
7 changes: 6 additions & 1 deletion docs/reference/ssh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,9 @@ SSH
| Cmd | String | Y | The command to execute once SSH connection established |
| MatchContent | String | N :: "false" | Whether or not to match content like checking files |
| ContentRegex | String | N :: "\.\*" | Tegex to match if reading a file |
| Port | String | N :: "22" | The port to attempt an SSH connection on |
| Port | String | N :: "22" | The port to attempt an SSH connection on |

Notes on FreeBSD
----------------

SSH checks will fail on standard FreeBSD installations. This is because by default, FreeBSD does not enable `password` authentication for SSH. In order to fix this issue, you must ensure that `PasswordAuthentication yes` is set in your `/etc/ssh/sshd_config` file.