diff --git a/.spelling b/.spelling index d6459b17ae..ce32296438 100644 --- 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 index c17b09b701..c728d858ba 100644 --- a/docs/details/commands/pmm-admin.md +++ b/docs/details/commands/pmm-admin.md @@ -345,8 +345,8 @@ 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. @@ -354,14 +354,14 @@ When you remove a service, collected data remains on PMM Server for the specifie `--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 index 9503d37131..bad92a8684 100644 --- 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 index 77fc4f6766..eb1d6b93ff 100644 --- 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 index 5f82b7e38b..ba9ec291bb 100644 --- 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. - > Caution 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. + +> Important 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 new file mode 100644 index 0000000000..33732cea62 --- /dev/null +++ b/docs/release-notes/2.17.0.md @@ -0,0 +1,74 @@ +# Percona Monitoring and Management 2.17.0 + + + + + + + + + + + + + + + + +
Date:May 11, 2021
Installation: + Installing Percona Monitoring and Management
+ +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 index 0fda3897fc..ea1231dd92 100644 --- 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 index 19d7cbfb0f..19ad65a055 100644 --- 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 index 5f807922ff..23ab0c744f 100644 --- 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 index fb071505e1..8ecaea00fc 100644 --- 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:admin@127.0.0.1 --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`. diff --git a/docs/setting-up/server/dbaas.md b/docs/setting-up/server/dbaas.md index e8cf4c230c..63f6b14ae8 100644 --- a/docs/setting-up/server/dbaas.md +++ b/docs/setting-up/server/dbaas.md @@ -40,13 +40,13 @@ ln -s /usr/local/sbin/minikube /usr/sbin/minikube alias kubectl='minikube kubectl --' ``` -## Start PMM server with DBaaS activated +## Start PMM server and activate a DBaaS feature -> - To start a fully-working 3 node XtraDB cluster, consisting of sets of 3x ProxySQL, 3x PXC and 6x PMM Client containers, you will need at least 9 vCPU available for minikube. (1x vCPU for ProxySQL and PXC and 0.5vCPU for each pmm-client containers). +> - To start a fully-working 3 node XtraDB cluster, consisting of sets of 3x HAProxy, 3x PXC and 6x PMM Client containers, you will need at least 9 vCPU available for minikube. (1x vCPU for HAProxy and PXC and 0.5vCPU for each pmm-client containers). > > - DBaaS does not depend on PMM Client. > -> - Setting the environment variable `PERCONA_TEST_DBAAS=1` enables DBaaS functionality. +> - You can pass the environment variable `--env ENABLE_DBAAS=1` to force the DBaaS feature when starting up pmm-server container. **You can omit the variable and enable the feature later using PMM UI**, please follow the link in step 3. below. > > - Add the option `--network minikube` if you run PMM Server and minikube in the same Docker instance. (This will share a single network and the kubeconfig will work.) > @@ -55,7 +55,7 @@ alias kubectl='minikube kubectl --' 1. Start PMM server: ```sh - docker run --detach --publish 80:80 --publish 443:443 --name pmm-server --env PERCONA_TEST_DBAAS=1 percona/pmm-server:2 + docker run --detach --publish 80:80 --publish 443:443 --name pmm-server percona/pmm-server:2 ``` 2. Change the default administrator credentials from CLI: @@ -66,6 +66,10 @@ alias kubectl='minikube kubectl --' docker exec -t pmm-server bash -c 'ln -s /srv/grafana /usr/share/grafana/data; chown -R grafana:grafana /usr/share/grafana/data; grafana-cli --homepath /usr/share/grafana admin reset-admin-password ' ``` +3. ***IMPORTANT***: *Please follow instructions on* [**How to activate the *DBaaS* feature in Advanced Settings of PMM**](../../using/platform/dbaas.md#activate-a-dbaas-feature). + + You need to enable the feature using PMM UI if you omitted `--env ENABLE_DBAAS=1` when starting up the container. + ## Install Percona operators in minikube 1. Configure and start minikube: @@ -90,16 +94,10 @@ alias kubectl='minikube kubectl --' # Install the PXC operator curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/{{op.pxc_vers}}/deploy/bundle.yaml \ | kubectl apply -f - - curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/{{op.pxc_vers}}/deploy/secrets.yaml \ - | sed "s/pmmserver:.*/pmmserver: ${PMM_PASS}/g" \ - | kubectl apply -f - # Install the PSMDB operator curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/{{op.psmdb_vers}}/deploy/bundle.yaml \ | kubectl apply -f - - curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/{{op.psmdb_vers}}/deploy/secrets.yaml \ - | sed "s/PMM_SERVER_USER:.*$/PMM_SERVER_USER: ${PMM_USER}/g;s/PMM_SERVER_PASSWORD:.*$/PMM_SERVER_PASSWORD: ${PMM_PASS}/g;" \ - | kubectl apply -f - ``` 3. Check the operators are deployed: @@ -139,16 +137,10 @@ alias kubectl='minikube kubectl --' # Install the PXC operator curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/{{op.pxc_vers}}/deploy/bundle.yaml \ | kubectl apply -f - - curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/{{op.pxc_vers}}/deploy/secrets.yaml \ - | sed "s/pmmserver:.*/pmmserver: ${PMM_PASS}/g" \ - | kubectl apply -f - # Install the PSMDB operator curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/{{op.psmdb_vers}}/deploy/bundle.yaml \ | kubectl apply -f - - curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/{{op.psmdb_vers}}/deploy/secrets.yaml \ - | sed "s/PMM_SERVER_USER:.*$/PMM_SERVER_USER: ${PMM_USER}/g;s/PMM_SERVER_PASSWORD:.*$/PMM_SERVER_PASSWORD: ${PMM_PASS}/g;" \ - | kubectl apply -f - ``` ``` @@ -270,9 +262,7 @@ You should have an account on GCP [https://cloud.google.com/](https://cloud.goog ``` curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/pmm-branch/deploy/bundle.yaml | kubectl apply -f - - curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-xtradb-cluster-operator/pmm-branch/deploy/secrets.yaml | kubectl apply -f - curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/pmm-branch/deploy/bundle.yaml | kubectl apply -f - - curl -sSf -m 30 https://raw.githubusercontent.com/percona/percona-server-mongodb-operator/pmm-branch/deploy/secrets.yaml | kubectl apply -f - ``` ![](../../_images/PMM_DBaaS_GKE_11.png) @@ -366,7 +356,7 @@ You should have an account on GCP [https://cloud.google.com/](https://cloud.goog ``` docker run --detach --name pmm-server --publish 80:80 --publish 443:443 \ - --env PERCONA_TEST_DBAAS=1 perconalab/pmm-server-fb:PR-1240-07bef94; + --env ENABLE_DBAAS=1 perconalab/pmm-server-fb:PR-1240-07bef94; ``` 14. Login into PMM and navigate to DBaaS @@ -385,6 +375,8 @@ You should have an account on GCP [https://cloud.google.com/](https://cloud.goog You should delete all installation operators as the operators own resources. +> If a Public Address is set in PMM Settings, for each DB cluster an API Key is created which can be found on the page `/graph/org/apikeys`. You should not delete them (for now, until [issue PMM-8045](https://jira.percona.com/browse/PMM-8045) is fixed) -- once a DB cluster is removed from DBaaS, the related API Key is also removed. + If you only run `eksctl delete cluster` without cleaning up the cluster first, there will be a lot of orphaned resources as Cloud Formations, Load Balancers, EC2 instances, Network interfaces, etc. In the `pmm-managed` repository, in the deploy directory there are 2 example bash scripts to install and delete the operators from the EKS cluster. @@ -401,11 +393,9 @@ KUBECTL_CMD="kubectl --kubeconfig ${HOME}/.kube/config_eks" # Install the PXC operator cat ${TOP_DIR}/deploy/pxc_operator.yaml | ${KUBECTL_CMD} apply -f - -cat ${TOP_DIR}/deploy/secrets.yaml | sed "s/pmmserver:.*=/pmmserver: ${PMM_PASS}/g" | ${KUBECTL_CMD} apply -f - # Install the PSMDB operator cat ${TOP_DIR}/deploy/psmdb_operator.yaml | ${KUBECTL_CMD} apply -f - -cat ${TOP_DIR}/deploy/secrets.yaml | sed "s/PMM_SERVER_USER:.*$/PMM_SERVER_USER: ${PMM_USER}/g;s/PMM_SERVER_PASSWORD:.*=$/PMM_SERVER_PASSWORD: ${PMM_PASS}/g;" | ${KUBECTL_CMD} apply -f - ``` The delete script: @@ -420,11 +410,9 @@ KUBECTL_CMD="kubectl --kubeconfig ${HOME}/.kube/config_eks" # Delete the PXC operator cat ${TOP_DIR}/deploy/pxc_operator.yaml | ${KUBECTL_CMD} delete -f - -cat ${TOP_DIR}/deploy/secrets.yaml | sed "s/pmmserver:.*=/pmmserver: ${PMM_PASS}/g" | ${KUBECTL_CMD} delete -f - # Delete the PSMDB operator cat ${TOP_DIR}/deploy/psmdb_operator.yaml | ${KUBECTL_CMD} delete -f - -cat ${TOP_DIR}/deploy/secrets.yaml | sed "s/PMM_SERVER_USER:.*$/PMM_SERVER_USER: ${PMM_USER}/g;s/PMM_SERVER_PASSWORD:.*=$/PMM_SERVER_PASSWORD: ${PMM_PASS}/g;" | ${KUBECTL_CMD} delete -f - ``` (Both scripts are similar except the install script command is `apply` while in the delete script it is `delete`.) @@ -456,7 +444,7 @@ eksctl delete cluster --name=your-cluster-name 1. Start PMM server from a feature branch: ```sh - docker run --detach --name pmm-server --publish 80:80 --publish 443:443 --env PERCONA_TEST_DBAAS=1 percona/pmm-server:2; + docker run --detach --name pmm-server --publish 80:80 --publish 443:443 --env ENABLE_DBAAS=1 percona/pmm-server:2; ``` > Important @@ -509,4 +497,4 @@ kubectl expose deployment hello-world --type=NodePort. [ALPHA]: https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha [GOOGLE_EXPOSING_APPS]: https://cloud.google.com/kubernetes-engine/docs/how-to/exposing-apps [KUBERNETES_ACCESS_APP]: https://kubernetes.io/docs/tasks/access-application-cluster/service-access-application-cluster/ -[STANDALONE_MYSQL_K8S]: https://medium.com/@chrisedrego/setting-up-a-standalone-mysql-instance-on-kubernetes-exposing-it-using-nginx-ingress-controller-262fc7af593a \ No newline at end of file +[STANDALONE_MYSQL_K8S]: https://medium.com/@chrisedrego/setting-up-a-standalone-mysql-instance-on-kubernetes-exposing-it-using-nginx-ingress-controller-262fc7af593a diff --git a/docs/setting-up/server/docker.md b/docs/setting-up/server/docker.md index f6fe1b26b9..b961ef36c9 100644 --- a/docs/setting-up/server/docker.md +++ b/docs/setting-up/server/docker.md @@ -34,10 +34,10 @@ We maintain a [Docker image for PMM Server][DOCKERHUB]. This section shows how t --volumes-from pmm-data --name pmm-server \ percona/pmm-server:2 ``` - > Optionally you can enable http (insecure) by including `--publish 80:80` in the above docker run command however note that PMM Client *requires* TLS to communication with the server so will only work on the secure port. - + > Optionally you can enable http (insecure) by including `--publish 80:80` in the above docker run command however note that PMM Client *requires* TLS to communication with the server so will only work on the secure port. + You can disable manual updates via the Home Dashboard *PMM Upgrade* panel by adding `-e DISABLE_UPDATES=true` to the `docker run` command. - + 4. In a web browser, visit *https://server hostname*:443 (or *//server hostname*:80 if optionally enabled) to see the PMM user interface. @@ -47,36 +47,36 @@ We maintain a [Docker image for PMM Server][DOCKERHUB]. This section shows how t It is possible to change some server setting by using environment variables when starting the Docker container. Use `-e var=value` in your pmm-server run command. -|Variable|Description| -|-----|-----| -|`DISABLE_UPDATES`|Disable automatic updates| -|`DISABLE_TELEMETRY`|Disable built-in telemetry and disable STT if telemetry is disabled| -|`METRICS_RESOLUTION`|High metrics resolution in seconds| -|`METRICS_RESOLUTION_HR`|High metrics resolution (same as above)| -|`METRICS_RESOLUTION_MR`|Medium metrics resolution in seconds| -|`METRICS_RESOLUTION_LR`|Low metrics resolution in seconds| -|`DATA_RETENTION`|How many days to keep time-series data in ClickHouse| -|`ENABLE_VM_CACHE`|Enable cache in VM| -|`ENABLE_ALERTING`|Enable integrated alerting| -|`ENABLE_AZUREDISCOVER`|Enable support for discovery of Azure databases| -|`ENABLE_BACKUP_MANAGEMENT`|Enable integrated backup tools| -|`PERCONA_TEST_SAAS_HOST`|SaaS server hostname| -|`PERCONA_TEST_DBAAS`|Enable testing DBaaS features. (Will be deprecated in future versions.)| -|`ENABLE_DBAAS`|Enable DBaaS features| -|`PMM_DEBUG`|Enables a more verbose log level| -|`PMM_TRACE`|Enables a more verbose log level including traceback information| +| Variable | Description | +| -------------------------- | ----------------------------------------------------------------------- | +| `DISABLE_UPDATES` | Disable automatic updates | +| `DISABLE_TELEMETRY` | Disable built-in telemetry and disable STT if telemetry is disabled | +| `METRICS_RESOLUTION` | High metrics resolution in seconds | +| `METRICS_RESOLUTION_HR` | High metrics resolution (same as above) | +| `METRICS_RESOLUTION_MR` | Medium metrics resolution in seconds | +| `METRICS_RESOLUTION_LR` | Low metrics resolution in seconds | +| `DATA_RETENTION` | How many days to keep time-series data in ClickHouse | +| `ENABLE_VM_CACHE` | Enable cache in VM | +| `ENABLE_ALERTING` | Enable integrated alerting | +| `ENABLE_AZUREDISCOVER` | Enable support for discovery of Azure databases | +| `ENABLE_BACKUP_MANAGEMENT` | Enable integrated backup tools | +| `PERCONA_TEST_SAAS_HOST` | SaaS server hostname | +| `PERCONA_TEST_DBAAS` | Enable testing DBaaS features. (Will be deprecated in future versions.) | +| `ENABLE_DBAAS` | Enable DBaaS features | +| `PMM_DEBUG` | Enables a more verbose log level | +| `PMM_TRACE` | Enables a more verbose log level including trace-back information | #### Ignored variables These variables will be ignored by `pmm-managed` when starting the server. If any other variable is found, it will be considered invalid and the server won't start. -|Variable|Description| -|-----|-----| -|`_`, `HOME`, `HOSTNAME`, `LANG`, `PATH`, `PWD`, `SHLVL`, `TERM`|Default environment variables| -|`GF_*`|Grafana's environment variables| -|`SUPERVISOR_`|Supervisord environment variables| -|`PERCONA_TEST_`|Unknown variable but won't prevent the server to start| -|`PERCONA_TEST_DBAAS`|Deprecated. Use ENABLE_DBAAS| +| Variable | Description | +| --------------------------------------------------------------- | ------------------------------------------------------ | +| `_`, `HOME`, `HOSTNAME`, `LANG`, `PATH`, `PWD`, `SHLVL`, `TERM` | Default environment variables | +| `GF_*` | Grafana's environment variables | +| `SUPERVISOR_` | Supervisord environment variables | +| `PERCONA_TEST_` | Unknown variable but won't prevent the server to start | +| `PERCONA_TEST_DBAAS` | Deprecated. Use `ENABLE_DBAAS` | ## Backup and upgrade diff --git a/docs/setting-up/server/index.md b/docs/setting-up/server/index.md index 7bb1ac1837..679c0b2301 100644 --- a/docs/setting-up/server/index.md +++ b/docs/setting-up/server/index.md @@ -25,3 +25,19 @@ Choose how you want to run PMM Server: - [on an Amazon AWS EC2 instance](aws.md) When PMM Server is running, set up [PMM Client](../client/index.md) for each node or service. + +## Single line installer + +> Caution This is a [technical preview](../../details/glossary.md#technical-preview) and is subject to change. + +```sh +curl -fsSL https://raw.githubusercontent.com/percona/pmm/PMM-2.0/get-pmm.sh -o get-pmm2.sh ; chmod +x get-pmm2.sh ; ./get-pmm2.sh +``` + +> Warning We highly recommend you review `get-pmm2.sh` prior to running on your system, to ensure the content is as expected. + +This command will: + +- if Docker is not already installed, install it +- if there is a PMM Server docker container running, stop it and back it up +- pull and run the latest PMM Server docker image diff --git a/docs/using/platform/dbaas.md b/docs/using/platform/dbaas.md index 7aff888861..292921430f 100644 --- a/docs/using/platform/dbaas.md +++ b/docs/using/platform/dbaas.md @@ -6,12 +6,14 @@ The DBaaS dashboard is where you add, remove, and operate on Kubernetes and database clusters. -> You must run PMM Server with a DBaaS feature flag to activate the features described here. +## Activate a DBaaS feature + +**To activate the *DBaaS* feature**, select {{ icon.bars }} *PMM* --> *PMM Settings* --> *Advanced settings*. +Then turn on the DBaaS feature by clicking on {{ icon.toggleoff }} toggle in the *Technical preview features* section of the page. To open the DBaaS dashboard: -- From the main menu, select {{ icon.bars }} *PMM* --> *PMM DBaaS*; -- Or, from the left menu, select {{ icon.database }} *DBaaS*. +- From the left menu, select {{ icon.database }} *DBaaS*. ![](../../_images/PMM_DBaaS_Kubernetes_Cluster_Panel.jpg) diff --git a/mkdocs-netlify.yml b/mkdocs-netlify.yml index dfc6497834..32c181249b 100644 --- a/mkdocs-netlify.yml +++ b/mkdocs-netlify.yml @@ -201,6 +201,7 @@ nav: - faq.md - Release Notes: - release-notes/index.md + - release-notes/2.17.0.md - release-notes/2.16.0.md - release-notes/2.15.1.md - release-notes/2.15.0.md diff --git a/mkdocs-pdf.yml b/mkdocs-pdf.yml index 120af007c6..c9f2cbcb45 100644 --- a/mkdocs-pdf.yml +++ b/mkdocs-pdf.yml @@ -39,9 +39,9 @@ plugins: glob: - setting-up/client/docker.md # Moved to setting-up/client/index.md - with-pdf: # https://github.com/orzih/mkdocs-with-pdf - output_path: '_pdf/PerconaMonitoringAndManagement-2.16.0.pdf' + output_path: '_pdf/PerconaMonitoringAndManagement-2.17.0.pdf' cover_title: 'Documentation' - cover_subtitle: 2.16.0 (April 15, 2021) + cover_subtitle: 2.17.0 (May 11, 2021) author: 'Percona Technical Documentation Team' cover_logo: docs/_images/PMM_Logo.svg debug_html: false @@ -164,6 +164,7 @@ nav: - faq.md - Release Notes: - release-notes/index.md + - release-notes/2.17.0.md - release-notes/2.16.0.md - release-notes/2.15.1.md - release-notes/2.15.0.md diff --git a/mkdocs.yml b/mkdocs.yml index 3df78b62a5..c7a92e4cc4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -184,6 +184,7 @@ nav: - faq.md - Release Notes: - release-notes/index.md + - release-notes/2.17.0.md - release-notes/2.16.0.md - release-notes/2.15.1.md - release-notes/2.15.0.md diff --git a/variables.yml b/variables.yml index a4d8962859..02eb653f89 100644 --- a/variables.yml +++ b/variables.yml @@ -1,8 +1,8 @@ # PMM Version for HTML # See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path -release: '2.16.0' -version: '2.16' -release_date: 2021-04-15 +release: '2.17.0' +version: '2.17' +release_date: 2021-05-11 # Setting Up/Server/DBaaS operator versions op: @@ -67,6 +67,7 @@ icon: checks: dashboards: inventory: + toggleoff: '' node: addinstance: pad: