From a1bcc81fa376af537c26f10d48f253a3b540954d Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Fri, 29 Nov 2024 14:05:07 +0200 Subject: [PATCH 1/7] added topics --- .../install-pmm-client/index.md | 55 +++ .../install-pmm-client/mysql/self-hosted.md | 443 ++++++++++++++++++ .../install-pmm-client/repositories.md | 86 ++++ .../install-pmm-server/docker-easy-install.md | 48 ++ .../install-pmm-server/docker.md | 73 +++ mkdocs-base.yml | 30 ++ 6 files changed, 735 insertions(+) create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/index.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/repositories.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-server/docker-easy-install.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-server/docker.md diff --git a/docs/install-pmm/install-prototype/install-pmm-client/index.md b/docs/install-pmm/install-prototype/install-pmm-client/index.md new file mode 100644 index 0000000000..248641aed6 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/index.md @@ -0,0 +1,55 @@ +# Set up PMM Client + +To make Percona Monitoring and Management (PMM) work properly a **PMM Client** needs to be set up in your database environment. This client acts as the messenger, relaying back the key performance insights from your database to the PMM Server. + +Depending on your setup, PMM Client may already be set up requiring only authentication or you may need to install it entirely. To understand what needs to be done in your system, select the database technology you're using first. + +## Select your database technology and host + +Select the database technology you're using so we can direct you to the best set up of your PMM Client and start collecting data signals back to PMM Server. + + +``` mermaid +graph RL +PS(PMM Server) +subgraph s2[Now: Step 2] + DB[(Database)] -- Data collection --> PC(PMM Client) +end +PC -- Transmission --> PS +``` + +=== ":material-dolphin: MySQL" + + For MySQL check the type of host that you have for your database and follow the instructions required to set up PMM Client. + + | *Host* | *Recommended set up* | *Other advanced options* | + | --------------------- | ----------------------------------- | ------------------------------ | + | **Self-hosted / AWS EC2** | [**Install PMM Client using Percona Repositories** :material-arrow-right:](./install-pmm-client/percona-repositories.md) | [Using a PMM Client Docker image](#)

[Download and install PMM Client files](#) | + | **AWS RDS / AWS Aurora** | [**Configure AWS settings** :material-arrow-right:](#) | + | **Azure Database for MySQL** | [**Configure Azure Settings** :material-arrow-right:](#) | + | **Google Cloud SQL for MySQL** | [**Configure Google Cloud Settings** :material-arrow-right:](#) | + | **Other hosts / No access to the node** | [**Remote monitoring** :material-arrow-right:](#) | + +=== ":material-elephant: PostgreSQL" + + PostgreSQL links here... + +=== ":material-leaf: MongoDB" + + MongoDB links here... + +=== ":material-database: ProxySQL" + + ProxySQL links here... + +=== ":material-database: HAproxy" + + HAproxy links here... + +=== ":simple-linux: Linux" + + Directly in Linux links here... + +=== "Other technologies" + + Others' links here... \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md b/docs/install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md new file mode 100644 index 0000000000..5831496eb6 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md @@ -0,0 +1,443 @@ +# Connect a self-hosted or an AWS EC2 MySQL database to PMM + +PMM Client collects metrics from MySQL, Percona Server for MySQL, Percona XtraDB Cluster, and MariaDB. Amazon RDS is also supported and explained in [this section](#). + +--- + +## Create a database account for PMM + +It is good practice to use a non-superuser account to connect PMM Client to the monitored database instance. These examples create a database user with name `pmm`, password `pass`, and the necessary permissions. + +##### On MySQL 8.0 + +```sql +CREATE USER 'pmm'@'127.0.0.1' IDENTIFIED BY 'pass' WITH MAX_USER_CONNECTIONS 10; +GRANT SELECT, PROCESS, REPLICATION CLIENT, RELOAD, BACKUP_ADMIN ON *.* TO 'pmm'@'127.0.0.1'; +``` + +##### On MySQL 5.7 + +```sql +CREATE USER 'pmm'@'127.0.0.1' IDENTIFIED BY 'pass' WITH MAX_USER_CONNECTIONS 10; +GRANT SELECT, PROCESS, REPLICATION CLIENT, RELOAD ON *.* TO 'pmm'@'127.0.0.1'; +``` + +--- + +## Choose and configure a source + +Decide which source of metrics to use, and configure your database server for it. The choices are [Slow query log](#slow-query-log) and [Performance Schema](#performance-schema). + +While you can use both at the same time we recommend using only one--there is some overlap in the data reported, and each incurs a small performance penalty. The choice depends on the version and variant of your MySQL instance, and how much detail you want to see. + +Here are the benefits and drawbacks of *Slow query log* and *Performance Schema* metrics sources. + +| | Benefits | Drawbacks +|---|---|------------- +| **Slow query log** | 1. More detail.
2. Lower resource impact (with query sampling feature in Percona Server for MySQL). | 1. PMM Client must be on same host as database server or have access to slow query log.
2. Log files grow and must be actively managed. +| **Performance Schema** | 1. Faster parsing.
2. Enabled by default on newer versions of MySQL. | 1. Less detail. + +### Data source recommendations + +| Database server | Versions | Recommended source | +|--------------------------|----------------|--------------------| +| MySQL | 5.1-5.5 | Slow query log | +| MySQL | 5.6+ | Performance Schema | +| MariaDB | 10.0+ | Performance Schema | +| Percona Server for MySQL | 5.7, 8.0 | Slow query log | +| Percona XtraDB Cluster | 5.6, 5.7, 8.0 | Slow query log | + +### Slow query log + +This section covers how to configure a MySQL-based database server to use the *slow query log* as a source of metrics. + +### Applicable versions + +| Server | Versions | +|--------------------------|------------------| +| MySQL | 5.1-5.5 | +| MariaDB | 10.1.2+ | +| Percona Server for MySQL | 5.7.10+, 8.0.12+ | +| Percona XtraDB Cluster | 5.6, 5.7, 8.0 | + +The *slow query log* records the details of queries that take more than a certain amount of time to complete. With the database server configured to write this information to a file rather than a table, PMM Client parses the file and sends aggregated data to PMM Server via the Query Analytics part of PMM Agent. + +### Settings + +| Variable | Value |Description +|-----------------------------------------------------------------|--------|---------------------------------------------------------- +| [`slow_query_log`][sysvar_slow_query_log] | ON | Enables the slow query log. +| [`log_output`][sysvar_log_output] |`'FILE'`| Ensures the log is sent to a file. (This is the default on MariaDB.) +| [`long_query_time`][sysvar_long_query_time] | 0 | The slow query threshold in seconds. In heavily-loaded applications, many quick queries can affect performance more than a few slow ones. Setting this value to `0` ensures all queries are captured. +| [`log_slow_admin_statements`][sysvar_log_slow_admin_statements] | ON | Includes the logging of slow administrative statements. +| [`log_slow_slave_statements`][sysvar_log_slow_slave_statements] | ON | Enables logging for queries that have taken more than `long_query_time` seconds to execute on the replica. + +#### Examples + +Configuration file: + +```ini +slow_query_log=ON +log_output=FILE +long_query_time=0 +log_slow_admin_statements=ON +log_slow_slave_statements=ON +``` + +Session: + +```sql +SET GLOBAL slow_query_log = 1; +SET GLOBAL log_output = 'FILE'; +SET GLOBAL long_query_time = 0; +SET GLOBAL log_slow_admin_statements = 1; +SET GLOBAL log_slow_slave_statements = 1; +``` + +#### Slow query log — Extended + +Some MySQL-based database servers support extended slow query log variables. + +##### Applicable versions + +| Server | Versions +|--------------------------|----------------- +| Percona Server for MySQL | 5.7.10+, 8.0.12+ +| Percona XtraDB Cluster | 5.6, 5.7, 8.0 +| MariaDB | 10.0 + +##### Settings + +| Variable | Value | Description +|--------------------------------------------------------------------------|-------|----------------------------------------------------------------------------------- +| [`log_slow_rate_limit`][log_slow_rate_limit] | 100 | Defines the rate of queries captured by the *slow query log*. A good rule of thumb is 100 queries logged per second. For example, if your Percona Server instance processes 10,000 queries per second, you should set `log_slow_rate_limit` to `100` and capture every 100th query for the *slow query log*. Depending on the amount of traffic, logging could become aggressive and resource consuming. This variable throttles the level of intensity of the data capture without compromising information. +| [`log_slow_rate_type`][log_slow_rate_type] |'query'| Set so that it applies to queries, rather than sessions. +| [`slow_query_log_always_write_time`][slow_query_log_always_write_time] | 1 | Specifies which queries should ignore sampling. With query sampling this ensures that queries with longer execution time will always be captured by the slow query log, avoiding the possibility that infrequent slow queries might not get captured at all. +| [`log_slow_verbosity`][log_slow_verbosity] |'full' | Ensures that all information about each captured query is stored in the slow query log. +| [`slow_query_log_use_global_control`][slow_query_log_use_global_control] |'all' | Configure the slow query log during runtime and apply these settings to existing connections. (By default, slow query log settings apply only to new sessions.) + +##### Examples + +Configuration file (Percona Server for MySQL, Percona XtraDB Cluster): + + ```ini + log_slow_rate_limit=100 + log_slow_rate_type='query' + slow_query_log_always_write_time=1 + log_slow_verbosity='full' + slow_query_log_use_global_control='all' + ``` + +Configuration file (MariaDB): + + ```ini + log_slow_rate_limit=100 + ``` + +Session (Percona Server for MySQL, Percona XtraDB Cluster): + + ```sql + SET GLOBAL log_slow_rate_limit = 100; + SET GLOBAL log_slow_rate_type = 'query'; + SET GLOBAL slow_query_log_always_write_time = 1; + SET GLOBAL log_slow_verbosity = 'full'; + SET GLOBAL slow_query_log_use_global_control = 'all'; + ``` + +#### Slow query log rotation + +Slow query log files can grow quickly and must be managed. + +When adding a service with the command line use the `pmm-admin` option `--size-slow-logs` to set at what size the slow query log file is rotated. (The size is specified as a number with a suffix. See [`pmm-admin add mysql`](../../details/commands/pmm-admin.md#mysql).) + +When the limit is reached, PMM Client will: + +- remove the previous `.old` slow log file, +- rename the current file by adding the suffix `.old`, +- execute the MySQL command `FLUSH LOGS`. + +Only one `.old` file is kept. Older ones are deleted. + +You can manage log rotation yourself, for example, with [`logrotate`][LOGROTATE]. If you do, you can disable PMM Client's log rotation by providing a negative value to `--size-slow-logs` option when adding a service with `pmm-admin add`. + +### Performance Schema + +This section covers how to configure a MySQL-based database server to use *Performance Schema* as a source of metrics. + +#### Applicable versions + +| Server | Versions +|--------------------------|----------------------------------------- +| Percona Server for MySQL | 5.6, 5.7, 8.0 +| Percona XtraDB Cluster | 5.6, 5.7, 8.0 +| MariaDB | [10.3+][mariadb_perfschema_instr_table] + +PMM's [*MySQL Performance Schema Details* dashboard](../../details/dashboards/dashboard-mysql-performance-schema-details.md) charts the various [`performance_schema`][performance-schema-startup-configuration] metrics. + +To use *Performance Schema*, set the variables below. + +!!! caution alert alert-warning "Important" + Make sure to restart pmm-agent after making any changes to MySQL perfschema. + +| Variable | Value | Description +|--------------------------------------------------------------------------------------------|--------------------|--------------------------------------------------------------------------------- +| [`performance_schema`][sysvar_performance_schema] | `ON` | Enables *Performance Schema* metrics. This is the default in MySQL 5.6.6 and higher. +| [`performance-schema-instrument`][perfschema-instrument] | `'statement/%=ON'` | Configures Performance Schema instruments. +| [`performance-schema-consumer-statements-digest`][perfschema-consumer-statements-digest] | `ON` | Configures the `statements-digest` consumer. +| [`innodb_monitor_enable`][sysvar_innodb_monitor_enable] | all | Enables InnoDB metrics counters. + +#### Examples + +Configuration file: + + ```ini + performance_schema=ON + performance-schema-instrument='statement/%=ON' + performance-schema-consumer-statements-digest=ON + innodb_monitor_enable=all + ``` + +Session: + + (`performance_schema` cannot be set in a session and must be set at server start-up.) + + ```sql + UPDATE performance_schema.setup_consumers + SET ENABLED = 'YES' WHERE NAME LIKE '%statements%'; + SET GLOBAL innodb_monitor_enable = all; + ``` + +#### MariaDB 10.5.7 or lower + +There is no *Explain* or *Example* data shown by default in Query Analytics when monitoring MariaDB instances version 10.5.7 or lower. A workaround is to set this variable. + +| Variable | Value | Description +|---------------------------------------------------------------------------|-----------------|----------------------------- +| [`performance_schema.setup_instruments`][mariadb_perfschema_instr_table] | `'statement/%'` | List of instrumented object classes. + +Session: + + ```sql + UPDATE performance_schema.setup_instruments SET ENABLED = 'YES', TIMED = 'YES' WHERE NAME LIKE 'statement/%'; + UPDATE performance_schema.setup_consumers SET ENABLED = 'YES' WHERE NAME LIKE '%statements%'; + ``` + +Transactions: + + MariaDB doesn't implement queries history for transactions. All queries executed within a transaction won't have query examples since PMM relies on the `performance_schema.events_statements_history` to grab the query example but that table won't have any query executed as part of a transaction. + + This behavior is because MariaDB doesn't implement these consumers: + + ``` + events_transactions_current + events_transactions_history + events_transactions_history_long + ``` + +--- + +## Query response time + +*Query time distribution* is a chart in the [*Details* tab of Query Analytics](../../get-started/query-analytics.md#details-tab) showing the proportion of query time spent on various activities. It is enabled with the `query_response_time_stats` variable and associated plugins. + +### Applicable versions + +| Server | Versions +|--------------------------|------------ +| Percona Server for MySQL | 5.7 (**not** [Percona Server for MySQL 8.0][PS_FEATURES_REMOVED].) +| MariaDB | 10.0.4 + +Set this variable to see query time distribution charts. + +| Variable | Value | Description +|-------------------------------------------------------------|-------|----------------------------------------------------------------------------------- +| [`query_response_time_stats`][ps_query_response_time_stats] | ON | Report *query response time distributions*. (Requires plugin installation. See below.) + +#### Configuration file + + ```ini + query_response_time_stats=ON + ``` + +You must also install the plugins. + +#### Session + +1. Check that `/usr/lib/mysql/plugin/query_response_time.so` exists. +2. Install the plugins and activate. + +For MariaDB 10.3: + + ```sql + INSTALL PLUGIN QUERY_RESPONSE_TIME_AUDIT SONAME 'query_response_time.so'; + INSTALL PLUGIN QUERY_RESPONSE_TIME SONAME 'query_response_time.so'; + SET GLOBAL query_response_time_stats = ON; + ``` + +For Percona Server for MySQL 5.7: + + ```sql + INSTALL PLUGIN QUERY_RESPONSE_TIME_AUDIT SONAME 'query_response_time.so'; + INSTALL PLUGIN QUERY_RESPONSE_TIME SONAME 'query_response_time.so'; + INSTALL PLUGIN QUERY_RESPONSE_TIME_READ SONAME 'query_response_time.so'; + INSTALL PLUGIN QUERY_RESPONSE_TIME_WRITE SONAME 'query_response_time.so'; + SET GLOBAL query_response_time_stats = ON; + ``` + +--- + +## Tablestats + +Some table metrics are automatically disabled when the number of tables exceeds a default limit of 1000 tables. This prevents PMM Client from affecting the performance of your database server. + +The limit can be changed [when adding a service on the command line](#command-line) with the two `pmm-admin` options: + +| `pmm-admin` option | Description +|--------------------------------|-------------------------------------------------------------------------- +| `--disable-tablestats` | Disables tablestats collection when the default limit is reached. +| `--disable-tablestats-limit=N` | Sets the number of tables (`N`) for which tablestats collection is disabled. 0 means no limit. A negative number means tablestats is completely disabled (for any number of tables). + +--- + +## User statistics + +### Applicable versions + +User activity, individual table and index access details are shown on the [MySQL User Details][DASH_MYSQLUSERDETAILS] dashboard when the `userstat` variable is set. + +| Server | Versions +|--------------------------|--------------- +| Percona Server for MySQL | 5.6, 5.7, 8.0 +| Percona XtraDB Cluster | 5.6, 5.7, 8.0 +| MariaDB | 5.2.0+ + +### Examples + +Configuration file: + + ```ini + userstat=ON + ``` + +Session: + + ```sql + SET GLOBAL userstat = ON; + ``` + +--- + +## Add service + +When you have configured your database server, you can add a MySQL service with the user interface or on the command line. + +When adding a service with the command line, you must use the `pmm-admin --query-source=SOURCE` option to match the source you've chosen and configured the database server for. + +With the PMM user interface, you select *Use performance schema*, or deselect it to use *slow query log*. + +### With the user interface + +1. Select *Configuration* → {{icon.inventory}} *Inventory* → {{icon.addinstance}} *Add Service*. + +2. Select *MySQL -- Add a remote instance*. + +3. Enter or select values for the fields. + +4. Click *Add service*. + +![!](../../_images/PMM_Add_Instance_MySQL.png) + +If your MySQL instance is configured to use TLS, click on the *Use TLS for database connections* check box and fill in your TLS certificates and key. + +![!](../../_images/PMM_Add_Instance_MySQL_TLS.png) + +### On the command line + +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 +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 +``` + +#### 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`. + +```sh +pmm-admin add mysql --username=pmm --password=pass +``` + +Slow query log source and log size limit (1 gigabyte), service name (`MYSQL_NODE`) and service address/port (`191.168.1.123:3306`). + +```sh +pmm-admin add mysql --query-source=slowlog --size-slow-logs=1GiB --username=pmm --password=pass MYSQL_NODE 192.168.1.123:3306 +``` + +Slow query log source, disabled log management (use [`logrotate`][LOGROTATE] or some other log management tool), service name (`MYSQL_NODE`) and service address/port (`191.168.1.123:3306`). + +```sh +pmm-admin add mysql --query-source=slowlog --size-slow-logs=-1GiB --username=pmm --password=pass MYSQL_NODE 192.168.1.123:3306 +``` + +Default query source (`slowlog`), service name (`{node}-mysql`), connect via socket. + +```sh +pmm-admin add mysql --username=pmm --password=pass --socket=/var/run/mysqld/mysqld.sock +``` + +#### Performance Schema + +Performance schema query source, service name (`MYSQL_NODE`) and default service address/port (`127.0.0.1:3306`). + +```sh +pmm-admin add mysql --query-source=perfschema --username=pmm --password=pass MYSQL_NODE +``` + +Performance schema query source, service name (`MYSQL_NODE`) and default service address/port (`127.0.0.1:3306`) specified with flags. + +```sh +pmm-admin add mysql --query-source=perfschema --username=pmm --password=pass --service-name=MYSQL_NODE --host=127.0.0.1 --port=3306 +``` + +#### Identifying services + +Default query source (`slowlog`), environment labeled `test`, custom labels setting `source` to `slowlog`. (This example uses positional parameters for service name and service address.) + +```sh +pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --username=root --password=password --query-source=slowlog MySQLSlowLog localhost:3306 +``` + +--- + +## Check the service + +### PMM user interface + +1. Select *Configuration* → {{icon.inventory}} *Inventory*. +2. In the *Services* tab, verify the *Service name*, *Addresses*, and any other relevant information in the form. +3. In the *Options* column, expand the *Details* section and check that the Agents are using the desired data source. + +### Command line + +Look for your service in the output of this command. + +```sh +pmm-admin inventory list services --service-type=mysql +``` + +### Check data + +1. Open the *MySQL Instance Summary* dashboard. +2. Set the *Service Name* to the newly-added service. + +#### Percona Server for MySQL, MariaDB + +If query response time plugin was installed, check for data in the *MySQL Query Response Time Details* dashboard or select a query in *PMM Query Analytics* to see the *Query time distribution* bar. + +#### Percona XtraDB Cluster + +Open the [*PXC/Galera Cluster Summary* dashboard][DASH_PXCGALERACLUSTER]. diff --git a/docs/install-pmm/install-prototype/install-pmm-client/repositories.md b/docs/install-pmm/install-prototype/install-pmm-client/repositories.md new file mode 100644 index 0000000000..0d0762ad70 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/repositories.md @@ -0,0 +1,86 @@ +# Install PMM Client using Percona Repositories + +=== "apt" + + If you're on Debian, Ubuntu or any other Debian-based system, follow these commands to install PMM Client package. + {.power-number} + + 1. First, configure the repositories. + + ```sh + wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb + dpkg -i percona-release_latest.generic_all.deb + ``` + + 2. Install the PMM Client package. + + Note: You have to install with root permissions. + + ```sh + apt update + apt install -y pmm2-client + ``` + + 3. Check if it's correctly installed. + + ```sh + pmm-admin --version + ``` + +=== "yum" + + If you're on Red Hat Enterprise Linux, CentOS or just using `yum`, follow these commands to install PMM Client package. + {.power-number} + + 1. First, configure the repositories. + + ```sh + yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm + ``` + + 2. Install the PMM Client package. + + ```sh + yum install -y pmm2-client + ``` + + 3. Check if it's correctly installed. + + ```sh + pmm-admin --version + ``` + +## Register PMM Client + +Register your client node with PMM Server. + +```sh +pmm-admin config --server-insecure-tls --server-url=https://admin:admin@X.X.X.X:443 +``` + +- `X.X.X.X` is the address of your PMM Server. +- `443` is the default port number. +- `admin`/`admin` is the default PMM username and password. This is the same account you use to log into the PMM user interface, which you had the option to change when first logging in. + +!!! caution "Important" + Clients must be registered with the PMM Server using a secure channel. If you use http as your server URL, PMM will try to connect via https on port 443. If a TLS connection can't be established you will get an error and you must use https along with the appropriate secure port. + +### Example + +Register on PMM Server with IP address `192.168.33.14` using the default `admin/admin` username and password, a node with IP address `192.168.33.23`, type `generic`, and name `mynode`. + +```sh +pmm-admin config --server-insecure-tls --server-url=https://admin:admin@192.168.33.14:443 192.168.33.23 generic mynode +``` + +## Next step: Connect Databases to PMM Server + +Now that you have both PMM Server and one or more PMM Clients installed all you need to do now is to connect one or more Databases to PMM Server. + +| *Type of database* | | +| ------------------- | --------------------------- | +| :material-dolphin: **MySQL** | [**Connect Database** :material-arrow-right:](../mysql/self-hosted.md) | +| :material-elephant: **PostgreSQL** | [**Connect Database** :material-arrow-right:](#) | +| :material-leaf: **MongoDB** | [**Connect Database** :material-arrow-right:](#) | +| :material-database: **ProxySQL** | [**Connect Database** :material-arrow-right:](#) | +| :material-database: **HAproxy** | [**Connect Database** :material-arrow-right:](#) | \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-server/docker-easy-install.md b/docs/install-pmm/install-prototype/install-pmm-server/docker-easy-install.md new file mode 100644 index 0000000000..babea6e77c --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-server/docker-easy-install.md @@ -0,0 +1,48 @@ +# Easy-install PMM Server + +The following steps will guide you through the installation of PMM Server: +{.power-number} + +1. Download and run the PMM easy installation script from [github](https://github.com/percona/pmm/blob/main/get-pmm.sh). The install script only runs on Linux-compatible systems. To use it, run the command with `sudo` privileges or as root. + + ??? note "What's happening under the hood" + - Installs Docker if it is not installed on your system. + - Stops and renames any currently running PMM Server Docker container from `pmm-server` to `pmm-server-{timestamp}`. This old pmm-server container is not a recoverable backup. + - Pulls and runs the latest PMM Server Docker image. + - To run PMM in the `Interactive` mode, execute the following command: + + ```sh + curl -fsSLO https://www.percona.com/get/pmm (or wget https://www.percona.com/get/pmm) + chmod +x pmm + ./pmm --interactive + ``` + +2. Install PMM Server using `cURL` or `wget`: + + === "cURL" + + ```sh + curl -fsSL https://www.percona.com/get/pmm | /bin/bash + ``` + + === "wget" + + ```sh + wget -qO - https://www.percona.com/get/pmm | /bin/bash + ``` + +3. Log in to PMM with the default login credentials that are provided after the installation is completed. + +## Next step: Set up PMM Client + +Now that you have PMM Server set up we need to go to your databases and add PMM Client so that PMM Server can communicate with your databases. Learn how in the button below. + +[Set up PMM Client :material-arrow-right:](../set-up-pmm-client/index.md){ .md-button .md-button--primary } + +If you want to try something else before anything, here are some other ideas for next steps: + +- [Backup](#) PMM Server and its data +- [Update](#) PMM Server +- [Restore](#) PMM Server +- [Remove](#) PMM Server +- [Use Environment Variables](#) to set PMM Server parameters. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-server/docker.md b/docs/install-pmm/install-prototype/install-pmm-server/docker.md new file mode 100644 index 0000000000..a0574a3617 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-server/docker.md @@ -0,0 +1,73 @@ +# Install PMM Server on a Docker image + +!!! note + Before running PMM Server on our Docker image make sure you have Docker 1.12.6 or higher. + +You 3 options on how you can store data from your PMM Server. Select the method below that best fits your case. + +=== "Docker Volume (recommended)" + + A Docker Volume is a designated directory on the host machine or on a remote server that preserves data, ensuring it remains intact even if the container is removed. Ideal for backing up, restoring, or handling data on remote hosts or cloud providers. + + Here's how to do it in the steps below. + {.power-number} + + 1. Pull the image. + + ```sh + docker pull percona/pmm-server:2 + ``` + + 2. Create a volume: + + ```sh + docker volume create pmm-data + ``` + + 3. Run the image: + + ```sh + docker run --detach --restart always \ + --publish 443:443 \ + -v pmm-data:/srv \ + --name pmm-server \ + percona/pmm-server:2 + ``` + + 4. Change the password for the default `admin` user. + + * For PMM versions 2.27.0 and later: + + ```sh + docker exec -t pmm-server change-admin-password + ``` + + * For PMM versions prior to 2.27.0: + + ```sh + docker exec -t pmm-server bash -c 'grafana-cli --homepath /usr/share/grafana --configOverrides cfg:default.paths.data=/srv/grafana admin reset-admin-password newpass' + ``` + + 5. Visit `https://localhost:443` to see the PMM user interface in a web browser. (If you are accessing the docker host remotely, replace `localhost` with the IP or server name of the host.) + +=== "Data Container" + + Instructions here... + +=== "Host Directory" + + Instructions here... + +## Next step: Set up PMM Client + +Now that you have PMM Server set up we need to go to your databases and add PMM Client so that PMM Server can communicate with your databases. Learn how in the button below. + +[Set up PMM Client :material-arrow-right:](../set-up-pmm-client/index.md){ .md-button .md-button--primary } + +If you want to try something else before anything, here are some other ideas for next steps: + +- [Backup](#) PMM Server and its data +- [Update](#) PMM Server +- [Restore](#) PMM Server +- [Remove](#) PMM Server +- [Use Environment Variables](#) to set PMM Server parameters. \ No newline at end of file diff --git a/mkdocs-base.yml b/mkdocs-base.yml index d29abd690e..cd2388b1e9 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -439,3 +439,33 @@ nav: - reference/faq.md - reference/trademark-policy.md - reference/copyright.md + - New Install Prototype: + - Quickstart Guide: + - quickstart/index.md + - Install PMM Server: + - Bare Metal / Virtual: + - Easy-install: install-prototype/install-pmm-server/docker-easy-install.md + - Docker: install-prototype/install-pmm-server/docker.md + - Podman: install-prototype/dummy.md + - Virtual Appliance: install-prototype/dummy.md + - Kubernetes: install-prototype/dummy.md + - Amazon AWS: install-prototype/dummy.md + - Azure: install-prototype/dummy.md + - Google Cloud: install-prototype/dummy.md + - Set up PMM Client: + - install-prototype/set-up-pmm-client/index.md + - Install PMM Client: + - Percona Repositories: install-prototype/set-up-pmm-client/install-pmm-client/percona-repositories.md + - Docker image: install-prototype/dummy.md + - Manual install: install-prototype/dummy.md + - Connect Database: + - MySQL: + - Self-hosted / AWS EC2: install-prototype/set-up-pmm-client/mysql/self-hosted.md + - AWS RDS / AWS Aurora: install-prototype/dummy.md + - Azure: install-prototype/dummy.md + - Google Cloud: install-prototype/dummy.md + - PostgreSQL: install-prototype/dummy.md + - MongoDB: install-prototype/dummy.md + - ProxySQL: install-prototype/dummy.md + - HAproxy: install-prototype/dummy.md + - Remote monitoring: install-prototype/dummy.md \ No newline at end of file From 5151d499f890dabcea70227735320997210d3a0e Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Thu, 5 Dec 2024 15:10:33 +0200 Subject: [PATCH 2/7] fix toc --- mkdocs-base.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index cd2388b1e9..3bbe51ba56 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -262,7 +262,7 @@ nav: - Manage dashboards: - use/dashboards-panels/manage-dashboards/create-folders.md - use/dashboards-panels/manage-dashboards/manage-folders.md - - use/dashboard-panels/set-custom-dashboard + - use/dashboard-panels/set-custom-dashboard.md - Share dashboards and panels: use/dashboards-panels/share-dashboards/share_dashboard.md - Annotate: use/dashboards-panels/annotate/annotate.md @@ -440,8 +440,7 @@ nav: - reference/trademark-policy.md - reference/copyright.md - New Install Prototype: - - Quickstart Guide: - - quickstart/index.md + - Quickstart Guide: quickstart/index.md - Install PMM Server: - Bare Metal / Virtual: - Easy-install: install-prototype/install-pmm-server/docker-easy-install.md From 22c48dd0b2bf9a0bee3036e575874dfd113ae14e Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Thu, 5 Dec 2024 15:50:47 +0200 Subject: [PATCH 3/7] ToC --- mkdocs-base.yml | 58 ++++++++++++++++++++++++------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 3bbe51ba56..f7d756e79f 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -439,32 +439,32 @@ nav: - reference/faq.md - reference/trademark-policy.md - reference/copyright.md - - New Install Prototype: - - Quickstart Guide: quickstart/index.md - - Install PMM Server: - - Bare Metal / Virtual: - - Easy-install: install-prototype/install-pmm-server/docker-easy-install.md - - Docker: install-prototype/install-pmm-server/docker.md - - Podman: install-prototype/dummy.md - - Virtual Appliance: install-prototype/dummy.md - - Kubernetes: install-prototype/dummy.md - - Amazon AWS: install-prototype/dummy.md - - Azure: install-prototype/dummy.md - - Google Cloud: install-prototype/dummy.md - - Set up PMM Client: - - install-prototype/set-up-pmm-client/index.md - - Install PMM Client: - - Percona Repositories: install-prototype/set-up-pmm-client/install-pmm-client/percona-repositories.md - - Docker image: install-prototype/dummy.md - - Manual install: install-prototype/dummy.md - - Connect Database: - - MySQL: - - Self-hosted / AWS EC2: install-prototype/set-up-pmm-client/mysql/self-hosted.md - - AWS RDS / AWS Aurora: install-prototype/dummy.md - - Azure: install-prototype/dummy.md - - Google Cloud: install-prototype/dummy.md - - PostgreSQL: install-prototype/dummy.md - - MongoDB: install-prototype/dummy.md - - ProxySQL: install-prototype/dummy.md - - HAproxy: install-prototype/dummy.md - - Remote monitoring: install-prototype/dummy.md \ No newline at end of file + - New Install prototype: + - Quickstart Guide: quickstart/index.md + - Install PMM Server: + - Bare Metal/Virtual: + - Easy-install: install-prototype/install-pmm-server/docker-easy-install.md + - Docker: install-prototype/install-pmm-server/docker.md + - Podman: install-prototype/dummy.md + - Virtual Appliance: install-prototype/dummy.md + - Kubernetes: install-prototype/dummy.md + - Amazon AWS: install-prototype/dummy.md + - Azure: install-prototype/dummy.md + - Google Cloud: install-prototype/dummy.md + - Set up PMM Client: + - install-prototype/set-up-pmm-client/index.md + - Install PMM Client: + - Percona Repositories: install-prototype/set-up-pmm-client/install-pmm-client/percona-repositories.md + - Docker image: install-prototype/dummy.md + - Manual install: install-prototype/dummy.md + - Connect database: + - MySQL: + - Self-hosted / AWS EC2: install-prototype/set-up-pmm-client/mysql/self-hosted.md + - AWS RDS / AWS Aurora: install-prototype/dummy.md + - Azure: install-prototype/dummy.md + - Google Cloud: install-prototype/dummy.md + - PostgreSQL: install-prototype/dummy.md + - MongoDB: install-prototype/dummy.md + - ProxySQL: install-prototype/dummy.md + - HAproxy: install-prototype/dummy.md + - Remote monitoring: install-prototype/dummy.md \ No newline at end of file From 6473acdd7f17a1a9ae478e11448f068c61c30959 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Thu, 12 Dec 2024 13:30:33 +0200 Subject: [PATCH 4/7] updated paths --- docs/install-pmm/install-prototype/dummy.md | 3 ++ mkdocs-base.yml | 40 ++++++++++----------- 2 files changed, 23 insertions(+), 20 deletions(-) create mode 100644 docs/install-pmm/install-prototype/dummy.md diff --git a/docs/install-pmm/install-prototype/dummy.md b/docs/install-pmm/install-prototype/dummy.md new file mode 100644 index 0000000000..7936206ccc --- /dev/null +++ b/docs/install-pmm/install-prototype/dummy.md @@ -0,0 +1,3 @@ +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/mkdocs-base.yml b/mkdocs-base.yml index f7d756e79f..a38b4f764c 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -444,27 +444,27 @@ nav: - Install PMM Server: - Bare Metal/Virtual: - Easy-install: install-prototype/install-pmm-server/docker-easy-install.md - - Docker: install-prototype/install-pmm-server/docker.md - - Podman: install-prototype/dummy.md - - Virtual Appliance: install-prototype/dummy.md - - Kubernetes: install-prototype/dummy.md - - Amazon AWS: install-prototype/dummy.md - - Azure: install-prototype/dummy.md - - Google Cloud: install-prototype/dummy.md + - Docker: install-pmm/install-prototype/install-pmm-server/docker.md + - Podman: install-pmm/install-prototype/dummy.md + - Virtual Appliance: install-pmm/install-prototype/dummy.md + - Kubernetes: install-pmm/install-prototype/dummy.md + - Amazon AWS: install-pmm/install-prototype/dummy.md + - Azure: install-pmm/install-prototype/dummy.md + - Google Cloud: install-pmm/install-prototype/dummy.md - Set up PMM Client: - - install-prototype/set-up-pmm-client/index.md + - install-pmm/install-prototype/install-pmm-client/index.md - Install PMM Client: - - Percona Repositories: install-prototype/set-up-pmm-client/install-pmm-client/percona-repositories.md - - Docker image: install-prototype/dummy.md - - Manual install: install-prototype/dummy.md + - Percona Repositories: install-pmm/install-prototype/install-pmm-client/repositories.md + - Docker image: install-pmm/install-prototype/dummy.md + - Manual install: install-pmm/install-prototype/dummy.md - Connect database: - MySQL: - - Self-hosted / AWS EC2: install-prototype/set-up-pmm-client/mysql/self-hosted.md - - AWS RDS / AWS Aurora: install-prototype/dummy.md - - Azure: install-prototype/dummy.md - - Google Cloud: install-prototype/dummy.md - - PostgreSQL: install-prototype/dummy.md - - MongoDB: install-prototype/dummy.md - - ProxySQL: install-prototype/dummy.md - - HAproxy: install-prototype/dummy.md - - Remote monitoring: install-prototype/dummy.md \ No newline at end of file + - Self-hosted / AWS EC2: install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md + - AWS RDS / AWS Aurora: install-pmm/install-prototype/dummy.md + - Azure: install-pmm/install-prototype/dummy.md + - Google Cloud: install-pmm/install-prototype/dummy.md + - PostgreSQL: install-pmm/install-prototype/dummy.md + - MongoDB: install-pmm/install-prototype/dummy.md + - ProxySQL: install-pmm/install-prototype/dummy.md + - HAproxy: install-pmm/install-prototype/dummy.md + - Remote monitoring: install-pmm/install-prototype/dummy.md \ No newline at end of file From 666c1c4ae5cd88139c280b240f5c28f7b4af4be4 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Thu, 12 Dec 2024 13:36:32 +0200 Subject: [PATCH 5/7] ToC --- mkdocs-base.yml | 52 ++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index a38b4f764c..851d328291 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -440,31 +440,31 @@ nav: - reference/trademark-policy.md - reference/copyright.md - New Install prototype: - - Quickstart Guide: quickstart/index.md - - Install PMM Server: - - Bare Metal/Virtual: - - Easy-install: install-prototype/install-pmm-server/docker-easy-install.md - - Docker: install-pmm/install-prototype/install-pmm-server/docker.md - - Podman: install-pmm/install-prototype/dummy.md - - Virtual Appliance: install-pmm/install-prototype/dummy.md - - Kubernetes: install-pmm/install-prototype/dummy.md - - Amazon AWS: install-pmm/install-prototype/dummy.md - - Azure: install-pmm/install-prototype/dummy.md - - Google Cloud: install-pmm/install-prototype/dummy.md - - Set up PMM Client: - - install-pmm/install-prototype/install-pmm-client/index.md - - Install PMM Client: - - Percona Repositories: install-pmm/install-prototype/install-pmm-client/repositories.md - - Docker image: install-pmm/install-prototype/dummy.md - - Manual install: install-pmm/install-prototype/dummy.md - - Connect database: - - MySQL: - - Self-hosted / AWS EC2: install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md - - AWS RDS / AWS Aurora: install-pmm/install-prototype/dummy.md + - Quickstart Guide: quickstart/index.md + - Install PMM Server: + - Bare Metal/Virtual: + - Easy-install: install-pmm/install-prototype/install-pmm-server/docker-easy-install.md + - Docker: install-pmm/install-prototype/install-pmm-server/docker.md + - Podman: install-pmm/install-prototype/dummy.md + - Virtual Appliance: install-pmm/install-prototype/dummy.md + - Kubernetes: install-pmm/install-prototype/dummy.md + - Amazon AWS: install-pmm/install-prototype/dummy.md - Azure: install-pmm/install-prototype/dummy.md - Google Cloud: install-pmm/install-prototype/dummy.md - - PostgreSQL: install-pmm/install-prototype/dummy.md - - MongoDB: install-pmm/install-prototype/dummy.md - - ProxySQL: install-pmm/install-prototype/dummy.md - - HAproxy: install-pmm/install-prototype/dummy.md - - Remote monitoring: install-pmm/install-prototype/dummy.md \ No newline at end of file + - Set up PMM Client: + - Overview: install-pmm/install-prototype/install-pmm-client/index.md + - Install PMM Client: + - Percona Repositories: install-pmm/install-prototype/install-pmm-client/repositories.md + - Docker image: install-pmm/install-prototype/dummy.md + - Manual install: install-pmm/install-prototype/dummy.md + - Connect database: + - MySQL: + - Self-hosted / AWS EC2: install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md + - AWS RDS / AWS Aurora: install-pmm/install-prototype/dummy.md + - Azure: install-pmm/install-prototype/dummy.md + - Google Cloud: install-pmm/install-prototype/dummy.md + - PostgreSQL: install-pmm/install-prototype/dummy.md + - MongoDB: install-pmm/install-prototype/dummy.md + - ProxySQL: install-pmm/install-prototype/dummy.md + - HAproxy: install-pmm/install-prototype/dummy.md + - Remote monitoring: install-pmm/install-prototype/dummy.md \ No newline at end of file From c3c67943fffcdd09b40933019ee5d934b5dbee36 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Thu, 12 Dec 2024 13:59:38 +0200 Subject: [PATCH 6/7] added dummy topics --- .../connect-google-cloud.md | 5 ++++ .../install-pmm-client/connect-haproxy.md | 6 ++++ .../install-pmm-client/connect-mongo.md | 5 ++++ .../install-pmm-client/connect-postgre.md | 5 ++++ .../install-pmm-client/connect-proxy.md | 6 ++++ .../install-pmm-client/mysql/aws-aurora.md | 5 ++++ .../mysql/pmm-client-azure.md | 5 ++++ .../install-pmm-client/pmm-client-docker.md | 0 .../install-pmm-client/pmm-client-manual.md | 4 +++ .../install-pmm-client/remote-monitoring.md | 5 ++++ .../install-pmm-server/aws.md | 5 ++++ .../install-pmm-server/azure.md | 5 ++++ .../install-pmm-server/google-cloud.md | 5 ++++ .../install-pmm-server/kubernetes.md | 6 ++++ .../install-pmm-server/virtual-appliance.md | 5 ++++ mkdocs-base.yml | 30 +++++++++---------- 16 files changed, 87 insertions(+), 15 deletions(-) create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/connect-google-cloud.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/connect-haproxy.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/connect-mongo.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/connect-postgre.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/connect-proxy.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/mysql/aws-aurora.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/mysql/pmm-client-azure.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/pmm-client-docker.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-client/remote-monitoring.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-server/aws.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-server/azure.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-server/google-cloud.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-server/kubernetes.md create mode 100644 docs/install-pmm/install-prototype/install-pmm-server/virtual-appliance.md diff --git a/docs/install-pmm/install-prototype/install-pmm-client/connect-google-cloud.md b/docs/install-pmm/install-prototype/install-pmm-client/connect-google-cloud.md new file mode 100644 index 0000000000..d0d1e41d45 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/connect-google-cloud.md @@ -0,0 +1,5 @@ +# Connect database - Google Cloud + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/connect-haproxy.md b/docs/install-pmm/install-prototype/install-pmm-client/connect-haproxy.md new file mode 100644 index 0000000000..17ef737201 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/connect-haproxy.md @@ -0,0 +1,6 @@ +# Connect database - HAProxy + + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. diff --git a/docs/install-pmm/install-prototype/install-pmm-client/connect-mongo.md b/docs/install-pmm/install-prototype/install-pmm-client/connect-mongo.md new file mode 100644 index 0000000000..47d9a5e4c2 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/connect-mongo.md @@ -0,0 +1,5 @@ +# Connect database - Mongo + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/connect-postgre.md b/docs/install-pmm/install-prototype/install-pmm-client/connect-postgre.md new file mode 100644 index 0000000000..20de325711 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/connect-postgre.md @@ -0,0 +1,5 @@ +# Connect database - PostgreSQL + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/connect-proxy.md b/docs/install-pmm/install-prototype/install-pmm-client/connect-proxy.md new file mode 100644 index 0000000000..515504ab40 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/connect-proxy.md @@ -0,0 +1,6 @@ + +# Connect database - Proxy + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/mysql/aws-aurora.md b/docs/install-pmm/install-prototype/install-pmm-client/mysql/aws-aurora.md new file mode 100644 index 0000000000..d599112c9b --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/mysql/aws-aurora.md @@ -0,0 +1,5 @@ +# Install PMM Client - AWS Aurora + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/mysql/pmm-client-azure.md b/docs/install-pmm/install-prototype/install-pmm-client/mysql/pmm-client-azure.md new file mode 100644 index 0000000000..eb305a4b90 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/mysql/pmm-client-azure.md @@ -0,0 +1,5 @@ +# Install PMM Client - Azure + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-docker.md b/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-docker.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md b/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md new file mode 100644 index 0000000000..6f49d685f4 --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md @@ -0,0 +1,4 @@ +# Install PMM Client - Manual installation +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/remote-monitoring.md b/docs/install-pmm/install-prototype/install-pmm-client/remote-monitoring.md new file mode 100644 index 0000000000..07da99f21c --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-client/remote-monitoring.md @@ -0,0 +1,5 @@ +# Remote monitoring + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-server/aws.md b/docs/install-pmm/install-prototype/install-pmm-server/aws.md new file mode 100644 index 0000000000..ba68c9907d --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-server/aws.md @@ -0,0 +1,5 @@ +# Install PMM Server - AWS + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-server/azure.md b/docs/install-pmm/install-prototype/install-pmm-server/azure.md new file mode 100644 index 0000000000..2fbec81e7e --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-server/azure.md @@ -0,0 +1,5 @@ +# Install PMM Server - Azure + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-server/google-cloud.md b/docs/install-pmm/install-prototype/install-pmm-server/google-cloud.md new file mode 100644 index 0000000000..4dc803916d --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-server/google-cloud.md @@ -0,0 +1,5 @@ +# Install PMM Server - Google Cloud + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-server/kubernetes.md b/docs/install-pmm/install-prototype/install-pmm-server/kubernetes.md new file mode 100644 index 0000000000..7fb66776bd --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-server/kubernetes.md @@ -0,0 +1,6 @@ +# Install PMM Server - Kubernetes + + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-server/virtual-appliance.md b/docs/install-pmm/install-prototype/install-pmm-server/virtual-appliance.md new file mode 100644 index 0000000000..7b8a69bc6e --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-server/virtual-appliance.md @@ -0,0 +1,5 @@ +# Install PMM Server - Virtual Appliance + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 851d328291..327e911595 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -446,25 +446,25 @@ nav: - Easy-install: install-pmm/install-prototype/install-pmm-server/docker-easy-install.md - Docker: install-pmm/install-prototype/install-pmm-server/docker.md - Podman: install-pmm/install-prototype/dummy.md - - Virtual Appliance: install-pmm/install-prototype/dummy.md - - Kubernetes: install-pmm/install-prototype/dummy.md - - Amazon AWS: install-pmm/install-prototype/dummy.md - - Azure: install-pmm/install-prototype/dummy.md - - Google Cloud: install-pmm/install-prototype/dummy.md + - Virtual Appliance: install-pmm/install-prototype/virtual-appliance.md + - Kubernetes: install-pmm/install-prototype/kubernetes.md + - Amazon AWS: install-pmm/install-prototype/aws.md + - Azure: install-pmm/install-prototype/azure.md + - Google Cloud: install-pmm/install-prototype/google-cloud.md - Set up PMM Client: - Overview: install-pmm/install-prototype/install-pmm-client/index.md - Install PMM Client: - Percona Repositories: install-pmm/install-prototype/install-pmm-client/repositories.md - - Docker image: install-pmm/install-prototype/dummy.md - - Manual install: install-pmm/install-prototype/dummy.md + - Docker image: install-pmm/install-prototype/pmm-client-docker.md + - Manual install: install-pmm/install-prototype/pmm-client-manual.md - Connect database: - MySQL: - Self-hosted / AWS EC2: install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md - - AWS RDS / AWS Aurora: install-pmm/install-prototype/dummy.md - - Azure: install-pmm/install-prototype/dummy.md - - Google Cloud: install-pmm/install-prototype/dummy.md - - PostgreSQL: install-pmm/install-prototype/dummy.md - - MongoDB: install-pmm/install-prototype/dummy.md - - ProxySQL: install-pmm/install-prototype/dummy.md - - HAproxy: install-pmm/install-prototype/dummy.md - - Remote monitoring: install-pmm/install-prototype/dummy.md \ No newline at end of file + - AWS RDS / AWS Aurora: install-pmm/install-prototype/connect-aws-aurora.md + - Azure: install-pmm/install-prototype/connect-azure.md + - Google Cloud: install-pmm/install-prototype/connect-google-cloud.md + - PostgreSQL: install-pmm/install-prototype/connect-postgre.md + - MongoDB: install-pmm/install-prototype/connect-mongo.md + - ProxySQL: install-pmm/install-prototype/connect-proxy.md + - HAproxy: install-pmm/install-prototype/connect-haproxy.md + - Remote monitoring: install-pmm/install-prototype/remote-monitoring.md \ No newline at end of file From d2c01ab31c47f8857313cbb427217bf837b961a4 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Thu, 12 Dec 2024 14:13:21 +0200 Subject: [PATCH 7/7] updated paths --- .../{ => mysql}/connect-google-cloud.md | 0 .../install-pmm-client/pmm-client-docker.md | 5 +++ .../install-pmm-client/pmm-client-manual.md | 3 +- .../install-pmm-server/podman.md | 5 +++ mkdocs-base.yml | 34 +++++++++---------- 5 files changed, 29 insertions(+), 18 deletions(-) rename docs/install-pmm/install-prototype/install-pmm-client/{ => mysql}/connect-google-cloud.md (100%) create mode 100644 docs/install-pmm/install-prototype/install-pmm-server/podman.md diff --git a/docs/install-pmm/install-prototype/install-pmm-client/connect-google-cloud.md b/docs/install-pmm/install-prototype/install-pmm-client/mysql/connect-google-cloud.md similarity index 100% rename from docs/install-pmm/install-prototype/install-pmm-client/connect-google-cloud.md rename to docs/install-pmm/install-prototype/install-pmm-client/mysql/connect-google-cloud.md diff --git a/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-docker.md b/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-docker.md index e69de29bb2..09ab60327a 100644 --- a/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-docker.md +++ b/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-docker.md @@ -0,0 +1,5 @@ +# Install PMM Client from a Docker image + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md b/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md index 6f49d685f4..3805a33870 100644 --- a/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md +++ b/docs/install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md @@ -1,4 +1,5 @@ -# Install PMM Client - Manual installation +# Install PMM Client manually + Hi there 👋 This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/docs/install-pmm/install-prototype/install-pmm-server/podman.md b/docs/install-pmm/install-prototype/install-pmm-server/podman.md new file mode 100644 index 0000000000..a8da02c41c --- /dev/null +++ b/docs/install-pmm/install-prototype/install-pmm-server/podman.md @@ -0,0 +1,5 @@ +# Install PMM Server - Podman + +Hi there 👋 + +This is just a page to fill in the blanks in this prototype's interaction flows. Nothing to see here yet. \ No newline at end of file diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 327e911595..82aeb64b47 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -445,26 +445,26 @@ nav: - Bare Metal/Virtual: - Easy-install: install-pmm/install-prototype/install-pmm-server/docker-easy-install.md - Docker: install-pmm/install-prototype/install-pmm-server/docker.md - - Podman: install-pmm/install-prototype/dummy.md - - Virtual Appliance: install-pmm/install-prototype/virtual-appliance.md - - Kubernetes: install-pmm/install-prototype/kubernetes.md - - Amazon AWS: install-pmm/install-prototype/aws.md - - Azure: install-pmm/install-prototype/azure.md - - Google Cloud: install-pmm/install-prototype/google-cloud.md + - Podman: install-pmm/install-prototype/install-pmm-server/podman.md + - Virtual Appliance: install-pmm/install-prototype/install-pmm-server/virtual-appliance.md + - Kubernetes: install-pmm/install-prototype/install-pmm-server/kubernetes.md + - Amazon AWS: install-pmm/install-prototype/install-pmm-server/aws.md + - Azure: install-pmm/install-prototype/install-pmm-server/azure.md + - Google Cloud: install-pmm/install-prototype/install-pmm-server/google-cloud.md - Set up PMM Client: - Overview: install-pmm/install-prototype/install-pmm-client/index.md - Install PMM Client: - - Percona Repositories: install-pmm/install-prototype/install-pmm-client/repositories.md - - Docker image: install-pmm/install-prototype/pmm-client-docker.md - - Manual install: install-pmm/install-prototype/pmm-client-manual.md + - Percona repositories: install-pmm/install-prototype/install-pmm-client/repositories.md + - Docker image: install-pmm/install-prototype/install-pmm-client/pmm-client-docker.md + - Manual install: install-pmm/install-prototype/install-pmm-client/pmm-client-manual.md - Connect database: - MySQL: - Self-hosted / AWS EC2: install-pmm/install-prototype/install-pmm-client/mysql/self-hosted.md - - AWS RDS / AWS Aurora: install-pmm/install-prototype/connect-aws-aurora.md - - Azure: install-pmm/install-prototype/connect-azure.md - - Google Cloud: install-pmm/install-prototype/connect-google-cloud.md - - PostgreSQL: install-pmm/install-prototype/connect-postgre.md - - MongoDB: install-pmm/install-prototype/connect-mongo.md - - ProxySQL: install-pmm/install-prototype/connect-proxy.md - - HAproxy: install-pmm/install-prototype/connect-haproxy.md - - Remote monitoring: install-pmm/install-prototype/remote-monitoring.md \ No newline at end of file + - AWS RDS / AWS Aurora: install-pmm/install-prototype/install-pmm-client/mysql/aws-aurora.md + - Azure: install-pmm/install-prototype/install-pmm-client/mysql/pmm-client-azure.md + - Google Cloud: install-pmm/install-prototype/install-pmm-client/mysql/connect-google-cloud.md + - PostgreSQL: install-pmm/install-prototype/install-pmm-client/connect-postgre.md + - MongoDB: install-pmm/install-prototype/install-pmm-client/connect-mongo.md + - ProxySQL: install-pmm/install-prototype/install-pmm-client/connect-proxy.md + - HAproxy: install-pmm/install-prototype/install-pmm-client/connect-haproxy.md + - Remote monitoring: install-pmm/install-prototype/install-pmm-client/remote-monitoring.md \ No newline at end of file