From 3318934674b71d53f9501c4aaf980e0faff3d7f0 Mon Sep 17 00:00:00 2001 From: Sean Newman Date: Sun, 24 Jan 2021 06:10:17 -0500 Subject: [PATCH 1/3] Document Kibana sorting method (#270) --- docs/checks/adding_teams.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/checks/adding_teams.md b/docs/checks/adding_teams.md index c4c888d3b..134aabedf 100644 --- a/docs/checks/adding_teams.md +++ b/docs/checks/adding_teams.md @@ -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 --------------------- From 98aa5e45fca50045eb64ccd9ca715629995d928d Mon Sep 17 00:00:00 2001 From: Sean Newman Date: Sun, 24 Jan 2021 06:25:27 -0500 Subject: [PATCH 2/3] Document FreeBSD's SSH quirk (#272) --- docs/reference/ssh.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/reference/ssh.md b/docs/reference/ssh.md index 16b2d2029..e31d56d2e 100644 --- a/docs/reference/ssh.md +++ b/docs/reference/ssh.md @@ -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 | \ No newline at end of file +| 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. \ No newline at end of file From b357b0cc40cab443395a64deaff5f87a15fc37d1 Mon Sep 17 00:00:00 2001 From: Sean Newman Date: Sun, 24 Jan 2021 06:34:12 -0500 Subject: [PATCH 3/3] Update CHANGELOG --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 767615994..dbd993836 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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