-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* PMM-12258 add the first category * PMM-12258 refactor and fix the documentation files * PMM-12258 add an empty line * PMM-12258 rename the file --------- Co-authored-by: Alex Tymchuk <[email protected]>
- Loading branch information
Showing
29 changed files
with
303 additions
and
154 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ on: | |
paths: | ||
- "api/**" | ||
- "docs/api/**" | ||
|
||
workflow_dispatch: | ||
inputs: | ||
version: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Percona Advisors and Advisors checks | ||
slug: advisors-and-advisor-checks | ||
category: 6291050b9400a1001ae1877d | ||
order: 2 | ||
hidden: 0 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Changing Advisors and Advisor checks | ||
slug: changing-advisor-checks | ||
category: 6291050b9400a1001ae1877d | ||
order: 3 | ||
hidden: 0 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: List of problems detected by Advisors | ||
slug: failed-checks | ||
category: 6291050b9400a1001ae1877d | ||
order: 1 | ||
hidden: 0 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: Overview | ||
slug: percona-advisors | ||
category: 6291050b9400a1001ae1877d | ||
order: 0 | ||
--- | ||
|
||
|
||
This section is about API for managing Percona [Advisors](https://docs.percona.com/percona-monitoring-and-management/get-started/advisors.html), and [Advisors Checks](https://docs.percona.com/percona-monitoring-and-management/details/develop-checks/index.html). | ||
|
||
This section has three main subsections. | ||
|
||
- In [List of problems detected by Advisors](reference/failed-checks) you can find API to get information about potential problems with your Infrastructure detected by Advisors. | ||
- [Percona Advisors and Advisors checks](reference/advisors-and-advisor-checks) lists all Advisors and Advisor Checks available in your PMM. | ||
- [Changing Advisors and Advisor checks](reference/changing-advisor-checks) will help you automate Advisor checks modification if needed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: List Locations | ||
slug: listlocations | ||
excerpt: ListLocations returns a list of all backup locations. | ||
category: 626badcabbc59c02acc1a540 | ||
--- | ||
|
||
The following API call will list all the available backup locations: | ||
|
||
```shell | ||
curl --insecure -X POST \ | ||
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \ | ||
-H 'Accept: application/json' \ | ||
-H 'Content-Type: application/json' \ | ||
--url https://127.0.0.1/v1/management/backup/Locations/List \ | ||
``` | ||
|
||
Please note that locations are good for storing any type of backup disregarding the technology or the database vendor. However, for a better organization of your file system storage, you'll probably want to create different locations based on a certain criteria. For example, it can be a department, a region, etc. | ||
|
||
You will need the [authetication token](ref:authentication). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
title: Restore from a backup | ||
slug: restorebackup | ||
excerpt: This endpoint allows to restore a database from a previously made backup. | ||
category: 626badcabbc59c02acc1a540 | ||
order: 1 | ||
--- | ||
|
||
PMM can backup the monitored services. | ||
|
||
This section describes making ad-hoc backups from a service. | ||
|
||
### Restoring From a Backup | ||
|
||
Here is an example of an API call to restore from a backup: | ||
|
||
```shell | ||
curl --insecure -X POST -H 'Authorization: Bearer XXXXX' \ | ||
--request POST \ | ||
--url https://127.0.0.1/v1/management/backup/Backups/Restore \ | ||
--header 'Accept: application/json' \ | ||
--header 'Content-Type: application/json' \ | ||
--data ' | ||
{ | ||
"service_id": "/service_id/XXXXX", | ||
"artifact_id": "/location_id/XXXXX", | ||
"pitr_timestamp": "2023-09-09T10:02:25.998" | ||
} | ||
' | ||
``` | ||
|
||
You require an authentication token, which is described [here](ref:authentication). | ||
|
||
Also, you require the [service_id](ref:listservices) and [location_id](ref:listlocations). | ||
|
||
You can defined a `name` and a `description` for each backup. You can also configure `retry_interval` and `retries` if required. | ||
|
||
### Error messages | ||
|
||
The API call could return an error message in the details, containing a specific ErrorCode indicating the failure reason: | ||
- ERROR_CODE_XTRABACKUP_NOT_INSTALLED - xtrabackup is not installed on the service | ||
- ERROR_CODE_INVALID_XTRABACKUP - different versions of xtrabackup and xbcloud | ||
- ERROR_CODE_INCOMPATIBLE_XTRABACKUP - xtrabackup is not compatible with MySQL for making a backup | ||
- ERROR_CODE_INCOMPATIBLE_TARGET_MYSQL - target MySQL version is not compatible with the artifact to perform a restore of the backup |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
title: Make a backup | ||
slug: startbackup | ||
excerpt: This endpoint allows to make an unscheduled, or ad-hoc, backup of a given service. | ||
category: 626badcabbc59c02acc1a540 | ||
order: 0 | ||
--- | ||
|
||
PMM can backup the monitored services. | ||
|
||
This section describes how to make an ad-hoc backup of a service. | ||
|
||
### Creating a Backup | ||
|
||
Here is an example of an API call to create a backup: | ||
|
||
```shell | ||
curl --insecure -X POST -H 'Authorization: Bearer XXXXX' \ | ||
--request POST \ | ||
--url https://127.0.0.1/v1/management/backup/Backups/Start \ | ||
--header 'Accept: application/json' \ | ||
--header 'Content-Type: application/json' \ | ||
--data ' | ||
{ | ||
"service_id": "/service_id/XXXXX", | ||
"location_id": "/location_id/XXXXX", | ||
"name": "Test Backup", | ||
"description": "Test Backup", | ||
"retry_interval": "60s", | ||
"retries": 1 | ||
} | ||
' | ||
``` | ||
|
||
You require an authentication token, which is described [here](ref:authentication). | ||
|
||
Also, you require the [service_id](ref:listservices) and [location_id](ref:listlocations). | ||
|
||
You can defined a `name` and a `description` for each backup. You can also configure `retry_interval` and `retries` if required. | ||
|
||
### Error messages | ||
|
||
The API call could return an error message in the details, containing a specific ErrorCode indicating the failure reason: | ||
- ERROR_CODE_XTRABACKUP_NOT_INSTALLED - xtrabackup is not installed on the service | ||
- ERROR_CODE_INVALID_XTRABACKUP - different versions of xtrabackup and xbcloud | ||
- ERROR_CODE_INCOMPATIBLE_XTRABACKUP - xtrabackup is not compatible with MySQL to make a backup |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.