From a8f1cd58597c357dd1b41e34324116b3a423cbf3 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Thu, 19 Sep 2024 09:33:43 +0300 Subject: [PATCH 01/16] PMM-12985 Apply API infra modifications --- .github/workflows/doc.yml | 13 +++++++------ api/server/v1/server.proto | 6 +++--- docs/api/access-control/access-control.md | 3 ++- docs/api/advisor-api/advisors-and-advisor-checks.md | 4 ++-- docs/api/advisor-api/changing-advisor-checks.md | 2 +- docs/api/advisor-api/failed-checks.md | 2 +- docs/api/advisor-api/overview.md | 6 ++---- docs/api/backups/list-locations.md | 2 +- docs/api/backups/overview.md | 2 +- docs/api/backups/restore-backup.md | 2 +- docs/api/backups/start-backup.md | 2 +- docs/api/inventory/add-agent.md | 2 +- docs/api/inventory/add-node.md | 2 +- docs/api/inventory/add-service.md | 2 +- docs/api/inventory/change-agent.md | 2 +- docs/api/inventory/list-nodes.md | 2 +- docs/api/inventory/list-services.md | 2 +- .../account-management/bulk-add-users.md | 4 ++-- .../account-management/change-admin-password.md | 4 ++-- docs/api/pmm-server-config/overview.md | 10 +++++++++- docs/api/pmm-server-config/pmm-server-settings.md | 3 ++- .../pmm-server-config/pmm-server-troubleshooting.md | 2 +- docs/api/pmm-server-config/pmm-server-upgrade.md | 2 +- docs/api/pmm-server-config/troubleshooting/logs.md | 5 +++-- .../pmm-server-config/user-account-management.md | 4 ++-- 25 files changed, 50 insertions(+), 40 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 6174390dc0..9427c98ebc 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -12,7 +12,7 @@ on: jobs: sync: - name: Sync + name: Sync API Docs runs-on: ubuntu-22.04 steps: @@ -29,11 +29,12 @@ jobs: echo "VERSION=$VERSION" >> $GITHUB_ENV echo "ID=$ID" >> $GITHUB_ENV - - name: Provision rdme - run: npm install -g rdme - - name: Sync API spec - run: rdme openapi ./api/swagger/swagger.json --id=${{ env.ID }} --key=${{ secrets.README_TOKEN }} + uses: readmeio/rdme@v8 + with: + rdme: openapi ./api/swagger/swagger.json --id=${{ env.ID }} --key=${{ secrets.README_TOKEN }} - name: Sync Markdown docs - run: rdme docs docs/api --version=${{ env.VERSION }} --key=${{ secrets.README_TOKEN }} + uses: readmeio/rdme@v8 + with: + rdme: docs ./docs/api --version=${{ env.VERSION }} --key=${{ secrets.README_TOKEN }} diff --git a/api/server/v1/server.proto b/api/server/v1/server.proto index 79841df710..5ab07b3ff0 100644 --- a/api/server/v1/server.proto +++ b/api/server/v1/server.proto @@ -250,12 +250,12 @@ service ServerService { description: "Checks for available PMM Server updates." }; } - + // ListChangeLogs delivers the changelog. rpc ListChangeLogs(ListChangeLogsRequest) returns (ListChangeLogsResponse) { option (google.api.http) = {get: "/v1/server/updates/changelogs"}; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - summary: "List all the changes between the installed version and the latest available version" - description: "List all the changes between the installed version and the latest available version" + summary: "Get the changelog" + description: "List all the changes between the installed version and the latest available version." }; } // StartUpdate starts PMM Server update. diff --git a/docs/api/access-control/access-control.md b/docs/api/access-control/access-control.md index 17aeba9c43..f10ba0f7db 100644 --- a/docs/api/access-control/access-control.md +++ b/docs/api/access-control/access-control.md @@ -1,7 +1,8 @@ --- title: Access Control slug: access-control -category: 66aca8d40bf230001846b567 +category: 61fc63ec4601b10049339d79 +hidden: 0 --- ## Overview diff --git a/docs/api/advisor-api/advisors-and-advisor-checks.md b/docs/api/advisor-api/advisors-and-advisor-checks.md index d39b0289b3..1eb5a0376e 100644 --- a/docs/api/advisor-api/advisors-and-advisor-checks.md +++ b/docs/api/advisor-api/advisors-and-advisor-checks.md @@ -1,7 +1,7 @@ --- -title: Percona Advisors and Advisors checks +title: Percona Advisors and Advisor checks slug: advisors-and-advisor-checks -category: 66acabbe485c6000126b0499 +category: 66eb0386f81fe000105dbea7 order: 1 hidden: 0 --- diff --git a/docs/api/advisor-api/changing-advisor-checks.md b/docs/api/advisor-api/changing-advisor-checks.md index 240ee068d3..d6318dbe3f 100644 --- a/docs/api/advisor-api/changing-advisor-checks.md +++ b/docs/api/advisor-api/changing-advisor-checks.md @@ -1,7 +1,7 @@ --- title: Changing Advisors and Advisor checks slug: changing-advisor-checks -category: 66acabbe485c6000126b0499 +category: 66eb0386f81fe000105dbea7 order: 3 hidden: 0 --- diff --git a/docs/api/advisor-api/failed-checks.md b/docs/api/advisor-api/failed-checks.md index 4e10586a4f..e3a93c15cb 100644 --- a/docs/api/advisor-api/failed-checks.md +++ b/docs/api/advisor-api/failed-checks.md @@ -1,7 +1,7 @@ --- title: List of problems detected by Advisors slug: failed-checks -category: 66acabbe485c6000126b0499 +category: 66eb0386f81fe000105dbea7 order: 2 hidden: 0 --- diff --git a/docs/api/advisor-api/overview.md b/docs/api/advisor-api/overview.md index 7d0e1b648c..693563debd 100644 --- a/docs/api/advisor-api/overview.md +++ b/docs/api/advisor-api/overview.md @@ -1,15 +1,13 @@ --- title: Overview slug: pmm-advisors -category: 66acabbe485c6000126b0499 +category: 66eb0386f81fe000105dbea7 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](failed-checks) you can find API to get information about potential problems with your Infrastructure detected by Advisors. -- [Percona Advisors and Advisors checks](advisors-and-advisor-checks) lists all Advisors and Advisor Checks available in your PMM. +- [Percona Advisors and Advisor checks](advisors-and-advisor-checks) lists all Advisors and Advisor Checks available in your PMM. - [Changing Advisors and Advisor checks](changing-advisor-checks) will help you automate Advisor checks modification if needed. diff --git a/docs/api/backups/list-locations.md b/docs/api/backups/list-locations.md index 7834ccd6c5..9bb6580dff 100644 --- a/docs/api/backups/list-locations.md +++ b/docs/api/backups/list-locations.md @@ -2,7 +2,7 @@ title: List Locations slug: listlocations excerpt: ListLocations returns a list of all backup locations. -category: 66acac6024b4bc0022d980f3 +category: 66eb06589a42ac3f7ee6dee2 --- The following API call will list all the available backup locations: diff --git a/docs/api/backups/overview.md b/docs/api/backups/overview.md index b7b520cfeb..6e952cc2e5 100644 --- a/docs/api/backups/overview.md +++ b/docs/api/backups/overview.md @@ -1,7 +1,7 @@ --- title: Overview slug: database-backups -category: 66acac6024b4bc0022d980f3 +category: 66eb06589a42ac3f7ee6dee2 order: 0 --- diff --git a/docs/api/backups/restore-backup.md b/docs/api/backups/restore-backup.md index 31589c3461..91a578f67d 100644 --- a/docs/api/backups/restore-backup.md +++ b/docs/api/backups/restore-backup.md @@ -2,7 +2,7 @@ title: Restore from a backup slug: restorebackup excerpt: This endpoint allows to restore a database from a previously made backup. -category: 66acac6024b4bc0022d980f3 +category: 66eb06589a42ac3f7ee6dee2 --- PMM can backup the monitored services. diff --git a/docs/api/backups/start-backup.md b/docs/api/backups/start-backup.md index fcb935660b..3672d0af16 100644 --- a/docs/api/backups/start-backup.md +++ b/docs/api/backups/start-backup.md @@ -2,7 +2,7 @@ title: Make a backup slug: startbackup excerpt: This endpoint allows to make an unscheduled, or ad-hoc, backup of a given service. -category: 66acac6024b4bc0022d980f3 +category: 66eb06589a42ac3f7ee6dee2 --- PMM can backup the monitored services. diff --git a/docs/api/inventory/add-agent.md b/docs/api/inventory/add-agent.md index 6c77ea95f4..ec576663ba 100644 --- a/docs/api/inventory/add-agent.md +++ b/docs/api/inventory/add-agent.md @@ -1,7 +1,7 @@ --- title: Add an Agent slug: addagent -category: 66aca9bf17142b005ad4e9fa +category: 66eb0600d159ac004f5fe06d --- ## Add an Agent diff --git a/docs/api/inventory/add-node.md b/docs/api/inventory/add-node.md index 6cfe8529ed..a12a73e06a 100644 --- a/docs/api/inventory/add-node.md +++ b/docs/api/inventory/add-node.md @@ -1,7 +1,7 @@ --- title: Add a Node slug: addnode -category: 66aca9bf17142b005ad4e9fa +category: 66eb0600d159ac004f5fe06d --- ## Add a Node diff --git a/docs/api/inventory/add-service.md b/docs/api/inventory/add-service.md index 406e24d06e..fe2fae348e 100644 --- a/docs/api/inventory/add-service.md +++ b/docs/api/inventory/add-service.md @@ -1,7 +1,7 @@ --- title: Add a Service slug: addservice -category: 66aca9bf17142b005ad4e9fa +category: 66eb0600d159ac004f5fe06d --- ## Add a Service diff --git a/docs/api/inventory/change-agent.md b/docs/api/inventory/change-agent.md index 5db94ac192..1027cd62e7 100644 --- a/docs/api/inventory/change-agent.md +++ b/docs/api/inventory/change-agent.md @@ -1,7 +1,7 @@ --- title: Change Agent Attributes slug: changeagent -category: 66aca9bf17142b005ad4e9fa +category: 66eb0600d159ac004f5fe06d --- ## Change Agent Attributes diff --git a/docs/api/inventory/list-nodes.md b/docs/api/inventory/list-nodes.md index 5709c8b8f5..8d13f2fc44 100644 --- a/docs/api/inventory/list-nodes.md +++ b/docs/api/inventory/list-nodes.md @@ -1,7 +1,7 @@ --- title: List Nodes slug: listnodes -category: 66aca9bf17142b005ad4e9fa +category: 66eb0600d159ac004f5fe06d --- ## List Nodes diff --git a/docs/api/inventory/list-services.md b/docs/api/inventory/list-services.md index 3c32f8bc0b..2824bce23c 100644 --- a/docs/api/inventory/list-services.md +++ b/docs/api/inventory/list-services.md @@ -1,7 +1,7 @@ --- title: List Services slug: listservices -category: 66aca9bf17142b005ad4e9fa +category: 66eb0600d159ac004f5fe06d --- ## List Services diff --git a/docs/api/pmm-server-config/account-management/bulk-add-users.md b/docs/api/pmm-server-config/account-management/bulk-add-users.md index 4a2de7ca90..9abf6118ad 100644 --- a/docs/api/pmm-server-config/account-management/bulk-add-users.md +++ b/docs/api/pmm-server-config/account-management/bulk-add-users.md @@ -1,8 +1,8 @@ --- title: Create user accounts slug: bulk-add-users -category: 66acab7b0bf230001846b5e2 -parentDoc: 66acad52c21a1a0036295235 +categorySlug: pmm-server-maintenance +parentDocSlug: pmm-server-user-accounts order: 1 --- diff --git a/docs/api/pmm-server-config/account-management/change-admin-password.md b/docs/api/pmm-server-config/account-management/change-admin-password.md index 910ecb52aa..a793b84375 100644 --- a/docs/api/pmm-server-config/account-management/change-admin-password.md +++ b/docs/api/pmm-server-config/account-management/change-admin-password.md @@ -1,8 +1,8 @@ --- title: Change the administrator's password slug: change-admin-password -category: 66acab7b0bf230001846b5e2 -parentDoc: 66acad52c21a1a0036295235 +categorySlug: pmm-server-maintenance +parentDocSlug: pmm-server-user-accounts order: 0 --- diff --git a/docs/api/pmm-server-config/overview.md b/docs/api/pmm-server-config/overview.md index ac269b3533..473c50fd26 100644 --- a/docs/api/pmm-server-config/overview.md +++ b/docs/api/pmm-server-config/overview.md @@ -1,8 +1,16 @@ --- title: Overview slug: pmm-server-configuration -category: 66acab7b0bf230001846b5e2 +categorySlug: pmm-server-maintenance order: 0 --- This section will provide you with information on how to perform configuration and maintenance of a PMM Server. + +- [PMM Server Version](ref:version) +- [PMM Server Readiness](ref:readiness) +- PMM Server Settings + - [Get settings](ref:getsettings) + - [Change settings](ref:changesettings) +- PMM Server High Availability + - \ No newline at end of file diff --git a/docs/api/pmm-server-config/pmm-server-settings.md b/docs/api/pmm-server-config/pmm-server-settings.md index e9e95df6c7..2c33564836 100644 --- a/docs/api/pmm-server-config/pmm-server-settings.md +++ b/docs/api/pmm-server-config/pmm-server-settings.md @@ -1,8 +1,9 @@ --- title: PMM Server Settings slug: pmm-server-settings -category: 66acab7b0bf230001846b5e2 +categorySlug: pmm-server-maintenance order: 2 +hidden: 1 --- This section will explain how to configure your PMM Server to get the most out of its functionality. diff --git a/docs/api/pmm-server-config/pmm-server-troubleshooting.md b/docs/api/pmm-server-config/pmm-server-troubleshooting.md index 7b1bf8d931..361bb865fe 100644 --- a/docs/api/pmm-server-config/pmm-server-troubleshooting.md +++ b/docs/api/pmm-server-config/pmm-server-troubleshooting.md @@ -1,7 +1,7 @@ --- title: Troubleshooting slug: pmm-server-troubleshooting -category: 66acab7b0bf230001846b5e2 +categorySlug: pmm-server-maintenance order: 4 hidden: 0 --- diff --git a/docs/api/pmm-server-config/pmm-server-upgrade.md b/docs/api/pmm-server-config/pmm-server-upgrade.md index 012db77a63..b703870856 100644 --- a/docs/api/pmm-server-config/pmm-server-upgrade.md +++ b/docs/api/pmm-server-config/pmm-server-upgrade.md @@ -1,7 +1,7 @@ --- title: Upgrade your PMM Server slug: pmm-server-upgrade -category: 66acab7b0bf230001846b5e2 +categorySlug: pmm-server-maintenance order: 3 --- diff --git a/docs/api/pmm-server-config/troubleshooting/logs.md b/docs/api/pmm-server-config/troubleshooting/logs.md index cdc4a9bc8c..a622063c4c 100644 --- a/docs/api/pmm-server-config/troubleshooting/logs.md +++ b/docs/api/pmm-server-config/troubleshooting/logs.md @@ -1,7 +1,8 @@ --- title: Logs slug: "logs" -category: 66acab7b0bf230001846b5e2 +categorySlug: pmm-server-maintenance +parentDocSlug: pmm-server-troubleshooting --- Download the logs and components configuration to troubleshoot any issues with the PMM Server. @@ -38,6 +39,6 @@ The downloaded logs package contains the following structure: { "type": "info", "title": "PMM Server Version", - "body": "PMM Server also dumps its version info to a special file `installed.json`. \n\n```shell\n% cat installed.json | jq\n{\n \"version\": \"2.26.0\",\n \"full_version\": \"2.26.0-17.2202021129.6914083.el7\",\n \"build_time\": \"2022-02-02T11:30:45Z\",\n \"repo\": \"local\"\n}\n```" + "body": "PMM Server also dumps its version info to a special file `installed.json`. \n\n```shell\n% cat installed.json | jq\n{\n \"version\": \"3.0.0\",\n \"full_version\": \"3.0.0-1.2412081130.6914083.el9\",\n \"build_time\": \"2024-12-08T11:30:45Z\",\n \"repo\": \"local\"\n}\n```" } [/block] diff --git a/docs/api/pmm-server-config/user-account-management.md b/docs/api/pmm-server-config/user-account-management.md index 01d53fa149..579ba76623 100644 --- a/docs/api/pmm-server-config/user-account-management.md +++ b/docs/api/pmm-server-config/user-account-management.md @@ -1,7 +1,7 @@ --- title: User account management -slug: pmm-server-config-security -category: 66acab7b0bf230001846b5e2 +slug: pmm-server-user-accounts +categorySlug: pmm-server-maintenance order: 1 --- From c84cc3a770a83f98a0c92d87660c45af3c430cbc Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Thu, 19 Sep 2024 09:19:39 +0000 Subject: [PATCH 02/16] PMM-12985 Apply API infra modifications --- api/advisors/v1/advisors.pb.go | 153 +++++++++--------- api/advisors/v1/advisors.proto | 6 +- .../advisor_service/advisor_service_client.go | 2 +- api/advisors/v1/json/v1.json | 6 +- .../server_service/server_service_client.go | 4 +- api/server/v1/json/v1.json | 4 +- api/server/v1/server.pb.go | 130 ++++++++------- api/server/v1/server_grpc.pb.go | 2 + api/swagger/swagger-dev.json | 10 +- api/swagger/swagger.json | 10 +- docs/api/access-control/access-control.md | 8 +- .../advisors-and-advisor-checks.md | 2 +- .../advisor-api/changing-advisor-checks.md | 2 +- docs/api/advisor-api/failed-checks.md | 4 +- docs/api/advisor-api/overview.md | 11 +- docs/api/pmm-server-config/overview.md | 6 +- .../pmm-server-config/troubleshooting/logs.md | 2 +- 17 files changed, 183 insertions(+), 179 deletions(-) diff --git a/api/advisors/v1/advisors.pb.go b/api/advisors/v1/advisors.pb.go index 58dddcc7fc..81b2c10fc6 100644 --- a/api/advisors/v1/advisors.pb.go +++ b/api/advisors/v1/advisors.pb.go @@ -1471,7 +1471,7 @@ var file_advisors_v1_advisors_proto_rawDesc = []byte{ 0x48, 0x45, 0x43, 0x4b, 0x5f, 0x46, 0x41, 0x4d, 0x49, 0x4c, 0x59, 0x5f, 0x50, 0x4f, 0x53, 0x54, 0x47, 0x52, 0x45, 0x53, 0x51, 0x4c, 0x10, 0x02, 0x12, 0x20, 0x0a, 0x1c, 0x41, 0x44, 0x56, 0x49, 0x53, 0x4f, 0x52, 0x5f, 0x43, 0x48, 0x45, 0x43, 0x4b, 0x5f, 0x46, 0x41, 0x4d, 0x49, 0x4c, 0x59, - 0x5f, 0x4d, 0x4f, 0x4e, 0x47, 0x4f, 0x44, 0x42, 0x10, 0x03, 0x32, 0xe6, 0x0a, 0x0a, 0x0e, 0x41, + 0x5f, 0x4d, 0x4f, 0x4e, 0x47, 0x4f, 0x44, 0x42, 0x10, 0x03, 0x32, 0xee, 0x0a, 0x0a, 0x0e, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x53, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, 0x12, 0xf3, 0x01, 0x0a, 0x12, 0x4c, 0x69, 0x73, 0x74, 0x46, 0x61, 0x69, 0x6c, 0x65, 0x64, 0x53, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, 0x73, 0x12, 0x26, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, @@ -1488,87 +1488,88 @@ var file_advisors_v1_advisors_proto_rawDesc = []byte{ 0x66, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x20, 0x72, 0x65, 0x73, 0x75, 0x6c, 0x74, 0x73, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x1d, 0x12, 0x1b, 0x2f, 0x76, 0x31, 0x2f, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x66, 0x61, 0x69, 0x6c, 0x65, 0x64, 0x53, 0x65, 0x72, 0x76, 0x69, - 0x63, 0x65, 0x73, 0x12, 0xcd, 0x01, 0x0a, 0x0f, 0x47, 0x65, 0x74, 0x46, 0x61, 0x69, 0x6c, 0x65, + 0x63, 0x65, 0x73, 0x12, 0xd5, 0x01, 0x0a, 0x0f, 0x47, 0x65, 0x74, 0x46, 0x61, 0x69, 0x6c, 0x65, 0x64, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x12, 0x23, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x47, 0x65, 0x74, 0x46, 0x61, 0x69, 0x6c, 0x65, 0x64, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x24, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x47, 0x65, 0x74, 0x46, 0x61, 0x69, 0x6c, 0x65, 0x64, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, - 0x73, 0x65, 0x22, 0x6f, 0x92, 0x41, 0x4a, 0x12, 0x11, 0x47, 0x65, 0x74, 0x20, 0x46, 0x61, 0x69, - 0x6c, 0x65, 0x64, 0x20, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x1a, 0x35, 0x52, 0x65, 0x74, 0x75, - 0x72, 0x6e, 0x73, 0x20, 0x74, 0x68, 0x65, 0x20, 0x6c, 0x61, 0x74, 0x65, 0x73, 0x74, 0x20, 0x63, - 0x68, 0x65, 0x63, 0x6b, 0x20, 0x72, 0x65, 0x73, 0x75, 0x6c, 0x74, 0x73, 0x20, 0x66, 0x6f, 0x72, - 0x20, 0x61, 0x20, 0x67, 0x69, 0x76, 0x65, 0x6e, 0x20, 0x73, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, - 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x1c, 0x12, 0x1a, 0x2f, 0x76, 0x31, 0x2f, 0x61, 0x64, 0x76, - 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x2f, 0x66, 0x61, 0x69, - 0x6c, 0x65, 0x64, 0x12, 0xb0, 0x02, 0x0a, 0x12, 0x53, 0x74, 0x61, 0x72, 0x74, 0x41, 0x64, 0x76, - 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x12, 0x26, 0x2e, 0x61, 0x64, 0x76, - 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x53, 0x74, 0x61, 0x72, 0x74, 0x41, 0x64, - 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, - 0x73, 0x74, 0x1a, 0x27, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, + 0x73, 0x65, 0x22, 0x77, 0x92, 0x41, 0x52, 0x12, 0x19, 0x47, 0x65, 0x74, 0x20, 0x46, 0x61, 0x69, + 0x6c, 0x65, 0x64, 0x20, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x20, 0x43, 0x68, 0x65, 0x63, + 0x6b, 0x73, 0x1a, 0x35, 0x52, 0x65, 0x74, 0x75, 0x72, 0x6e, 0x73, 0x20, 0x74, 0x68, 0x65, 0x20, + 0x6c, 0x61, 0x74, 0x65, 0x73, 0x74, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x20, 0x72, 0x65, 0x73, + 0x75, 0x6c, 0x74, 0x73, 0x20, 0x66, 0x6f, 0x72, 0x20, 0x61, 0x20, 0x67, 0x69, 0x76, 0x65, 0x6e, + 0x20, 0x73, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x1c, 0x12, + 0x1a, 0x2f, 0x76, 0x31, 0x2f, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x63, 0x68, + 0x65, 0x63, 0x6b, 0x73, 0x2f, 0x66, 0x61, 0x69, 0x6c, 0x65, 0x64, 0x12, 0xb0, 0x02, 0x0a, 0x12, + 0x53, 0x74, 0x61, 0x72, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, + 0x6b, 0x73, 0x12, 0x26, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x53, 0x74, 0x61, 0x72, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, - 0x63, 0x6b, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0xc8, 0x01, 0x92, 0x41, - 0xa0, 0x01, 0x12, 0x14, 0x53, 0x74, 0x61, 0x72, 0x74, 0x20, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, - 0x72, 0x20, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x1a, 0x87, 0x01, 0x45, 0x78, 0x65, 0x63, 0x75, - 0x74, 0x65, 0x73, 0x20, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x20, 0x63, 0x68, 0x65, 0x63, - 0x6b, 0x73, 0x20, 0x61, 0x6e, 0x64, 0x20, 0x72, 0x65, 0x74, 0x75, 0x72, 0x6e, 0x73, 0x20, 0x77, - 0x68, 0x65, 0x6e, 0x20, 0x61, 0x6c, 0x6c, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x20, 0x61, - 0x72, 0x65, 0x20, 0x65, 0x78, 0x65, 0x63, 0x75, 0x74, 0x65, 0x64, 0x2e, 0x20, 0x41, 0x6c, 0x6c, - 0x20, 0x61, 0x76, 0x61, 0x69, 0x6c, 0x61, 0x62, 0x6c, 0x65, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, - 0x73, 0x20, 0x77, 0x69, 0x6c, 0x6c, 0x20, 0x62, 0x65, 0x20, 0x73, 0x74, 0x61, 0x72, 0x74, 0x65, - 0x64, 0x20, 0x69, 0x66, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x20, 0x6e, 0x61, 0x6d, 0x65, 0x73, - 0x20, 0x61, 0x72, 0x65, 0x6e, 0x27, 0x74, 0x20, 0x73, 0x70, 0x65, 0x63, 0x69, 0x66, 0x69, 0x65, - 0x64, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x1e, 0x3a, 0x01, 0x2a, 0x22, 0x19, 0x2f, 0x76, 0x31, - 0x2f, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, - 0x3a, 0x73, 0x74, 0x61, 0x72, 0x74, 0x12, 0xc3, 0x01, 0x0a, 0x11, 0x4c, 0x69, 0x73, 0x74, 0x41, - 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x12, 0x25, 0x2e, 0x61, - 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x41, - 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x71, 0x75, - 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, - 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, - 0x63, 0x6b, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x5f, 0x92, 0x41, 0x41, - 0x12, 0x13, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x20, 0x63, - 0x68, 0x65, 0x63, 0x6b, 0x73, 0x1a, 0x2a, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x61, 0x64, 0x76, 0x69, - 0x73, 0x6f, 0x72, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x20, 0x61, 0x76, 0x61, 0x69, 0x6c, - 0x61, 0x62, 0x6c, 0x65, 0x20, 0x74, 0x6f, 0x20, 0x74, 0x68, 0x65, 0x20, 0x75, 0x73, 0x65, 0x72, - 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x15, 0x12, 0x13, 0x2f, 0x76, 0x31, 0x2f, 0x61, 0x64, 0x76, - 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x12, 0xa1, 0x01, 0x0a, - 0x0c, 0x4c, 0x69, 0x73, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x12, 0x20, 0x2e, - 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, - 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, - 0x21, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x4c, 0x69, - 0x73, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, - 0x73, 0x65, 0x22, 0x4c, 0x92, 0x41, 0x35, 0x12, 0x0d, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x61, 0x64, - 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x1a, 0x24, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x61, 0x64, 0x76, - 0x69, 0x73, 0x6f, 0x72, 0x73, 0x20, 0x61, 0x76, 0x61, 0x69, 0x6c, 0x61, 0x62, 0x6c, 0x65, 0x20, - 0x74, 0x6f, 0x20, 0x74, 0x68, 0x65, 0x20, 0x75, 0x73, 0x65, 0x72, 0x2e, 0x82, 0xd3, 0xe4, 0x93, - 0x02, 0x0e, 0x12, 0x0c, 0x2f, 0x76, 0x31, 0x2f, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, - 0x12, 0xf0, 0x01, 0x0a, 0x13, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x41, 0x64, 0x76, 0x69, 0x73, - 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x12, 0x27, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, - 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x41, 0x64, 0x76, - 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, - 0x74, 0x1a, 0x28, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, - 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, - 0x63, 0x6b, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x85, 0x01, 0x92, 0x41, - 0x58, 0x12, 0x15, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x20, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, - 0x72, 0x20, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x1a, 0x3f, 0x45, 0x6e, 0x61, 0x62, 0x6c, 0x65, - 0x73, 0x2f, 0x64, 0x69, 0x73, 0x61, 0x62, 0x6c, 0x65, 0x73, 0x20, 0x61, 0x64, 0x76, 0x69, 0x73, - 0x6f, 0x72, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x20, 0x6f, 0x72, 0x20, 0x63, 0x68, 0x61, - 0x6e, 0x67, 0x65, 0x73, 0x20, 0x74, 0x68, 0x65, 0x69, 0x72, 0x20, 0x65, 0x78, 0x65, 0x63, 0x20, - 0x69, 0x6e, 0x74, 0x65, 0x72, 0x76, 0x61, 0x6c, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x24, 0x3a, - 0x01, 0x2a, 0x22, 0x1f, 0x2f, 0x76, 0x31, 0x2f, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, - 0x2f, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x3a, 0x62, 0x61, 0x74, 0x63, 0x68, 0x43, 0x68, 0x61, - 0x6e, 0x67, 0x65, 0x42, 0xa0, 0x01, 0x0a, 0x0f, 0x63, 0x6f, 0x6d, 0x2e, 0x61, 0x64, 0x76, 0x69, - 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x42, 0x0d, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, - 0x73, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x31, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, - 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x70, 0x65, 0x72, 0x63, 0x6f, 0x6e, 0x61, 0x2f, 0x70, 0x6d, 0x6d, - 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x76, 0x31, - 0x3b, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x76, 0x31, 0xa2, 0x02, 0x03, 0x41, 0x58, - 0x58, 0xaa, 0x02, 0x0b, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x56, 0x31, 0xca, - 0x02, 0x0b, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x5c, 0x56, 0x31, 0xe2, 0x02, 0x17, - 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x5c, 0x56, 0x31, 0x5c, 0x47, 0x50, 0x42, 0x4d, - 0x65, 0x74, 0x61, 0x64, 0x61, 0x74, 0x61, 0xea, 0x02, 0x0c, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, - 0x72, 0x73, 0x3a, 0x3a, 0x56, 0x31, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x63, 0x6b, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x27, 0x2e, 0x61, 0x64, 0x76, + 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x53, 0x74, 0x61, 0x72, 0x74, 0x41, 0x64, + 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, + 0x6e, 0x73, 0x65, 0x22, 0xc8, 0x01, 0x92, 0x41, 0xa0, 0x01, 0x12, 0x14, 0x53, 0x74, 0x61, 0x72, + 0x74, 0x20, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x20, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, + 0x1a, 0x87, 0x01, 0x45, 0x78, 0x65, 0x63, 0x75, 0x74, 0x65, 0x73, 0x20, 0x41, 0x64, 0x76, 0x69, + 0x73, 0x6f, 0x72, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x20, 0x61, 0x6e, 0x64, 0x20, 0x72, + 0x65, 0x74, 0x75, 0x72, 0x6e, 0x73, 0x20, 0x77, 0x68, 0x65, 0x6e, 0x20, 0x61, 0x6c, 0x6c, 0x20, + 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x20, 0x61, 0x72, 0x65, 0x20, 0x65, 0x78, 0x65, 0x63, 0x75, + 0x74, 0x65, 0x64, 0x2e, 0x20, 0x41, 0x6c, 0x6c, 0x20, 0x61, 0x76, 0x61, 0x69, 0x6c, 0x61, 0x62, + 0x6c, 0x65, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x20, 0x77, 0x69, 0x6c, 0x6c, 0x20, 0x62, + 0x65, 0x20, 0x73, 0x74, 0x61, 0x72, 0x74, 0x65, 0x64, 0x20, 0x69, 0x66, 0x20, 0x63, 0x68, 0x65, + 0x63, 0x6b, 0x20, 0x6e, 0x61, 0x6d, 0x65, 0x73, 0x20, 0x61, 0x72, 0x65, 0x6e, 0x27, 0x74, 0x20, + 0x73, 0x70, 0x65, 0x63, 0x69, 0x66, 0x69, 0x65, 0x64, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x1e, + 0x3a, 0x01, 0x2a, 0x22, 0x19, 0x2f, 0x76, 0x31, 0x2f, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, + 0x73, 0x2f, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x3a, 0x73, 0x74, 0x61, 0x72, 0x74, 0x12, 0xc3, + 0x01, 0x0a, 0x11, 0x4c, 0x69, 0x73, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, + 0x65, 0x63, 0x6b, 0x73, 0x12, 0x25, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, + 0x76, 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, + 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x61, 0x64, + 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x41, 0x64, + 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, + 0x6e, 0x73, 0x65, 0x22, 0x5f, 0x92, 0x41, 0x41, 0x12, 0x13, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x41, + 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x20, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x1a, 0x2a, 0x4c, + 0x69, 0x73, 0x74, 0x20, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x20, 0x63, 0x68, 0x65, 0x63, + 0x6b, 0x73, 0x20, 0x61, 0x76, 0x61, 0x69, 0x6c, 0x61, 0x62, 0x6c, 0x65, 0x20, 0x74, 0x6f, 0x20, + 0x74, 0x68, 0x65, 0x20, 0x75, 0x73, 0x65, 0x72, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x15, 0x12, + 0x13, 0x2f, 0x76, 0x31, 0x2f, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x63, 0x68, + 0x65, 0x63, 0x6b, 0x73, 0x12, 0xa1, 0x01, 0x0a, 0x0c, 0x4c, 0x69, 0x73, 0x74, 0x41, 0x64, 0x76, + 0x69, 0x73, 0x6f, 0x72, 0x73, 0x12, 0x20, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, + 0x2e, 0x76, 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, + 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x21, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, + 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, + 0x72, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x4c, 0x92, 0x41, 0x35, 0x12, + 0x0d, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x1a, 0x24, + 0x4c, 0x69, 0x73, 0x74, 0x20, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x20, 0x61, 0x76, + 0x61, 0x69, 0x6c, 0x61, 0x62, 0x6c, 0x65, 0x20, 0x74, 0x6f, 0x20, 0x74, 0x68, 0x65, 0x20, 0x75, + 0x73, 0x65, 0x72, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x0e, 0x12, 0x0c, 0x2f, 0x76, 0x31, 0x2f, + 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x12, 0xf0, 0x01, 0x0a, 0x13, 0x43, 0x68, 0x61, + 0x6e, 0x67, 0x65, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, + 0x12, 0x27, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x43, + 0x68, 0x61, 0x6e, 0x67, 0x65, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, + 0x6b, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x28, 0x2e, 0x61, 0x64, 0x76, 0x69, + 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x41, 0x64, + 0x76, 0x69, 0x73, 0x6f, 0x72, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, + 0x6e, 0x73, 0x65, 0x22, 0x85, 0x01, 0x92, 0x41, 0x58, 0x12, 0x15, 0x43, 0x68, 0x61, 0x6e, 0x67, + 0x65, 0x20, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x20, 0x43, 0x68, 0x65, 0x63, 0x6b, 0x73, + 0x1a, 0x3f, 0x45, 0x6e, 0x61, 0x62, 0x6c, 0x65, 0x73, 0x2f, 0x64, 0x69, 0x73, 0x61, 0x62, 0x6c, + 0x65, 0x73, 0x20, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x20, 0x63, 0x68, 0x65, 0x63, 0x6b, + 0x73, 0x20, 0x6f, 0x72, 0x20, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x20, 0x74, 0x68, 0x65, + 0x69, 0x72, 0x20, 0x65, 0x78, 0x65, 0x63, 0x20, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x76, 0x61, 0x6c, + 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x24, 0x3a, 0x01, 0x2a, 0x22, 0x1f, 0x2f, 0x76, 0x31, 0x2f, + 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x63, 0x68, 0x65, 0x63, 0x6b, 0x73, 0x3a, + 0x62, 0x61, 0x74, 0x63, 0x68, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x42, 0xa0, 0x01, 0x0a, 0x0f, + 0x63, 0x6f, 0x6d, 0x2e, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x76, 0x31, 0x42, + 0x0d, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, + 0x5a, 0x31, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x70, 0x65, 0x72, + 0x63, 0x6f, 0x6e, 0x61, 0x2f, 0x70, 0x6d, 0x6d, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x61, 0x64, 0x76, + 0x69, 0x73, 0x6f, 0x72, 0x73, 0x2f, 0x76, 0x31, 0x3b, 0x61, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, + 0x73, 0x76, 0x31, 0xa2, 0x02, 0x03, 0x41, 0x58, 0x58, 0xaa, 0x02, 0x0b, 0x41, 0x64, 0x76, 0x69, + 0x73, 0x6f, 0x72, 0x73, 0x2e, 0x56, 0x31, 0xca, 0x02, 0x0b, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, + 0x72, 0x73, 0x5c, 0x56, 0x31, 0xe2, 0x02, 0x17, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, + 0x5c, 0x56, 0x31, 0x5c, 0x47, 0x50, 0x42, 0x4d, 0x65, 0x74, 0x61, 0x64, 0x61, 0x74, 0x61, 0xea, + 0x02, 0x0c, 0x41, 0x64, 0x76, 0x69, 0x73, 0x6f, 0x72, 0x73, 0x3a, 0x3a, 0x56, 0x31, 0x62, 0x06, + 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( diff --git a/api/advisors/v1/advisors.proto b/api/advisors/v1/advisors.proto index 2bb1ec43ea..4475eafb59 100644 --- a/api/advisors/v1/advisors.proto +++ b/api/advisors/v1/advisors.proto @@ -177,7 +177,7 @@ service AdvisorService { rpc GetFailedChecks(GetFailedChecksRequest) returns (GetFailedChecksResponse) { option (google.api.http) = {get: "/v1/advisors/checks/failed"}; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - summary: "Get Failed Checks" + summary: "Get Failed Advisor Checks" description: "Returns the latest check results for a given service." }; } @@ -196,7 +196,7 @@ service AdvisorService { rpc ListAdvisorChecks(ListAdvisorChecksRequest) returns (ListAdvisorChecksResponse) { option (google.api.http) = {get: "/v1/advisors/checks"}; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - summary: "List advisor checks" + summary: "List Advisor Checks" description: "List advisor checks available to the user." }; } @@ -204,7 +204,7 @@ service AdvisorService { rpc ListAdvisors(ListAdvisorsRequest) returns (ListAdvisorsResponse) { option (google.api.http) = {get: "/v1/advisors"}; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { - summary: "List advisors" + summary: "List Advisors" description: "List advisors available to the user." }; } diff --git a/api/advisors/v1/json/client/advisor_service/advisor_service_client.go b/api/advisors/v1/json/client/advisor_service/advisor_service_client.go index 482fb2a042..bf09cf61bf 100644 --- a/api/advisors/v1/json/client/advisor_service/advisor_service_client.go +++ b/api/advisors/v1/json/client/advisor_service/advisor_service_client.go @@ -83,7 +83,7 @@ func (a *Client) ChangeAdvisorChecks(params *ChangeAdvisorChecksParams, opts ... } /* -GetFailedChecks gets failed checks +GetFailedChecks gets failed advisor checks Returns the latest check results for a given service. */ diff --git a/api/advisors/v1/json/v1.json b/api/advisors/v1/json/v1.json index 66354f636e..27f5c020e9 100644 --- a/api/advisors/v1/json/v1.json +++ b/api/advisors/v1/json/v1.json @@ -21,7 +21,7 @@ "tags": [ "AdvisorService" ], - "summary": "List advisors", + "summary": "List Advisors", "operationId": "ListAdvisors", "responses": { "200": { @@ -160,7 +160,7 @@ "tags": [ "AdvisorService" ], - "summary": "List advisor checks", + "summary": "List Advisor Checks", "operationId": "ListAdvisorChecks", "responses": { "200": { @@ -264,7 +264,7 @@ "tags": [ "AdvisorService" ], - "summary": "Get Failed Checks", + "summary": "Get Failed Advisor Checks", "operationId": "GetFailedChecks", "parameters": [ { diff --git a/api/server/v1/json/client/server_service/server_service_client.go b/api/server/v1/json/client/server_service/server_service_client.go index 15bd3eb6e5..ac68e653dc 100644 --- a/api/server/v1/json/client/server_service/server_service_client.go +++ b/api/server/v1/json/client/server_service/server_service_client.go @@ -210,9 +210,9 @@ func (a *Client) LeaderHealthCheck(params *LeaderHealthCheckParams, opts ...Clie } /* -ListChangeLogs lists all the changes between the installed version and the latest available version +ListChangeLogs gets the changelog -List all the changes between the installed version and the latest available version +List all the changes between the installed version and the latest available version. */ func (a *Client) ListChangeLogs(params *ListChangeLogsParams, opts ...ClientOption) (*ListChangeLogsOK, error) { // TODO: Validate the params before sending diff --git a/api/server/v1/json/v1.json b/api/server/v1/json/v1.json index 1a43beb50b..5054adca72 100644 --- a/api/server/v1/json/v1.json +++ b/api/server/v1/json/v1.json @@ -798,11 +798,11 @@ }, "/v1/server/updates/changelogs": { "get": { - "description": "List all the changes between the installed version and the latest available version", + "description": "List all the changes between the installed version and the latest available version.", "tags": [ "ServerService" ], - "summary": "List all the changes between the installed version and the latest available version", + "summary": "Get the changelog", "operationId": "ListChangeLogs", "responses": { "200": { diff --git a/api/server/v1/server.pb.go b/api/server/v1/server.pb.go index 076e4063a7..90587a0b57 100644 --- a/api/server/v1/server.pb.go +++ b/api/server/v1/server.pb.go @@ -1857,7 +1857,7 @@ var file_server_v1_server_proto_rawDesc = []byte{ 0x12, 0x1d, 0x0a, 0x19, 0x44, 0x49, 0x53, 0x54, 0x52, 0x49, 0x42, 0x55, 0x54, 0x49, 0x4f, 0x4e, 0x5f, 0x4d, 0x45, 0x54, 0x48, 0x4f, 0x44, 0x5f, 0x41, 0x5a, 0x55, 0x52, 0x45, 0x10, 0x04, 0x12, 0x1a, 0x0a, 0x16, 0x44, 0x49, 0x53, 0x54, 0x52, 0x49, 0x42, 0x55, 0x54, 0x49, 0x4f, 0x4e, 0x5f, - 0x4d, 0x45, 0x54, 0x48, 0x4f, 0x44, 0x5f, 0x44, 0x4f, 0x10, 0x05, 0x32, 0xbf, 0x0e, 0x0a, 0x0d, + 0x4d, 0x45, 0x54, 0x48, 0x4f, 0x44, 0x5f, 0x44, 0x4f, 0x10, 0x05, 0x32, 0xfd, 0x0d, 0x0a, 0x0d, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x53, 0x65, 0x72, 0x76, 0x69, 0x63, 0x65, 0x12, 0x86, 0x01, 0x0a, 0x07, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x19, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x71, @@ -1913,77 +1913,73 @@ var file_server_v1_server_proto_rawDesc = []byte{ 0x61, 0x62, 0x6c, 0x65, 0x20, 0x50, 0x4d, 0x4d, 0x20, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x73, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x14, 0x12, 0x12, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2f, 0x75, 0x70, 0x64, 0x61, 0x74, - 0x65, 0x73, 0x12, 0xab, 0x02, 0x0a, 0x0e, 0x4c, 0x69, 0x73, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, + 0x65, 0x73, 0x12, 0xe9, 0x01, 0x0a, 0x0e, 0x4c, 0x69, 0x73, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x4c, 0x6f, 0x67, 0x73, 0x12, 0x20, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x4c, 0x6f, 0x67, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x21, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x4c, 0x69, 0x73, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x4c, 0x6f, - 0x67, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0xd3, 0x01, 0x92, 0x41, 0xaa, - 0x01, 0x12, 0x53, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x61, 0x6c, 0x6c, 0x20, 0x74, 0x68, 0x65, 0x20, - 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x20, 0x62, 0x65, 0x74, 0x77, 0x65, 0x65, 0x6e, 0x20, - 0x74, 0x68, 0x65, 0x20, 0x69, 0x6e, 0x73, 0x74, 0x61, 0x6c, 0x6c, 0x65, 0x64, 0x20, 0x76, 0x65, - 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x20, 0x61, 0x6e, 0x64, 0x20, 0x74, 0x68, 0x65, 0x20, 0x6c, 0x61, - 0x74, 0x65, 0x73, 0x74, 0x20, 0x61, 0x76, 0x61, 0x69, 0x6c, 0x61, 0x62, 0x6c, 0x65, 0x20, 0x76, - 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x1a, 0x53, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x61, 0x6c, 0x6c, - 0x20, 0x74, 0x68, 0x65, 0x20, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x20, 0x62, 0x65, 0x74, - 0x77, 0x65, 0x65, 0x6e, 0x20, 0x74, 0x68, 0x65, 0x20, 0x69, 0x6e, 0x73, 0x74, 0x61, 0x6c, 0x6c, - 0x65, 0x64, 0x20, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x20, 0x61, 0x6e, 0x64, 0x20, 0x74, - 0x68, 0x65, 0x20, 0x6c, 0x61, 0x74, 0x65, 0x73, 0x74, 0x20, 0x61, 0x76, 0x61, 0x69, 0x6c, 0x61, - 0x62, 0x6c, 0x65, 0x20, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x82, 0xd3, 0xe4, 0x93, 0x02, - 0x1f, 0x12, 0x1d, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2f, 0x75, 0x70, - 0x64, 0x61, 0x74, 0x65, 0x73, 0x2f, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x6c, 0x6f, 0x67, 0x73, - 0x12, 0x9d, 0x01, 0x0a, 0x0b, 0x53, 0x74, 0x61, 0x72, 0x74, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, - 0x12, 0x1d, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x53, 0x74, 0x61, - 0x72, 0x74, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, - 0x1e, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x53, 0x74, 0x61, 0x72, - 0x74, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, - 0x4f, 0x92, 0x41, 0x29, 0x12, 0x0c, 0x53, 0x74, 0x61, 0x72, 0x74, 0x20, 0x75, 0x70, 0x64, 0x61, - 0x74, 0x65, 0x1a, 0x19, 0x53, 0x74, 0x61, 0x72, 0x74, 0x73, 0x20, 0x50, 0x4d, 0x4d, 0x20, 0x53, - 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x2e, 0x82, 0xd3, 0xe4, - 0x93, 0x02, 0x1d, 0x3a, 0x01, 0x2a, 0x22, 0x18, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, - 0x65, 0x72, 0x2f, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x73, 0x3a, 0x73, 0x74, 0x61, 0x72, 0x74, - 0x12, 0xad, 0x01, 0x0a, 0x0c, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x53, 0x74, 0x61, 0x74, 0x75, - 0x73, 0x12, 0x1e, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x55, 0x70, - 0x64, 0x61, 0x74, 0x65, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, - 0x74, 0x1a, 0x1f, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x55, 0x70, - 0x64, 0x61, 0x74, 0x65, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, - 0x73, 0x65, 0x22, 0x5c, 0x92, 0x41, 0x32, 0x12, 0x0d, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x20, - 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x1a, 0x21, 0x52, 0x65, 0x74, 0x75, 0x72, 0x6e, 0x73, 0x20, - 0x50, 0x4d, 0x4d, 0x20, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x75, 0x70, 0x64, 0x61, 0x74, - 0x65, 0x20, 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x21, 0x3a, - 0x01, 0x2a, 0x22, 0x1c, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2f, 0x75, - 0x70, 0x64, 0x61, 0x74, 0x65, 0x73, 0x3a, 0x67, 0x65, 0x74, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, - 0x12, 0xa0, 0x01, 0x0a, 0x0b, 0x47, 0x65, 0x74, 0x53, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, - 0x12, 0x1d, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x47, 0x65, 0x74, - 0x53, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, - 0x1e, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x47, 0x65, 0x74, 0x53, - 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, - 0x52, 0x92, 0x41, 0x34, 0x12, 0x0c, 0x47, 0x65, 0x74, 0x20, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, - 0x67, 0x73, 0x1a, 0x24, 0x52, 0x65, 0x74, 0x75, 0x72, 0x6e, 0x73, 0x20, 0x63, 0x75, 0x72, 0x72, - 0x65, 0x6e, 0x74, 0x20, 0x50, 0x4d, 0x4d, 0x20, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x73, - 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x15, 0x12, 0x13, - 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2f, 0x73, 0x65, 0x74, 0x74, 0x69, - 0x6e, 0x67, 0x73, 0x12, 0xa7, 0x01, 0x0a, 0x0e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x53, 0x65, - 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x12, 0x20, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, + 0x67, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x91, 0x01, 0x92, 0x41, 0x69, + 0x12, 0x11, 0x47, 0x65, 0x74, 0x20, 0x74, 0x68, 0x65, 0x20, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, + 0x6c, 0x6f, 0x67, 0x1a, 0x54, 0x4c, 0x69, 0x73, 0x74, 0x20, 0x61, 0x6c, 0x6c, 0x20, 0x74, 0x68, + 0x65, 0x20, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x20, 0x62, 0x65, 0x74, 0x77, 0x65, 0x65, + 0x6e, 0x20, 0x74, 0x68, 0x65, 0x20, 0x69, 0x6e, 0x73, 0x74, 0x61, 0x6c, 0x6c, 0x65, 0x64, 0x20, + 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x20, 0x61, 0x6e, 0x64, 0x20, 0x74, 0x68, 0x65, 0x20, + 0x6c, 0x61, 0x74, 0x65, 0x73, 0x74, 0x20, 0x61, 0x76, 0x61, 0x69, 0x6c, 0x61, 0x62, 0x6c, 0x65, + 0x20, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x1f, 0x12, + 0x1d, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2f, 0x75, 0x70, 0x64, 0x61, + 0x74, 0x65, 0x73, 0x2f, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x6c, 0x6f, 0x67, 0x73, 0x12, 0x9d, + 0x01, 0x0a, 0x0b, 0x53, 0x74, 0x61, 0x72, 0x74, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x12, 0x1d, + 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x53, 0x74, 0x61, 0x72, 0x74, + 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x1e, 0x2e, + 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x53, 0x74, 0x61, 0x72, 0x74, 0x55, + 0x70, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x4f, 0x92, + 0x41, 0x29, 0x12, 0x0c, 0x53, 0x74, 0x61, 0x72, 0x74, 0x20, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, + 0x1a, 0x19, 0x53, 0x74, 0x61, 0x72, 0x74, 0x73, 0x20, 0x50, 0x4d, 0x4d, 0x20, 0x53, 0x65, 0x72, + 0x76, 0x65, 0x72, 0x20, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, + 0x1d, 0x3a, 0x01, 0x2a, 0x22, 0x18, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, + 0x2f, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x73, 0x3a, 0x73, 0x74, 0x61, 0x72, 0x74, 0x12, 0xad, + 0x01, 0x0a, 0x0c, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x12, + 0x1e, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x55, 0x70, 0x64, 0x61, + 0x74, 0x65, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, + 0x1f, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x55, 0x70, 0x64, 0x61, + 0x74, 0x65, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, + 0x22, 0x5c, 0x92, 0x41, 0x32, 0x12, 0x0d, 0x55, 0x70, 0x64, 0x61, 0x74, 0x65, 0x20, 0x73, 0x74, + 0x61, 0x74, 0x75, 0x73, 0x1a, 0x21, 0x52, 0x65, 0x74, 0x75, 0x72, 0x6e, 0x73, 0x20, 0x50, 0x4d, + 0x4d, 0x20, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x20, + 0x73, 0x74, 0x61, 0x74, 0x75, 0x73, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x21, 0x3a, 0x01, 0x2a, + 0x22, 0x1c, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2f, 0x75, 0x70, 0x64, + 0x61, 0x74, 0x65, 0x73, 0x3a, 0x67, 0x65, 0x74, 0x53, 0x74, 0x61, 0x74, 0x75, 0x73, 0x12, 0xa0, + 0x01, 0x0a, 0x0b, 0x47, 0x65, 0x74, 0x53, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x12, 0x1d, + 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x47, 0x65, 0x74, 0x53, 0x65, + 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x1e, 0x2e, + 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x47, 0x65, 0x74, 0x53, 0x65, 0x74, + 0x74, 0x69, 0x6e, 0x67, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x52, 0x92, + 0x41, 0x34, 0x12, 0x0c, 0x47, 0x65, 0x74, 0x20, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, + 0x1a, 0x24, 0x52, 0x65, 0x74, 0x75, 0x72, 0x6e, 0x73, 0x20, 0x63, 0x75, 0x72, 0x72, 0x65, 0x6e, + 0x74, 0x20, 0x50, 0x4d, 0x4d, 0x20, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x73, 0x65, 0x74, + 0x74, 0x69, 0x6e, 0x67, 0x73, 0x2e, 0x82, 0xd3, 0xe4, 0x93, 0x02, 0x15, 0x12, 0x13, 0x2f, 0x76, + 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2f, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, + 0x73, 0x12, 0xa7, 0x01, 0x0a, 0x0e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x53, 0x65, 0x74, 0x74, + 0x69, 0x6e, 0x67, 0x73, 0x12, 0x20, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, + 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x53, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x52, + 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x21, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x53, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, - 0x73, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x21, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, - 0x72, 0x2e, 0x76, 0x31, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x53, 0x65, 0x74, 0x74, 0x69, - 0x6e, 0x67, 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x50, 0x92, 0x41, 0x2f, - 0x12, 0x0f, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x20, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, - 0x73, 0x1a, 0x1c, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x20, 0x50, 0x4d, 0x4d, 0x20, 0x53, - 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x2e, 0x82, - 0xd3, 0xe4, 0x93, 0x02, 0x18, 0x3a, 0x01, 0x2a, 0x1a, 0x13, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, - 0x72, 0x76, 0x65, 0x72, 0x2f, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x42, 0x90, 0x01, - 0x0a, 0x0d, 0x63, 0x6f, 0x6d, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x42, - 0x0b, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x2d, - 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x70, 0x65, 0x72, 0x63, 0x6f, - 0x6e, 0x61, 0x2f, 0x70, 0x6d, 0x6d, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, - 0x72, 0x2f, 0x76, 0x31, 0x3b, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x76, 0x31, 0xa2, 0x02, 0x03, - 0x53, 0x58, 0x58, 0xaa, 0x02, 0x09, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x56, 0x31, 0xca, - 0x02, 0x09, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x5c, 0x56, 0x31, 0xe2, 0x02, 0x15, 0x53, 0x65, - 0x72, 0x76, 0x65, 0x72, 0x5c, 0x56, 0x31, 0x5c, 0x47, 0x50, 0x42, 0x4d, 0x65, 0x74, 0x61, 0x64, - 0x61, 0x74, 0x61, 0xea, 0x02, 0x0a, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x3a, 0x3a, 0x56, 0x31, - 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x73, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x50, 0x92, 0x41, 0x2f, 0x12, 0x0f, + 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x20, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x1a, + 0x1c, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x20, 0x50, 0x4d, 0x4d, 0x20, 0x53, 0x65, 0x72, + 0x76, 0x65, 0x72, 0x20, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x2e, 0x82, 0xd3, 0xe4, + 0x93, 0x02, 0x18, 0x3a, 0x01, 0x2a, 0x1a, 0x13, 0x2f, 0x76, 0x31, 0x2f, 0x73, 0x65, 0x72, 0x76, + 0x65, 0x72, 0x2f, 0x73, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x73, 0x42, 0x90, 0x01, 0x0a, 0x0d, + 0x63, 0x6f, 0x6d, 0x2e, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x76, 0x31, 0x42, 0x0b, 0x53, + 0x65, 0x72, 0x76, 0x65, 0x72, 0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x2d, 0x67, 0x69, + 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x70, 0x65, 0x72, 0x63, 0x6f, 0x6e, 0x61, + 0x2f, 0x70, 0x6d, 0x6d, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2f, + 0x76, 0x31, 0x3b, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x76, 0x31, 0xa2, 0x02, 0x03, 0x53, 0x58, + 0x58, 0xaa, 0x02, 0x09, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x2e, 0x56, 0x31, 0xca, 0x02, 0x09, + 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x5c, 0x56, 0x31, 0xe2, 0x02, 0x15, 0x53, 0x65, 0x72, 0x76, + 0x65, 0x72, 0x5c, 0x56, 0x31, 0x5c, 0x47, 0x50, 0x42, 0x4d, 0x65, 0x74, 0x61, 0x64, 0x61, 0x74, + 0x61, 0xea, 0x02, 0x0a, 0x53, 0x65, 0x72, 0x76, 0x65, 0x72, 0x3a, 0x3a, 0x56, 0x31, 0x62, 0x06, + 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( diff --git a/api/server/v1/server_grpc.pb.go b/api/server/v1/server_grpc.pb.go index 0a33954455..1e91e3cc14 100644 --- a/api/server/v1/server_grpc.pb.go +++ b/api/server/v1/server_grpc.pb.go @@ -46,6 +46,7 @@ type ServerServiceClient interface { LeaderHealthCheck(ctx context.Context, in *LeaderHealthCheckRequest, opts ...grpc.CallOption) (*LeaderHealthCheckResponse, error) // CheckUpdates checks for available PMM Server updates. CheckUpdates(ctx context.Context, in *CheckUpdatesRequest, opts ...grpc.CallOption) (*CheckUpdatesResponse, error) + // ListChangeLogs delivers the changelog. ListChangeLogs(ctx context.Context, in *ListChangeLogsRequest, opts ...grpc.CallOption) (*ListChangeLogsResponse, error) // StartUpdate starts PMM Server update. StartUpdate(ctx context.Context, in *StartUpdateRequest, opts ...grpc.CallOption) (*StartUpdateResponse, error) @@ -170,6 +171,7 @@ type ServerServiceServer interface { LeaderHealthCheck(context.Context, *LeaderHealthCheckRequest) (*LeaderHealthCheckResponse, error) // CheckUpdates checks for available PMM Server updates. CheckUpdates(context.Context, *CheckUpdatesRequest) (*CheckUpdatesResponse, error) + // ListChangeLogs delivers the changelog. ListChangeLogs(context.Context, *ListChangeLogsRequest) (*ListChangeLogsResponse, error) // StartUpdate starts PMM Server update. StartUpdate(context.Context, *StartUpdateRequest) (*StartUpdateResponse, error) diff --git a/api/swagger/swagger-dev.json b/api/swagger/swagger-dev.json index c6883f65f6..57ee294cd8 100644 --- a/api/swagger/swagger-dev.json +++ b/api/swagger/swagger-dev.json @@ -1334,7 +1334,7 @@ "tags": [ "AdvisorService" ], - "summary": "List advisors", + "summary": "List Advisors", "operationId": "ListAdvisors", "responses": { "200": { @@ -1473,7 +1473,7 @@ "tags": [ "AdvisorService" ], - "summary": "List advisor checks", + "summary": "List Advisor Checks", "operationId": "ListAdvisorChecks", "responses": { "200": { @@ -1577,7 +1577,7 @@ "tags": [ "AdvisorService" ], - "summary": "Get Failed Checks", + "summary": "Get Failed Advisor Checks", "operationId": "GetFailedChecks", "parameters": [ { @@ -27553,11 +27553,11 @@ }, "/v1/server/updates/changelogs": { "get": { - "description": "List all the changes between the installed version and the latest available version", + "description": "List all the changes between the installed version and the latest available version.", "tags": [ "ServerService" ], - "summary": "List all the changes between the installed version and the latest available version", + "summary": "Get the changelog", "operationId": "ListChangeLogs", "responses": { "200": { diff --git a/api/swagger/swagger.json b/api/swagger/swagger.json index 53385898e2..248e1b98d0 100644 --- a/api/swagger/swagger.json +++ b/api/swagger/swagger.json @@ -817,7 +817,7 @@ "tags": [ "AdvisorService" ], - "summary": "List advisors", + "summary": "List Advisors", "operationId": "ListAdvisors", "responses": { "200": { @@ -956,7 +956,7 @@ "tags": [ "AdvisorService" ], - "summary": "List advisor checks", + "summary": "List Advisor Checks", "operationId": "ListAdvisorChecks", "responses": { "200": { @@ -1060,7 +1060,7 @@ "tags": [ "AdvisorService" ], - "summary": "Get Failed Checks", + "summary": "Get Failed Advisor Checks", "operationId": "GetFailedChecks", "parameters": [ { @@ -26595,11 +26595,11 @@ }, "/v1/server/updates/changelogs": { "get": { - "description": "List all the changes between the installed version and the latest available version", + "description": "List all the changes between the installed version and the latest available version.", "tags": [ "ServerService" ], - "summary": "List all the changes between the installed version and the latest available version", + "summary": "Get the changelog", "operationId": "ListChangeLogs", "responses": { "200": { diff --git a/docs/api/access-control/access-control.md b/docs/api/access-control/access-control.md index f10ba0f7db..c8ed0acd7a 100644 --- a/docs/api/access-control/access-control.md +++ b/docs/api/access-control/access-control.md @@ -1,12 +1,10 @@ --- -title: Access Control -slug: access-control -category: 61fc63ec4601b10049339d79 +title: Overview +slug: access-control-overview +category: 66eaff8bc9d854001991ee4f hidden: 0 --- -## Overview - Access Control in PMM can be used to restrict access to individual metrics. Access Control is in **tech preview** and needs to be enabled manually from PMM settings before it can be used. diff --git a/docs/api/advisor-api/advisors-and-advisor-checks.md b/docs/api/advisor-api/advisors-and-advisor-checks.md index 1eb5a0376e..5ea97307fe 100644 --- a/docs/api/advisor-api/advisors-and-advisor-checks.md +++ b/docs/api/advisor-api/advisors-and-advisor-checks.md @@ -3,5 +3,5 @@ title: Percona Advisors and Advisor checks slug: advisors-and-advisor-checks category: 66eb0386f81fe000105dbea7 order: 1 -hidden: 0 +hidden: 1 --- diff --git a/docs/api/advisor-api/changing-advisor-checks.md b/docs/api/advisor-api/changing-advisor-checks.md index d6318dbe3f..65d6376d5b 100644 --- a/docs/api/advisor-api/changing-advisor-checks.md +++ b/docs/api/advisor-api/changing-advisor-checks.md @@ -3,5 +3,5 @@ title: Changing Advisors and Advisor checks slug: changing-advisor-checks category: 66eb0386f81fe000105dbea7 order: 3 -hidden: 0 +hidden: 1 --- diff --git a/docs/api/advisor-api/failed-checks.md b/docs/api/advisor-api/failed-checks.md index e3a93c15cb..caef2fdce0 100644 --- a/docs/api/advisor-api/failed-checks.md +++ b/docs/api/advisor-api/failed-checks.md @@ -1,7 +1,7 @@ --- -title: List of problems detected by Advisors +title: Get Failed Advisor Checks slug: failed-checks category: 66eb0386f81fe000105dbea7 order: 2 -hidden: 0 +hidden: 1 --- diff --git a/docs/api/advisor-api/overview.md b/docs/api/advisor-api/overview.md index 693563debd..7c957afb5e 100644 --- a/docs/api/advisor-api/overview.md +++ b/docs/api/advisor-api/overview.md @@ -6,8 +6,11 @@ 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 describes APIs to deal with 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). -- In [List of problems detected by Advisors](failed-checks) you can find API to get information about potential problems with your Infrastructure detected by Advisors. -- [Percona Advisors and Advisor checks](advisors-and-advisor-checks) lists all Advisors and Advisor Checks available in your PMM. -- [Changing Advisors and Advisor checks](changing-advisor-checks) will help you automate Advisor checks modification if needed. +- In [List of problems detected by Advisors](getfailedchecks) you can find API to get information about potential problems with your Infrastructure detected by Advisors. +- [List Percona Advisors](ref:listadvisors) lists all Advisors available in your PMM. +- [List Advisor Chekcs](ref:listadvisorchecks) lists all Advisor Checks available in your PMM. +- [Changing Advisor Checks](ref:changeadvisorchecks) will help you automate Advisor checks, i.e.: + - Enable/Disable Advisor Checks + - Change Advisor Check execution interval diff --git a/docs/api/pmm-server-config/overview.md b/docs/api/pmm-server-config/overview.md index 473c50fd26..961bfb16c5 100644 --- a/docs/api/pmm-server-config/overview.md +++ b/docs/api/pmm-server-config/overview.md @@ -13,4 +13,8 @@ This section will provide you with information on how to perform configuration a - [Get settings](ref:getsettings) - [Change settings](ref:changesettings) - PMM Server High Availability - - \ No newline at end of file + - [Check PMM Server Leadership](ref:leaderhealthcheck) +- PMM Server Upgrade + - [Check for upgrade](ref:checkupdates) + - [Start upgrade](ref:startupdate) + - [Check progress](ref:checkupdates) diff --git a/docs/api/pmm-server-config/troubleshooting/logs.md b/docs/api/pmm-server-config/troubleshooting/logs.md index a622063c4c..4672d28d6a 100644 --- a/docs/api/pmm-server-config/troubleshooting/logs.md +++ b/docs/api/pmm-server-config/troubleshooting/logs.md @@ -1,6 +1,6 @@ --- title: Logs -slug: "logs" +slug: pmm-server-logs categorySlug: pmm-server-maintenance parentDocSlug: pmm-server-troubleshooting --- From e362ac94955f699545ab3fdf1bd1ab8af8767d05 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Thu, 19 Sep 2024 13:08:36 +0000 Subject: [PATCH 03/16] PMM-12985 add --version flag to spec sync --- .github/workflows/doc.yml | 2 +- .github/workflows/main.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 9427c98ebc..564d04ffee 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -32,7 +32,7 @@ jobs: - name: Sync API spec uses: readmeio/rdme@v8 with: - rdme: openapi ./api/swagger/swagger.json --id=${{ env.ID }} --key=${{ secrets.README_TOKEN }} + rdme: openapi ./api/swagger/swagger.json --version=${{ env.VERSION }} --id=${{ env.ID }} --key=${{ secrets.README_TOKEN }} - name: Sync Markdown docs uses: readmeio/rdme@v8 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 09de98cf79..6dba48a8a2 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -96,7 +96,7 @@ jobs: fi # One may need to suppress passing to reviewdog because of https://github.com/reviewdog/reviewdog/issues/1696 - echo "$out" | bin/reviewdog -f=buf -reporter=github-pr-review -fail-on-error=true + echo "$out" | bin/reviewdog -f=buf -reporter=github-pr-review -fail-level=error - name: Run code linters uses: reviewdog/action-golangci-lint@v2 @@ -123,7 +123,7 @@ jobs: exit $exit_code fi - echo "$out" | bin/reviewdog -f=go-consistent -reporter=github-pr-review -fail-on-error=true + echo "$out" | bin/reviewdog -f=go-consistent -reporter=github-pr-review -fail-level=error - name: Test common API run: make test-common From 70e644bdb42254614f686175d2be5d79d78af3a1 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Fri, 20 Sep 2024 09:23:44 +0000 Subject: [PATCH 04/16] PMM-12985 change the slug name --- .../{bulk-add-users.md => create-user-accounts.md} | 11 +++++------ docs/api/pmm-server-config/overview.md | 1 + 2 files changed, 6 insertions(+), 6 deletions(-) rename docs/api/pmm-server-config/account-management/{bulk-add-users.md => create-user-accounts.md} (95%) diff --git a/docs/api/pmm-server-config/account-management/bulk-add-users.md b/docs/api/pmm-server-config/account-management/create-user-accounts.md similarity index 95% rename from docs/api/pmm-server-config/account-management/bulk-add-users.md rename to docs/api/pmm-server-config/account-management/create-user-accounts.md index 9abf6118ad..1eb51050cc 100644 --- a/docs/api/pmm-server-config/account-management/bulk-add-users.md +++ b/docs/api/pmm-server-config/account-management/create-user-accounts.md @@ -1,20 +1,20 @@ --- title: Create user accounts -slug: bulk-add-users +slug: create-user-accounts categorySlug: pmm-server-maintenance parentDocSlug: pmm-server-user-accounts order: 1 --- -## Create multiple user accounts +### Create multiple user accounts PMM Server will start up with a single user account, the administrator account. This account should not be for general use, because it allows complete control of -the server and access to all data that is accessible via the UI. +the server and access to all the data, including sensitive. Similar to the management of the [admin account](ref:change-admin-password), it is possible to manage other user accounts via the API. Waiting for readiness and -using `netrc` files with `cURL` are relevant for API usage in general and are +using `netrc` files with `curl` are relevant for API usage in general and are thus relevant here. ### Create a single user account @@ -26,7 +26,7 @@ follow. The following example will create a Grafana admin user that can make certain administrative changes to the system, but does not have full administrative access. -```sh +```shell $ cat </tmp/data.json { "name": "Grafana Admin", @@ -142,4 +142,3 @@ For simplicity, we will only be using Ansible for this example. - login: user2 role: Viewer ``` - diff --git a/docs/api/pmm-server-config/overview.md b/docs/api/pmm-server-config/overview.md index 961bfb16c5..3693680d54 100644 --- a/docs/api/pmm-server-config/overview.md +++ b/docs/api/pmm-server-config/overview.md @@ -18,3 +18,4 @@ This section will provide you with information on how to perform configuration a - [Check for upgrade](ref:checkupdates) - [Start upgrade](ref:startupdate) - [Check progress](ref:checkupdates) +- [PMM Server Logs](ref:logs) From 3e2bf0c70eb5b0e36e7e7024e1183fb793e5e1d0 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Fri, 20 Sep 2024 16:45:04 +0000 Subject: [PATCH 05/16] PMM-12985 migrate from IDs to slugs --- .../{access-control.md => overview.md} | 25 ++++----- .../advisors-and-advisor-checks.md | 2 +- .../advisor-api/changing-advisor-checks.md | 2 +- docs/api/advisor-api/failed-checks.md | 2 +- docs/api/advisor-api/overview.md | 4 +- docs/api/backups/list-locations.md | 13 +++-- docs/api/backups/overview.md | 10 ++-- docs/api/backups/restore-backup.md | 15 +++--- docs/api/backups/start-backup.md | 9 ++-- docs/api/inventory/add-agent.md | 22 ++++---- docs/api/inventory/add-node.md | 22 ++++---- docs/api/inventory/add-service.md | 23 ++++----- docs/api/inventory/change-agent.md | 48 ++++++++--------- docs/api/inventory/list-agents.md | 51 +++++++++++++++++++ docs/api/inventory/list-nodes.md | 24 ++++----- docs/api/inventory/list-services.md | 34 +++++-------- docs/api/inventory/overview.md | 31 +++++++++++ .../user-account-management.md | 2 +- docs/api/welcome/authentication.md | 24 ++++----- docs/api/welcome/introduction.md | 2 +- docs/api/welcome/monitoring.md | 2 +- 21 files changed, 214 insertions(+), 153 deletions(-) rename docs/api/access-control/{access-control.md => overview.md} (57%) create mode 100644 docs/api/inventory/list-agents.md create mode 100644 docs/api/inventory/overview.md diff --git a/docs/api/access-control/access-control.md b/docs/api/access-control/overview.md similarity index 57% rename from docs/api/access-control/access-control.md rename to docs/api/access-control/overview.md index c8ed0acd7a..6f701fc3df 100644 --- a/docs/api/access-control/access-control.md +++ b/docs/api/access-control/overview.md @@ -1,12 +1,13 @@ --- title: Overview -slug: access-control-overview -category: 66eaff8bc9d854001991ee4f +slug: access-control +categorySlug: access-control-api hidden: 0 --- Access Control in PMM can be used to restrict access to individual metrics. -Access Control is in **tech preview** and needs to be enabled manually from PMM settings before it can be used. + +Currently, Access Control is in **tech preview** and needs to be enabled manually from PMM settings before it can be used. Once enabled, restricting access to metrics can be performed by: @@ -16,10 +17,10 @@ Once enabled, restricting access to metrics can be performed by: ### Create a Percona role ```shell -curl -X POST "http://localhost/v1/role/Create" \ - -H "Authorization: Basic xxx" \ - -H "Content-Type: application/json" \ - -d '{ +curl -X POST -k "http://127.0.0.1/v1/accesscontrol/roles" \ + --header "Authorization: Basic XXXXX" \ + --header "Content-Type: application/json" \ + --data '{ "title": "My custom role", "filter": "{environment=\"staging\"}" }' @@ -30,14 +31,14 @@ Full access can be provided by specifying an empty `filter` field. ### Assign a Percona role -Users can be assigned roles by using the `/v1/role/Assign` API. +Users can be assigned roles by using the `/v1/accesscontrol/roles:assign` API. The endpoint assigns new roles to a user. Other roles, that may have been assigned to the user previously, stay intact. ```shell -curl -X POST "http://localhost/v1/role/Assign" \ - -H "Authorization: Basic xxx" \ - -H "Content-Type: application/json" \ - -d '{ +curl -X POST -k "http://127.0.0.1/v1/accesscontrol/roles:assign" \ + --header "Authorization: Basic XXXXX" \ + --header "Content-Type: application/json" \ + --data '{ "user_id": 1, "role_ids": [2, 3, 4] }' diff --git a/docs/api/advisor-api/advisors-and-advisor-checks.md b/docs/api/advisor-api/advisors-and-advisor-checks.md index 5ea97307fe..5d0e0c2240 100644 --- a/docs/api/advisor-api/advisors-and-advisor-checks.md +++ b/docs/api/advisor-api/advisors-and-advisor-checks.md @@ -1,7 +1,7 @@ --- title: Percona Advisors and Advisor checks slug: advisors-and-advisor-checks -category: 66eb0386f81fe000105dbea7 +categorySlug: advisor-api order: 1 hidden: 1 --- diff --git a/docs/api/advisor-api/changing-advisor-checks.md b/docs/api/advisor-api/changing-advisor-checks.md index 65d6376d5b..b3f50f2b84 100644 --- a/docs/api/advisor-api/changing-advisor-checks.md +++ b/docs/api/advisor-api/changing-advisor-checks.md @@ -1,7 +1,7 @@ --- title: Changing Advisors and Advisor checks slug: changing-advisor-checks -category: 66eb0386f81fe000105dbea7 +categorySlug: advisor-api order: 3 hidden: 1 --- diff --git a/docs/api/advisor-api/failed-checks.md b/docs/api/advisor-api/failed-checks.md index caef2fdce0..56f041d7e1 100644 --- a/docs/api/advisor-api/failed-checks.md +++ b/docs/api/advisor-api/failed-checks.md @@ -1,7 +1,7 @@ --- title: Get Failed Advisor Checks slug: failed-checks -category: 66eb0386f81fe000105dbea7 +categorySlug: advisor-api order: 2 hidden: 1 --- diff --git a/docs/api/advisor-api/overview.md b/docs/api/advisor-api/overview.md index 7c957afb5e..9e734aa855 100644 --- a/docs/api/advisor-api/overview.md +++ b/docs/api/advisor-api/overview.md @@ -1,7 +1,7 @@ --- title: Overview slug: pmm-advisors -category: 66eb0386f81fe000105dbea7 +categorySlug: advisor-api order: 0 --- @@ -10,7 +10,7 @@ This section describes APIs to deal with Percona [Advisors](https://docs.percona - In [List of problems detected by Advisors](getfailedchecks) you can find API to get information about potential problems with your Infrastructure detected by Advisors. - [List Percona Advisors](ref:listadvisors) lists all Advisors available in your PMM. -- [List Advisor Chekcs](ref:listadvisorchecks) lists all Advisor Checks available in your PMM. +- [List Advisor Checks](ref:listadvisorchecks) lists all Advisor Checks available in your PMM. - [Changing Advisor Checks](ref:changeadvisorchecks) will help you automate Advisor checks, i.e.: - Enable/Disable Advisor Checks - Change Advisor Check execution interval diff --git a/docs/api/backups/list-locations.md b/docs/api/backups/list-locations.md index 9bb6580dff..08a9c9bc72 100644 --- a/docs/api/backups/list-locations.md +++ b/docs/api/backups/list-locations.md @@ -2,19 +2,18 @@ title: List Locations slug: listlocations excerpt: ListLocations returns a list of all backup locations. -category: 66eb06589a42ac3f7ee6dee2 +categorySlug: backup-api --- 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 \ +curl --insecure -X GET \ + --header 'Authorization: Bearer XXXXX' \ + --header 'Accept: application/json' \ + --url https://127.0.0.1/v1/backups/locations ``` 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). +You require an authentication token, which is described [here](ref:authentication). diff --git a/docs/api/backups/overview.md b/docs/api/backups/overview.md index 6e952cc2e5..8869c84870 100644 --- a/docs/api/backups/overview.md +++ b/docs/api/backups/overview.md @@ -1,7 +1,7 @@ --- title: Overview slug: database-backups -category: 66eb06589a42ac3f7ee6dee2 +categorySlug: backup-api order: 0 --- @@ -16,9 +16,9 @@ To be able to make a backup, you should start by [preparing a backup location](h Here a few other references to : -- [Make a backup](startbackup) -- [Restore the database from a backup](restorebackup) -- [List restore history items](listrestorehistory) -- [List available backup locations](listlocations) +- [Make a backup](ref:startbackup) +- [Restore the database from a backup](ref:restorebackup) +- [List restore history items](ref:listrestores) +- [List available backup locations](ref:listlocations) Read [more](https://docs.percona.com/percona-monitoring-and-management/get-started/backup/index.html). diff --git a/docs/api/backups/restore-backup.md b/docs/api/backups/restore-backup.md index 91a578f67d..8ceeaba337 100644 --- a/docs/api/backups/restore-backup.md +++ b/docs/api/backups/restore-backup.md @@ -2,23 +2,22 @@ title: Restore from a backup slug: restorebackup excerpt: This endpoint allows to restore a database from a previously made backup. -category: 66eb06589a42ac3f7ee6dee2 +categorySlug: backup-api --- -PMM can backup the monitored services. +PMM can restore a service (database) from a backup. -This section describes making ad-hoc backups from a service. +This section describes restoring a service from a backup taken before. ### 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' \ +curl --insecure -X POST \ + --header 'Authorization: Bearer XXXXX' \ --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/backups/restores:start \ --data ' { "service_id": "40499c38-522d-4ed1-ab3f-8a099684f46d", @@ -32,7 +31,7 @@ You require an authentication token, which is described [here](ref:authenticatio 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. +You can define a `name` and a `description` for each backup. You can also configure `retry_interval` and the number of `retries` if required. ### Error messages diff --git a/docs/api/backups/start-backup.md b/docs/api/backups/start-backup.md index 3672d0af16..965483a7eb 100644 --- a/docs/api/backups/start-backup.md +++ b/docs/api/backups/start-backup.md @@ -2,7 +2,7 @@ title: Make a backup slug: startbackup excerpt: This endpoint allows to make an unscheduled, or ad-hoc, backup of a given service. -category: 66eb06589a42ac3f7ee6dee2 +categorySlug: backup-api --- PMM can backup the monitored services. @@ -14,11 +14,10 @@ This section describes how to make an ad-hoc backup of a service. 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' \ +curl --insecure -X POST \ + --header 'Authorization: Bearer XXXXX' \ --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/backups:start \ --data ' { "service_id": "2c756c17-e4cd-4180-a3d4-d7a3fe1e4816", diff --git a/docs/api/inventory/add-agent.md b/docs/api/inventory/add-agent.md index ec576663ba..aeb605d81a 100644 --- a/docs/api/inventory/add-agent.md +++ b/docs/api/inventory/add-agent.md @@ -1,7 +1,7 @@ --- title: Add an Agent slug: addagent -category: 66eb0600d159ac004f5fe06d +categorySlug: inventory-api --- ## Add an Agent @@ -18,11 +18,10 @@ Here's how to add an Agent of type `mysql` using the old and new API calls. ```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/inventory/Agents/MySQLdExporter \ - --data ' + --header 'Authorization: Bearer XXXXX' \ + --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/inventory/Agents/MySQLdExporter \ + --data ' { "pmm_agent_id": "pmm-server", "service_id": "13519ec9-eedc-4d21-868c-582e146e1d0e", @@ -43,11 +42,10 @@ curl --insecure -X POST \ ```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/inventory/Agents/Add \ - --data ' + --header 'Authorization: Bearer XXXXX' \ + --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/inventory/agents \ + --data ' { "mysqld_exporter": { "pmm_agent_id": "pmm-server", @@ -83,4 +81,4 @@ You can choose from the following Agent types: - qan_postgresql_pgstatements_agent - qan_postgresql_pgstatmonitor_agent -To get the authentication token, check [the Authentication page](ref:authentication). \ No newline at end of file +To get the authentication token, check [Authentication](ref:authentication). diff --git a/docs/api/inventory/add-node.md b/docs/api/inventory/add-node.md index a12a73e06a..28ac93e801 100644 --- a/docs/api/inventory/add-node.md +++ b/docs/api/inventory/add-node.md @@ -1,7 +1,7 @@ --- title: Add a Node slug: addnode -category: 66eb0600d159ac004f5fe06d +categorySlug: inventory-api --- ## Add a Node @@ -18,11 +18,10 @@ Here's how to add a Node of type `generic` using the old and new API calls. ```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/inventory/Nodes/AddGeneric \ - --data ' + --header 'Authorization: Bearer XXXXX' \ + --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/inventory/Nodes/AddGeneric \ + --data ' { "node_name": "mysql-sales-db-prod-1", "region": "us-east-1", @@ -40,11 +39,10 @@ curl --insecure -X POST \ ```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/inventory/Nodes/Add \ - --data ' + --header 'Authorization: Bearer XXXXX' \ + --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/inventory/nodes \ + --data ' { "generic": { "node_name": "mysql-sales-db-prod-1", @@ -68,4 +66,4 @@ You can choose from the following Node types: - remote_rds - remote_azure -To get the authentication token, check [the Authentication page](ref:authentication). +To get the authentication token, check [Authentication](ref:authentication). diff --git a/docs/api/inventory/add-service.md b/docs/api/inventory/add-service.md index fe2fae348e..17abef1ef0 100644 --- a/docs/api/inventory/add-service.md +++ b/docs/api/inventory/add-service.md @@ -1,7 +1,7 @@ --- title: Add a Service slug: addservice -category: 66eb0600d159ac004f5fe06d +categorySlug: inventory-api --- ## Add a Service @@ -18,11 +18,11 @@ Here's how to add a Node of type `mysql` using the old and the new API calls: ```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/inventory/Services/AddMySQL \ - --data ' + --header 'Authorization: Bearer XXXXX' \ + --header 'Accept: application/json' \ + --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/inventory/Services/AddMySQL \ + --data ' { "service_name": "mysql-sales-db-prod-1", "node_id": "pmm-server", @@ -42,11 +42,10 @@ curl --insecure -X POST \ ```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/inventory/Services/Add \ - --data ' + --header 'Authorization: Bearer XXXXX' \ + --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/inventory/services \ + --data ' { "mysql": { "service_name": "mysql-sales-db-prod-1", @@ -73,4 +72,4 @@ You can choose from the following Service types: - haproxy - external -To get the authentication token, check [the Authentication page](ref:authentication). +To get the authentication token, check [Authentication](ref:authentication). diff --git a/docs/api/inventory/change-agent.md b/docs/api/inventory/change-agent.md index 1027cd62e7..30fe571cae 100644 --- a/docs/api/inventory/change-agent.md +++ b/docs/api/inventory/change-agent.md @@ -1,32 +1,32 @@ --- title: Change Agent Attributes slug: changeagent -category: 66eb0600d159ac004f5fe06d +categorySlug: inventory-api --- ## Change Agent Attributes This section describes how to change Agent attributes. -!!! note alert alert-primary "Note" - Not all attrbutes can be chaged. For example, you cannot change the Agent type nor its ID. +> 📘 Info +> +> Not all attrbutes can be chaged. For example, you cannot change the Agent type nor its ID. In PMM versions prior to 3.0.0, we featured a separate API call for each Agent type. Starting with PMM 3.0.0, we have streamlined the process by offering a single API endpoint for all Agent types. Previously, the Agent type was defined by the endpoint, i.e. `/v1/inventory/Agents/ChangeMySQLdExporter`. In the new approach, the Agent type must be specified as the top-level property of the request payload. -As part of the single API endpoint updated, we have deprecating individual API endpoints for each Agent type. +As part of the single API endpoint update, we have deprecated individual API endpoints for each Agent type. -Here's how to change Agent attributes using the old and new API calls. The goal of this sample API call is to enable the Agent, make it work in Push mode, and remove a few custom labels from it. +Here's how to change Agent attributes using the old and new API calls. The goal of this sample API call is to enable the Agent, make it work in Push mode, and assign a few custom labels to it. **Old API call** ```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/inventory/Agents/ChangeMySQLdExporter \ - --data ' + --header 'Authorization: Bearer XXXXX' \ + --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/inventory/Agents/ChangeMySQLdExporter \ + --data ' { "agent_id": "13519ec9-eedc-4d21-868c-582e146e1d0e", "common": { @@ -35,7 +35,6 @@ curl --insecure -X POST \ "department": "sales", "replication_set": "db-sales-prod-1-rs1", }, - remove_custom_labels: true, enable_push_metrics: true, } } @@ -45,27 +44,22 @@ curl --insecure -X POST \ **New API call** ```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/inventory/Agents/Add \ - --data ' +curl --insecure -X PUT \ + --header 'Authorization: Bearer XXXXX' \ + --header 'Content-Type: application/json' \ + --url https://127.0.0.1/v1/inventory/agents/13519ec9-eedc-4d21-868c-582e146e1d0e \ + --data ' { "mysqld_exporter": { - "agent_id": "13519ec9-eedc-4d21-868c-582e146e1d0e", - "common": { - "enable": true, - "custom_labels": { - "department": "sales", - "replication_set": "db-sales-prod-1-rs1", - }, - remove_custom_labels: true, - enable_push_metrics: true, + "enable": true, + "enable_push_metrics": true, + "custom_labels": { + "department": "sales", + "replication_set": "db-sales-prod-1-rs1" } } } ' ``` -To get the authentication token, check [the Authentication page](ref:authentication). +To get the authentication token, check [Authentication](ref:authentication). diff --git a/docs/api/inventory/list-agents.md b/docs/api/inventory/list-agents.md new file mode 100644 index 0000000000..5519a4d851 --- /dev/null +++ b/docs/api/inventory/list-agents.md @@ -0,0 +1,51 @@ +--- +title: List Agents +slug: listagents +categorySlug: inventory-api +--- + +### Get all agents running on a specific node + +```shell +curl --insecure -X GET \ + --header 'Authorization: Bearer XXXXX' \ + --header 'Accept: application/json' \ + --url https://127.0.0.1/v1/inventory/agents?node_id=7d07a712-7fb9-4265-8a7d-a0db8aa35762 +``` + +### Get all agents providing insights to a specific service + +```shell +curl --insecure -X GET \ + --header 'Authorization: Bearer XXXXX' \ + --header 'Accept: application/json' \ + --url https://127.0.0.1/v1/inventory/agents?service_id=6ed34dba-1f4a-4cb7-b02f-49aac5c46004 +``` + +### Get all agents of a specific type + +```shell +curl --insecure -X GET \ + --header 'Authorization: Bearer XXXXX' \ + --header 'Accept: application/json' \ + --url https://127.0.0.1/v1/inventory/agents?agent_type=AGENT_TYPE_MYSQLD_EXPORTER +``` + +### Get all agents started by a specific PMM Agent + +```shell +curl --insecure -X GET \ + --header 'Authorization: Bearer XXXXX' \ + --header 'Accept: application/json' \ + --url https://127.0.0.1/v1/inventory/agents?pmm_agent_id=a05941d3-90cb-49e1-ba85-f765de408fee +``` + +To get the authentication token, check [Authentication](ref:authentication). + +If you need to know the `node_id`, refer to [List Nodes endpoint](ref:listnodes). + +For the `agent_type` parameter, you can check the options provided by the respective query param further down this page. + +> 🚧 Important +> +> Exactly one of the following parameters is required for the endpoint to succeed: `pmm_agent_id`, `node_id`, or `service_id`. diff --git a/docs/api/inventory/list-nodes.md b/docs/api/inventory/list-nodes.md index 8d13f2fc44..56865a3490 100644 --- a/docs/api/inventory/list-nodes.md +++ b/docs/api/inventory/list-nodes.md @@ -1,7 +1,7 @@ --- title: List Nodes slug: listnodes -category: 66eb0600d159ac004f5fe06d +categorySlug: inventory-api --- ## List Nodes @@ -12,19 +12,17 @@ Example: ```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/inventory/Nodes/List \ - --data '{"node_type": "GENERIC_NODE"}' + --header 'Authorization: Bearer XXXXX' \ + --header 'Accept: application/json' \ + --url https://127.0.0.1/v1/inventory/nodes?node_type=NODE_TYPE_GENERIC_NODE ``` -First, get the [authentication token](ref:authentication). +To get the authentication token, check [Authentication](ref:authentication). -Then, choose from the following Node types: +Then, choose one of the following Node types: -- GENERIC_NODE -- CONTAINER_NODE -- REMOTE_NODE -- REMOTE_RDS_NODE -- REMOTE_AZURE_DATABASE_NODE` +- NODE_TYPE_GENERIC_NODE +- NODE_TYPE_CONTAINER_NODE +- NODE_TYPE_REMOTE_NODE +- NODE_TYPE_REMOTE_RDS_NODE +- NODE_TYPE_REMOTE_AZURE_DATABASE_NODE` diff --git a/docs/api/inventory/list-services.md b/docs/api/inventory/list-services.md index 2824bce23c..e2ccf3054a 100644 --- a/docs/api/inventory/list-services.md +++ b/docs/api/inventory/list-services.md @@ -1,7 +1,7 @@ --- title: List Services slug: listservices -category: 66eb0600d159ac004f5fe06d +categorySlug: inventory-api --- ## List Services @@ -9,31 +9,25 @@ category: 66eb0600d159ac004f5fe06d The following API call lists the available services on a Node: ```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/inventory/Services/List \ - --data ' -{ - "node_id": "7d07a712-7fb9-4265-8a7d-a0db8aa35762", - "service_type": "MYSQL_SERVICE" -}' +curl --insecure -X GET \ + --header 'Authorization: Bearer XXXXX' \ + --header 'Accept: application/json' \ + --url https://127.0.0.1/v1/inventory/services?node_id=7d07a712-7fb9-4265-8a7d-a0db8aa35762&service_type=SERVICE_TYPE_MYSQL_SERVICE ``` -First, get the [authentication token](ref:authentication). +To get the authentication token, check [Authentication](ref:authentication). -Then, you need to know the [node_id](ref:listnodes). +If you need to know the `node_id`, refer to [List Nodes endpoint](ref:listnodes). Choose the `service_type` that you want to list. The options are: -- MYSQL_SERVICE -- MONGODB_SERVICE -- POSTGRESQL_SERVICE -- PROXYSQL_SERVICE -- HAPROXY_SERVICE -- EXTERNAL_SERVICE +- SERVICE_TYPE_MYSQL_SERVICE +- SERVICE_TYPE_MONGODB_SERVICE +- SERVICE_TYPE_POSTGRESQL_SERVICE +- SERVICE_TYPE_PROXYSQL_SERVICE +- SERVICE_TYPE_HAPROXY_SERVICE +- SERVICE_TYPE_EXTERNAL_SERVICE If you prefer to get all services running on the node, you can omit the `service_type` parameter. -Otherwise, calling the same endpoint with no parameters will return all services known to this PMM instance. +Otherwise, calling the same endpoint with no parameters will return all services known to this node. diff --git a/docs/api/inventory/overview.md b/docs/api/inventory/overview.md new file mode 100644 index 0000000000..aa8c6b753d --- /dev/null +++ b/docs/api/inventory/overview.md @@ -0,0 +1,31 @@ +--- +title: Overview +slug: pmm-inventory +categorySlug: inventory-api +hidden: 0 +order: 0 +--- + +This section will provide you with information on how to add, update or remove services, nodes and agents. + + +### Adding services, nodes and agents: + +- [Add a service](ref:addservice) +- [Add a node](ref:addnode) +- [Add an agent](ref:addagent) + +### Listing services, nodes and agents: +- [List services](ref:listservices) +- [List nodes](ref:listnodes) +- [List agents](ref:listagents) + +### Removing services, nodes and agents: +- [Remove a service](ref:removeservice) +- [Remove a node](ref:removenode) +- [Remove an agent](ref:removeagent) + +### Updating services, nodes and agents: +- [Update a service](ref:changeservice) +- Update a node ℹ️ This won't be implemented; you can only remove a node and then add it back with new attributes. +- [Update an agent](ref:changeagent) diff --git a/docs/api/pmm-server-config/user-account-management.md b/docs/api/pmm-server-config/user-account-management.md index 579ba76623..b2ddbab7de 100644 --- a/docs/api/pmm-server-config/user-account-management.md +++ b/docs/api/pmm-server-config/user-account-management.md @@ -8,4 +8,4 @@ order: 1 The pages below explain more in detail how to perform user account management. - [Change admin password](ref:change-admin-password) -- [Bulk user account creation](ref:bulk-add-users) +- [Create user accounts](ref:create-user-accounts) diff --git a/docs/api/welcome/authentication.md b/docs/api/welcome/authentication.md index a6c737023b..987c594389 100644 --- a/docs/api/welcome/authentication.md +++ b/docs/api/welcome/authentication.md @@ -1,7 +1,7 @@ --- title: Authentication slug: authentication -category: 66aca6ddfd9bfe004c97cd48 +parentSlug: welcome order: 1 --- @@ -25,14 +25,14 @@ echo -n admin:admin | base64 Let's assume the username is `admin` and the password is also `admin`. Then the API call to get the PMM Server version info would be as follows: ```shell -curl -X GET -H 'Authorization: Basic YWRtaW46YWRtaW4=' \ - -H 'Content-Type: application/json' https://127.0.0.1/v1/version +curl -X GET --header 'Authorization: Bearer XXXXX' \ + --header 'Content-Type: application/json' https://127.0.0.1/v1/version ``` If you use `curl` to make API calls, a simple equivalent to the command above is: ```shell -curl -X GET -u admin:admin -H 'Content-Type: application/json' https://127.0.0.1/v1/version +curl -X GET -u admin:admin --header 'Content-Type: application/json' https://127.0.0.1/v1/version ``` ### Bearer Authentication @@ -41,28 +41,28 @@ Bearer authentication (also called token authentication) is an HTTP authenticati Service Token example: ```shell -curl -X GET -H 'Authorization: Bearer glsa_Fp0ggev31R58ueNJbJgYw7fIGfO3yKWH_746383ab' \ - -H 'Content-Type: application/json' https://127.0.0.1/v1/version +curl -X GET --header 'Authorization: Bearer glsa_Fp0ggev31R58ueNJbJgYw7fIGfO3yKWH_746383ab' \ + --header 'Content-Type: application/json' https://127.0.0.1/v1/version ``` You can use the Service Token in basic authentication as well: ```shell -curl -X GET -H 'Content-Type: application/json' \ +curl -X GET --header 'Content-Type: application/json' \ https://service_token:glsa_Fp0ggev31R58ueNJbJgYw7fIGfO3yKWH_746383ab@127.0.0.1/v1/version ``` Service Token usually has "glsa_" prefix. If you convert it from API key, it will not change. If you use API key, then it will be automatically converted into Service Account and Service Token. API key example: ```shell -curl -X GET -H 'Authorization: Bearer eyJrIjoiUXRkeDNMS1g1bFVyY0tUj1o0SmhBc3g4QUdTRVAwekoiLCJuIjoicG1tLXRlc3QiLCJpZCI6MX0=' \ - -H 'Content-Type: application/json' https://127.0.0.1/v1/version +curl -X GET --header 'Authorization: Bearer eyJrIjoiUXRkeDNMS1g1bFVyY0tUj1o0SmhBc3g4QUdTRVAwekoiLCJuIjoicG1tLXRlc3QiLCJpZCI6MX0=' \ + --header 'Content-Type: application/json' https://127.0.0.1/v1/version ``` You can use the API key in basic authentication as well: ```shell -curl -X GET -H 'Content-Type: application/json' \ +curl -X GET --header 'Content-Type: application/json' \ https://api_key:eyJrIjoiUXRkeDNMS1g1bFVyY0tUj1o0SmhBc3g4QUdTRVAwekoiLCJuIjoicG1tLXRlc3QiLCJpZCI6MX0=@127.0.0.1/v1/version ``` @@ -99,13 +99,13 @@ password admin This can then be used as follows: ```shell -curl --netrc -X GET -H 'Content-Type: application/json' https://127.0.0.1/v1/version +curl --netrc -X GET --header 'Content-Type: application/json' https://127.0.0.1/v1/version ``` Should you wish to use a different file then the `--netrc-file` option needs to be used. If we have the credentials stored in `~/.netrc-pmm` then the command would become: ```shell -curl --netrc --netrc-file ~/.netrc-pmm -X GET -H 'Content-Type: application/json' https://127.0.0.1/v1/version +curl --netrc --netrc-file ~/.netrc-pmm -X GET --header 'Content-Type: application/json' https://127.0.0.1/v1/version ``` You can use API keys in this way too, for example: diff --git a/docs/api/welcome/introduction.md b/docs/api/welcome/introduction.md index fffbc9a29c..5aab0ddfd9 100644 --- a/docs/api/welcome/introduction.md +++ b/docs/api/welcome/introduction.md @@ -1,7 +1,7 @@ --- title: Introduction slug: introduction -category: 66aca6ddfd9bfe004c97cd48 +parentSlug: welcome order: 0 --- diff --git a/docs/api/welcome/monitoring.md b/docs/api/welcome/monitoring.md index 5ca61a84b9..3d107ef175 100644 --- a/docs/api/welcome/monitoring.md +++ b/docs/api/welcome/monitoring.md @@ -1,7 +1,7 @@ --- title: Monitoring slug: monitoring -category: 66aca6ddfd9bfe004c97cd48 +parentSlug: welcome order: 2 --- From b0a1da4af9f128f7ef0082c31c564cea9e2e55d1 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 21 Sep 2024 08:01:29 +0000 Subject: [PATCH 06/16] PMM-12985 update the intro with links --- docs/api/welcome/introduction.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/welcome/introduction.md b/docs/api/welcome/introduction.md index 5aab0ddfd9..d8ce4e41f6 100644 --- a/docs/api/welcome/introduction.md +++ b/docs/api/welcome/introduction.md @@ -11,10 +11,10 @@ This guide is designed to enable both those starting off and those who have alre To give you an idea of what you can do with PMM api, you can: -- add database instances to monitoring, be it MySQL, PostgreSQL, or MongoDB -- check the availability of PMM updates -- update PMM and check if PMM is successfully updated or not -- change the configuration of PMM server -- analyze query performance issues with Query Analytics -- kick off a backup prior to a significant change -- download PMM Server logs to troubleshoot an issue +- [add database instances](ref:addservice) to monitoring, be it MySQL, PostgreSQL, or MongoDB +- [check](ref:checkupdates) the availability of PMM updates +- [update](ref:startupdate) PMM and [check](ref:updatestatus) the status of the update +- [change](ref:changesettings) the configuration of PMM server +- [analyze](ref:getreport) query performance issues with Query Analytics +- [kick off](ref:startbackup) a backup prior to a significant change +- [download](ref:logs) PMM Server logs to troubleshoot an issue From 2b28896adcb7eabf06686d87441b583e64e851d7 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Mon, 23 Sep 2024 09:31:42 +0000 Subject: [PATCH 07/16] PMM-12985 update inventory overview --- docs/api/inventory/overview.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/api/inventory/overview.md b/docs/api/inventory/overview.md index aa8c6b753d..fdc323086d 100644 --- a/docs/api/inventory/overview.md +++ b/docs/api/inventory/overview.md @@ -25,7 +25,10 @@ This section will provide you with information on how to add, update or remove s - [Remove a node](ref:removenode) - [Remove an agent](ref:removeagent) -### Updating services, nodes and agents: +### Updating services and agents: - [Update a service](ref:changeservice) -- Update a node ℹ️ This won't be implemented; you can only remove a node and then add it back with new attributes. - [Update an agent](ref:changeagent) + +> ℹ️ Note +> +> Updating a node won't be implemented. You can only remove a node and then add it back with new attributes. From dc8d0ab75a42abbaefe7c19e3dab48c502ead063 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:41:32 +0300 Subject: [PATCH 08/16] Update docs/api/inventory/overview.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/api/inventory/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/inventory/overview.md b/docs/api/inventory/overview.md index fdc323086d..03df275b0b 100644 --- a/docs/api/inventory/overview.md +++ b/docs/api/inventory/overview.md @@ -25,7 +25,7 @@ This section will provide you with information on how to add, update or remove s - [Remove a node](ref:removenode) - [Remove an agent](ref:removeagent) -### Updating services and agents: +### Updating services and agents - [Update a service](ref:changeservice) - [Update an agent](ref:changeagent) From 243c61f85b22d816683fd908ba7041c371ebf1fc Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:42:07 +0300 Subject: [PATCH 09/16] Update docs/api/inventory/overview.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/api/inventory/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/inventory/overview.md b/docs/api/inventory/overview.md index 03df275b0b..28e06f7ac7 100644 --- a/docs/api/inventory/overview.md +++ b/docs/api/inventory/overview.md @@ -31,4 +31,4 @@ This section will provide you with information on how to add, update or remove s > ℹ️ Note > -> Updating a node won't be implemented. You can only remove a node and then add it back with new attributes. +> Node updates are not supported. To modify a node's attributes, remove the existing node and add a new one with the new attributes. From e83b95f0f17f7a58102fb87b017ee1d5ed8d7333 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:42:44 +0300 Subject: [PATCH 10/16] Update api/server/v1/server.proto Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- api/server/v1/server.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/server/v1/server.proto b/api/server/v1/server.proto index 5ab07b3ff0..67882f91c3 100644 --- a/api/server/v1/server.proto +++ b/api/server/v1/server.proto @@ -255,7 +255,7 @@ service ServerService { option (google.api.http) = {get: "/v1/server/updates/changelogs"}; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { summary: "Get the changelog" - description: "List all the changes between the installed version and the latest available version." + description: "Display a changelog comparing the installed version to the latest available version." }; } // StartUpdate starts PMM Server update. From 5436f6bc13a2bf9e7e58c8430316d86fc06a144b Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:42:52 +0300 Subject: [PATCH 11/16] Update docs/api/access-control/overview.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/api/access-control/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/access-control/overview.md b/docs/api/access-control/overview.md index 6f701fc3df..ab01d8f341 100644 --- a/docs/api/access-control/overview.md +++ b/docs/api/access-control/overview.md @@ -7,7 +7,7 @@ hidden: 0 Access Control in PMM can be used to restrict access to individual metrics. -Currently, Access Control is in **tech preview** and needs to be enabled manually from PMM settings before it can be used. +Access Control is currently in Technical Preview. To use this feature, enable it manually in PMM's settings. Once enabled, restricting access to metrics can be performed by: From 9721f68532277ec690f42cf2f5124fc34aaf2ca0 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:43:05 +0300 Subject: [PATCH 12/16] Update docs/api/advisor-api/advisors-and-advisor-checks.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/api/advisor-api/advisors-and-advisor-checks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/advisor-api/advisors-and-advisor-checks.md b/docs/api/advisor-api/advisors-and-advisor-checks.md index 5d0e0c2240..13db70c147 100644 --- a/docs/api/advisor-api/advisors-and-advisor-checks.md +++ b/docs/api/advisor-api/advisors-and-advisor-checks.md @@ -1,5 +1,5 @@ --- -title: Percona Advisors and Advisor checks +title: Percona Advisors and Advisor Checks slug: advisors-and-advisor-checks categorySlug: advisor-api order: 1 From 53716aac0b4df4a3ef73b7d3f7644f6858cbb23b Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:43:47 +0300 Subject: [PATCH 13/16] Update docs/api/advisor-api/overview.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/api/advisor-api/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/advisor-api/overview.md b/docs/api/advisor-api/overview.md index 9e734aa855..88565b7640 100644 --- a/docs/api/advisor-api/overview.md +++ b/docs/api/advisor-api/overview.md @@ -9,7 +9,7 @@ order: 0 This section describes APIs to deal with 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). - In [List of problems detected by Advisors](getfailedchecks) you can find API to get information about potential problems with your Infrastructure detected by Advisors. -- [List Percona Advisors](ref:listadvisors) lists all Advisors available in your PMM. +- [List Percona Advisors](ref:listadvisors) lists all Advisors available for your PMM instance. - [List Advisor Checks](ref:listadvisorchecks) lists all Advisor Checks available in your PMM. - [Changing Advisor Checks](ref:changeadvisorchecks) will help you automate Advisor checks, i.e.: - Enable/Disable Advisor Checks From 4adad23376419e4838b61d9dcf40d774606472f0 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:43:57 +0300 Subject: [PATCH 14/16] Update docs/api/advisor-api/overview.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/api/advisor-api/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/advisor-api/overview.md b/docs/api/advisor-api/overview.md index 88565b7640..f3e3ea2599 100644 --- a/docs/api/advisor-api/overview.md +++ b/docs/api/advisor-api/overview.md @@ -11,6 +11,6 @@ This section describes APIs to deal with Percona [Advisors](https://docs.percona - In [List of problems detected by Advisors](getfailedchecks) you can find API to get information about potential problems with your Infrastructure detected by Advisors. - [List Percona Advisors](ref:listadvisors) lists all Advisors available for your PMM instance. - [List Advisor Checks](ref:listadvisorchecks) lists all Advisor Checks available in your PMM. -- [Changing Advisor Checks](ref:changeadvisorchecks) will help you automate Advisor checks, i.e.: +- [Changing Advisor Checks](ref:changeadvisorchecks) will help you automate Advisor Checks, i.e.: - Enable/Disable Advisor Checks - Change Advisor Check execution interval From 854e8f3f452db8f144d40eff62ad0c2133636c29 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:44:03 +0300 Subject: [PATCH 15/16] Update docs/api/inventory/overview.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/api/inventory/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/inventory/overview.md b/docs/api/inventory/overview.md index 28e06f7ac7..1f22f16e8f 100644 --- a/docs/api/inventory/overview.md +++ b/docs/api/inventory/overview.md @@ -6,7 +6,7 @@ hidden: 0 order: 0 --- -This section will provide you with information on how to add, update or remove services, nodes and agents. +This section guides you on how to add, update, or remove services, nodes, and agents. ### Adding services, nodes and agents: From cdfc0c1f54921f336b25213cb09d15896ee879e8 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Tue, 8 Oct 2024 13:44:28 +0300 Subject: [PATCH 16/16] Update docs/api/advisor-api/overview.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/api/advisor-api/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/advisor-api/overview.md b/docs/api/advisor-api/overview.md index f3e3ea2599..69724cb9bd 100644 --- a/docs/api/advisor-api/overview.md +++ b/docs/api/advisor-api/overview.md @@ -8,7 +8,7 @@ order: 0 This section describes APIs to deal with 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). -- In [List of problems detected by Advisors](getfailedchecks) you can find API to get information about potential problems with your Infrastructure detected by Advisors. +- The [List of Problems Detected by Advisors](getfailedchecks) API endpoint offers detailed insights into potential infrastructure issues identified by Advisors. - [List Percona Advisors](ref:listadvisors) lists all Advisors available for your PMM instance. - [List Advisor Checks](ref:listadvisorchecks) lists all Advisor Checks available in your PMM. - [Changing Advisor Checks](ref:changeadvisorchecks) will help you automate Advisor Checks, i.e.: