2.17.0 (#478)

* PMM-7762 backup (#437) * PMM-7762 * PMM-7762 * PMM-7762 * PMM-7576 (#440) * PMM-7769 Release Notes 2.16.0 (#433) * PMM-7769 Release Notes 2.16.0 * PMM-7769 Copied from gdoc * Formatting * Update 2.16.0.md * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * PMM-7769 * Update 2.16.0.md * Update mkdocs.yml * Update variables.yml * Update docs/release-notes/2.16.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.16.0.md Co-authored-by: Roma Novikov <[email protected]> * PMM-7769 Formatting * PMM-7769 Punctuation and grammar Co-authored-by: Roma Novikov <[email protected]> Co-authored-by: Steve Hoffman <[email protected]> * Add netlify config for RN previews * Show 2.16 items hidden in main * PMM-7772 STT Intervals (#446) * PMM-7868 Settings (#448) * PMM-7868 * PMM-7868 Add image * Update 2.16.0.md (#451) Changes in the highlights order and added one more item * Update dbaas.md * Update index.md * Update docker.md * PMM-7875 Add asset * PMM-7875 Embed video (#449) * Dark mode switcher * Colours * Link to favicon source * Avoid github rate limits * Remove old (low-res) favicon * Release date change * PMM-1626 Running PMM Server as Docker on servers with no internet connection (#450) * PMM-1626 WIP * PMM-1626 * PMM-7353 Remove secrets.yaml (#452) * PMM-7353 Remove secrets.yaml * PMM-7353 Mention that PMM creates API keys. * Update dbaas.md * Update docs/setting-up/server/dbaas.md Co-authored-by: PaulJacobs-percona <[email protected]> Co-authored-by: PaulJacobs-percona <[email protected]> * Dark mode switcher * Colours * PMM-7013 Use HAProxy instead of ProxySQL (#457) We use HAProxy as a default proxy for PXC cluster instead of ProxySQL now. * PMM-7847 MySQL TLS doc. (#458) * Merging * Colours * Merging * Separate pdf config (#453) * Separate config for PDF * Separate config for PDF avoids editing * Netlify build status widget * Remove old PDF config * Update * Update 2.16.0.md (#454) PMM-7464 was merged after we created RN * Revert "PMM-7353 Remove secrets.yaml (#452)" (#455) This reverts commit f4c4176. * PMM-7641 (#456) * Remove HTML comments * Dark mode switcher * Colours * Merging * Separate pdf config (#453) * Separate config for PDF * Separate config for PDF avoids editing * Netlify build status widget * Update * PMM-7820 DBaaS on/off warning (#459) * PMM-7820 Add toggle to enable/disable DBaaS (#465) * PMM-7820 Add toggle to enable/disable DBaaS * fix spelling, add toggleoff icon * omited -> omitted Co-authored-by: Tiago Mota Santos <[email protected]> Co-authored-by: Tiago Mota Santos <[email protected]> * PMM-7883 Single line installer (#469) * PMM-7883 * PMM-7883 * Update index.md Fix branch/path to installer script * Update index.md (#474) * Update index.md Add *WARNING* footnote, given the "one-liner" and recent issues with other providers, we need to ensure the user is fully aware of the implications of running scripts in their environment, however I will note a +1 for not piping directly into a shell at least. * Update index.md Co-authored-by: PaulJacobs-percona <[email protected]> * PMM-7353 dbaas api key (#477) * PMM-7966 Update telemetry docs (#467) * Update mkdocs-netlify.yml Use default material theme table styling * Update mkdocs.yml Note about use of plugin * PMM-7319 add external service add instance description for UI (#471) * PMM-7319 add external service add instance description for UL * Update external.md Co-authored-by: PaulJacobs-percona <[email protected]> * Discord channel for communications (#472) * PMM-7353 WIP * PMM-7533 No more secrets * PMM-7353 note about deleting keys Co-authored-by: Palash Nigam <[email protected]> Co-authored-by: Roman Misyurin <[email protected]> Co-authored-by: Denys Kondratenko <[email protected]> * PMM-7848 (#476) * PMM-8050 Release Notes 2.17.0 (#475) * PMM-8050 Release Notes 2.17.0 * PMM-8050 Merge dups, formatting, links * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * PMM-8050 Co-authored-by: Roma Novikov <[email protected]> * Update 2.17.0.md * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Steve Hoffman <[email protected]> * Rearrange contact points * Update mkdocs-pdf.yml * Update variables.yml * Update 2.17.0.md * PMM-8050 Spelling * Table formatting (helps spell checker) * Spelling * Spelling and formatting * Fix table formatting * Spelling * Update docs/release-notes/2.17.0.md * Update docs/release-notes/2.17.0.md Co-authored-by: Steve Hoffman <[email protected]> * Update docs/release-notes/2.17.0.md Co-authored-by: Roma Novikov <[email protected]> Co-authored-by: Steve Hoffman <[email protected]> Co-authored-by: Nurlan Moldomurov <[email protected]> Co-authored-by: Jan Prukner <[email protected]> Co-authored-by: JiriCtvrtka <[email protected]> Co-authored-by: Tiago Mota Santos <[email protected]> Co-authored-by: David Busby <[email protected]> Co-authored-by: Palash Nigam <[email protected]> Co-authored-by: Roman Misyurin <[email protected]> Co-authored-by: Denys Kondratenko <[email protected]>
percona · May 11, 2021 · 7b0ac7c · 7b0ac7c
1 parent 8bd3f7c
commit 7b0ac7c
Show file tree

Hide file tree

Showing 18 changed files with 202 additions and 84 deletions.
diff --git a/.spelling b/.spelling
@@ -83,6 +83,7 @@ md
 memtable
 metadata
 minikube
+misconfiguration
 MMAPv1
 mongod
 MongoDB

diff --git a/docs/details/commands/pmm-admin.md b/docs/details/commands/pmm-admin.md
@@ -345,23 +345,23 @@ When you remove a service, collected data remains on PMM Server for the specifie
     `--size-slow-logs=N`
     : Rotate slow log file at this size. If `0`, use server-defined default. Negative values disable log rotation. A unit suffix must be appended to the number and can be one of:
 
-		- `KB`, `kB`, `MB`, `mB`, `GB`, `gB`, `TB`, `tB` for base 10 units (1000, 1000000, etc);
-		- `KiB`, `MiB`, `GiB`, `TiB` for base 2 units (1024, 1048576, etc).
+        - `KB`, `kB`, `MB`, `mB`, `GB`, `gB`, `TB`, `tB` for base 10 units (1000, 1000000, etc);
+        - `KiB`, `MiB`, `GiB`, `TiB` for base 2 units (1024, 1048576, etc).
 
     `--disable-queryexamples`
     : Disable collection of query examples.
 
     `--disable-tablestats`
     : Disable table statistics collection.
 
-    	Excluded collectors for low-resolution time intervals:
+        Excluded collectors for low-resolution time intervals:
 
-	    - `--collect.auto_increment.columns`
-      - `--collect.info_schema.tables`
-      - `--collect.info_schema.tablestats`
-	    - `--collect.perf_schema.indexiowaits`
-	    - `--collect.perf_schema.tableiowaits`
-      - `--collect.perf_schema.file_instances`
+        - `--collect.auto_increment.columns`
+        - `--collect.info_schema.tables`
+        - `--collect.info_schema.tablestats`
+        - `--collect.perf_schema.indexiowaits`
+        - `--collect.perf_schema.tableiowaits`
+        - `--collect.perf_schema.file_instances`
 
 	Excluded collectors for medium-resolution time intervals:
 
@@ -392,6 +392,27 @@ When you remove a service, collected data remains on PMM Server for the specifie
     `--tls-skip-verify`
     : Skip TLS certificates validation.
 
+    `--tls-cert-file=PATHTOCERT`
+    : Path to TLS client certificate file.
+
+    `--tls-key=PATHTOCERTKEY`
+    : Key for TLS client certificate file.
+
+    `--tls-ca-file=PATHTOCACERT`
+    : Path to certificate authority file.
+
+    `--ssl-ca=PATHTOCACERT`
+    : The path name of the Certificate Authority (CA) certificate file. If used must specify the same certificate used by the server. (-ssl-capath is similar but specifies the path name of a directory of CA certificate files.)
+
+    `--ssl-cert=PATHTOCERTKEY`
+    : The path name of the client public key certificate file.
+
+    `--ssl-key`
+    : The path name of the client private key file.
+
+    `--ssl-skip-verify`
+    : Skip SSL certificate verification.
+
     `--metrics-mode=mode`
     : Metrics flow mode for agents node-exporter. Allowed values:
         - `auto`: chosen by server (default)

diff --git a/docs/details/glossary.md b/docs/details/glossary.md
@@ -53,7 +53,7 @@ Security Threat Tool.
 
 ## Technical Preview
 
-Releases intended for public preview and feedback but with no support or SLAs. Should not be used on production or business-critical systems. May contain breaking changes to UI, API, CLI. ([Read more](https://www.percona.com/services/policies/percona-release-lifecycle-overview).)
+Releases intended for public preview and feedback but with no support or service level agreement (SLA). Should not be used on production or business-critical systems. May contain breaking changes to UI, API, CLI. ([Read more](https://www.percona.com/services/policies/percona-release-lifecycle-overview).)
 
 ## VG
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -2,8 +2,8 @@
 
 ## How can I contact the developers?
 
-- [Discord channel](https://discord.gg/qSRxH4Xu).
 - [Community forum](https://www.percona.com/forums/questions-discussions/percona-monitoring-and-management).
+- [Discord channel](https://discord.gg/qSRxH4Xu).
 - [PMM project in JIRA](https://jira.percona.com/projects/PMM).
 
 ## What are the minimum system requirements for PMM?

diff --git a/docs/how-to/configure.md b/docs/how-to/configure.md
@@ -103,7 +103,7 @@ As well as via the *PMM Settings* page, you can also disable telemetry with the
 
 > - If the Security Threat Tool is enabled in PMM Settings, Telemetry is automatically enabled.
 >
-> - Telemetry is sent immediately; the 24-hour grace period is not honored.
+> - Telemetry is sent immediately; the 24 hour grace period is not honored.
 
 ### Check for updates
 
@@ -145,10 +145,13 @@ The address or hostname PMM Server will be accessible at. Click *Get from browse
 
 ### DBaaS
 
-Enables DBaaS features on this server.
-
 > <b style="color:goldenrod">Caution</b> DBaaS functionality is a technical preview that must be turned on with a server feature flag. See [DBaaS](../setting-up/server/dbaas.md).
 
+Enables/disables [DBaaS features](../using/platform/dbaas.md) on this server.
+
+> <b style="color:goldenrod">Important</b> Deactivating DBaaS ***does not*** suspend or remove running DB clusters.
+
+
 ### Integrated Alerting
 
 Enables [Integrated Alerting](../using/alerting.md) and reveals the [Communication](#communication) tab.

diff --git a/docs/release-notes/2.17.0.md b/docs/release-notes/2.17.0.md
@@ -0,0 +1,74 @@
+# Percona Monitoring and Management 2.17.0
+
+<table class="docutils field-list" frame="void" rules="none">
+  <colgroup>
+    <col class="field-name">
+    <col class="field-body">
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field-odd field">
+      <th class="field-name">Date:</th>
+      <td class="field-body">May 11, 2021</td>
+    </tr>
+    <tr class="field-even field">
+      <th class="field-name">Installation:</th>
+      <td class="field-body">
+        <a class="reference external" href="https://www.percona.com/software/pmm/quickstart">Installing Percona Monitoring and Management</a></td>
+    </tr>
+  </tbody>
+</table>
+
+Percona Monitoring and Management (PMM) is a free and open-source platform for managing and monitoring MySQL, MongoDB, and PostgreSQL performance.
+
+## Release Highlights
+
+- Custom certificates help define proper security levels for remotely monitored MySQL instances, including Google Cloud SQL.
+
+- Usability improvements to the External Monitoring UI. When filling parameters, you can enter the parts of an endpoint (scheme, host, path) or let PMM automatically extract them from a URL.
+
+- pg_stat_monitor 0.9.0 support. This change will give you compatibility with the latest version. Support for new features will be in an upcoming release.
+
+- Single-line install of PMM Server on supported Linux distributions (this feature is in Technical Preview).
+
+- DBaaS Changes: (this feature is in Technical Preview)
+    - It is easier to experience DBaaS functionality; you can quickly turn it ON/OFF in *Advanced settings* on the *Settings* page. ([Read more](../how-to/configure.md#advanced-settings))
+    - Database components management will enable PMM administrators to limit users in your organization to specific (admin-approved) database versions in their DBaaS DB Clusters.
+    - For PXC clusters created using DBaaS, HAProxy will now be used by default.  Please note: Monitoring of the HAProxy in DBaaS will be enabled in an upcoming release.
+
+- Changes to *Sign in to Percona Platform*. From this release, Registration of the Percona account will be more secure and require additional confirmation.
+
+
+
+## New Features
+
+* [PMM-7863](https://jira.percona.com/browse/PMM-7863): DBaaS: Ability to specify in K8s configuration the version of HAProxy to be used for DB creation
+* [PMM-7848](https://jira.percona.com/browse/PMM-7848), [PMM-7847](https://jira.percona.com/browse/PMM-7847), [PMM-7421](https://jira.percona.com/browse/PMM-7421): Add support for using SSL certificates between pmm-admin and monitored MySQL databases
+* [PMM-7883](https://jira.percona.com/browse/PMM-7883): Single-line install of PMM Server on supported Linux distributions - [Technical Preview]
+* [PMM-7013](https://jira.percona.com/browse/PMM-7013), [PMM-7819](https://jira.percona.com/browse/PMM-7819): DBaaS: Use HAProxy by default instead of ProxySQL for MySQL DB clusters
+* [PMM-7356](https://jira.percona.com/browse/PMM-7356), [PMM-7581](https://jira.percona.com/browse/PMM-7581): DBaaS: Management of available versions of DB components
+* [PMM-7358](https://jira.percona.com/browse/PMM-7358), [PMM-7576](https://jira.percona.com/browse/PMM-7576): DBaaS: Management of default versions of DB components
+
+
+## Improvements
+
+* [PMM-7572](https://jira.percona.com/browse/PMM-7572): Add TLS options to mysqld_exporter
+* [PMM-7783](https://jira.percona.com/browse/PMM-7783): Support of pg_stat_monitor 0.9.0
+* [PMM-7064](https://jira.percona.com/browse/PMM-7064): Integrated Alerting: Presenting severity of the Alert Rule using different colors
+* [PMM-7946](https://jira.percona.com/browse/PMM-7946): Better error message on PMM client if server doesn't support HAProxy
+* [PMM-7932](https://jira.percona.com/browse/PMM-7932): Usability improvements on UI for adding External Services
+* [PMM-7641](https://jira.percona.com/browse/PMM-7641), [PMM-7820](https://jira.percona.com/browse/PMM-7820): Add DBaaS to Technical Preview section and allow user to Enable/Disable via UI
+* [PMM-7966](https://jira.percona.com/browse/PMM-7966): Telemetry: Collect enabled/disabled status for Integrated Alerting and Security Threat Tool features
+
+## Bugs Fixed
+
+* [PMM-7911](https://jira.percona.com/browse/PMM-7911): DBaaS: Invalid Number of Nodes results in an annoying error message pop-up
+* [PMM-7884](https://jira.percona.com/browse/PMM-7884): DBaaS: Fix DB Cluster tab loading
+* [PMM-7917](https://jira.percona.com/browse/PMM-7917): PostgreSQL exporter has high CPU usage during Restart
+* [PMM-8037](https://jira.percona.com/browse/PMM-8037): User can create a Percona Platform account without proper confirmation
+* [PMM-7702](https://jira.percona.com/browse/PMM-7702): DBaaS: Cannot edit already-created PSMDB clusters
+* [PMM-7991](https://jira.percona.com/browse/PMM-7991): MySQL Summary panel doesn't exist on MySQL Summary dashboard
+* [PMM-7939](https://jira.percona.com/browse/PMM-7939): Inconsistent format of version reporting in pmm-admin
+* [PMM-7920](https://jira.percona.com/browse/PMM-7920): PostgreSQL Exporter has increased memory usage with pmm-client 2.15.1 & pmm-server 2.16.0
+* [PMM-7700](https://jira.percona.com/browse/PMM-7700): Integrated Alerting: Rule API crashing with more than two parameters or invalid values
+* [PMM-7616](https://jira.percona.com/browse/PMM-7616): Integrated Alerting: Incorrect title of the page in a browser
+* [PMM-7396](https://jira.percona.com/browse/PMM-7396): Integrated Alerting: Alerts tab error if user deletes Alert Rule which has Firing alerts
diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md
@@ -1,5 +1,6 @@
 # Release Notes
 
+* [Percona Monitoring and Management 2.17.0](2.17.0.md)
 * [Percona Monitoring and Management 2.16.0](2.16.0.md)
 * [Percona Monitoring and Management 2.15.1](2.15.1.md)
 * [Percona Monitoring and Management 2.15.0](2.15.0.md)

diff --git a/docs/setting-up/client/azure.md b/docs/setting-up/client/azure.md
@@ -113,4 +113,4 @@ PMM can use 3 exporters to collect metrics:
 
 - `mysql_exporter` or `postgres_exporter` – to collect database related metrics.
 
-- PMM Agent to collect queries related metrics using pg_stat_statements for PostgreSQL or Performance Schema for MySQL (MariaDB)
+- PMM Agent to collect queries related metrics using [`pg_stat_statements`](postgresql.md#pg-stat-statements) for PostgreSQL or Performance Schema for MySQL (MariaDB)
diff --git a/docs/setting-up/client/external.md b/docs/setting-up/client/external.md
@@ -64,13 +64,16 @@ Please see more details here: https://prometheus.io/docs/instrumenting/writing_e
 ### Examples
 
 ```sh
-root@mysql1:~# pmm-admin add external --group=processess  --listen-port=9256
+root@mysql1:~# pmm-admin add external --group=processes  --listen-port=9256
 External Service added.
 Service ID  : /service_id/6485f4fd-745b-4dfb-8b72-328e300f8b50
-Service name: mysql1-processess
-Group       : processess
+Service name: mysql1-processes
+Group       : processes
 ```
-Add exporter running on local port 9256 to the group called "processess"  use group name and host name to automatically generate service name.  Use default scheme and metrics path.
+
+- Add an exporter running on local port 9256 to the group called `processes`.
+- Use the group and host names to automatically generate a service name.
+- Use the default scheme and metrics path.
 
 ## Adding an External service via UI
 
@@ -81,12 +84,11 @@ Add exporter running on local port 9256 to the group called "processess"  use gr
     ![](../../_images/PMM_External_Serverless.png)
 
 3. Fill the form and set the external service endpoint.
-    
+
     The endpoint can be set manually:
 
     ![](../../_images/PMM_External_Serverless_switcher_manually.png)
-    
+
     or by parsing required data from a URL string, in which case you only need to pass a valid URL.
-
-    ![](../../_images/PMM_External_Serverless_switcher.png)
 
+    ![](../../_images/PMM_External_Serverless_switcher.png)
diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md
@@ -354,6 +354,12 @@ With the PMM user interface, you select *Use performance schema*, or deselect it
 
 Add the database server as a service using one of these example commands. If successful, PMM Client will print `MySQL Service added` with the service's ID and name. Use the `--environment` and `-custom-labels` options to set tags for the service to help identify them.
 
+**Examples -- TLS connection**
+
+```sh
+sudo pmm-admin add mysql --username=user --password=pass --tls --tls-skip-verify --tls-ca=pathtoca.pem --tls-cert=pathtocert.pem --tls-key=pathtocertkey.pem --server-url=http://admin:[email protected] --query-source=perfschema name localhost:3306
+```
+
 **Examples -- Slow query log**
 
 Default query source (`slowlog`), service name (`{node name}-mysql`), and service address/port (`127.0.0.1:3306`), with database server account `pmm` and password `pass`.
-Original file line number
+Diff line change
@@ Expand Up / @@ -53,7 +53,7 @@ Security Threat Tool. @@
     ## Technical Preview
-    Releases intended for public preview and feedback but with no support or SLAs. Should not be used on production or business-critical systems. May contain breaking changes to UI, API, CLI. ([Read more](https://www.percona.com/services/policies/percona-release-lifecycle-overview).)
+    Releases intended for public preview and feedback but with no support or service level agreement (SLA). Should not be used on production or business-critical systems. May contain breaking changes to UI, API, CLI. ([Read more](https://www.percona.com/services/policies/percona-release-lifecycle-overview).)
     ## VG
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -113,4 +113,4 @@ PMM can use 3 exporters to collect metrics:

		- `mysql_exporter` or `postgres_exporter` – to collect database related metrics.

		- PMM Agent to collect queries related metrics using pg_stat_statements for PostgreSQL or Performance Schema for MySQL (MariaDB)
		- PMM Agent to collect queries related metrics using [`pg_stat_statements`](postgresql.md#pg-stat-statements) for PostgreSQL or Performance Schema for MySQL (MariaDB)