PMM-12913 migrate /v1/version

percona · Mar 11, 2024 · 581e273 · 581e273
1 parent dd00b48
commit 581e273
Show file tree

Hide file tree

Showing 12 changed files with 518 additions and 510 deletions.
diff --git a/api/MIGRATION_TO_V3.md b/api/MIGRATION_TO_V3.md
@@ -4,11 +4,11 @@
 | ----------------------------------------------- | -------------------------------------------- | ------------------------------- |
 
 **ServerService**                                   **ServerService**
-GET /logz.zip                                       GET /api/server/v1/logs.zip                    redirect to /logs.zip in swagger                                             
-GET /v1/version                                     GET /api/server/v1/version                     redirect to /v1/version in swagger
-POST /v1/readyz                                     GET /api/server/v1/readyz                                                           
-POST /v1/AWSInstanceCheck                           GET /api/server/v1/AWSInstance                                                      
-POST /v1/leaderHealthCheck                          GET /api/server/v1/leaderHealthCheck                                                
+GET /logz.zip                                       GET /api/server/v1/logs.zip                    redirect to /logs.zip in swagger
+GET /v1/version                                     GET /api/server/v1/version                     redirect to /v1/version in swagger ✅
+POST /v1/readyz                                     GET /api/server/v1/readyz   
+POST /v1/AWSInstanceCheck                           GET /api/server/v1/AWSInstance
+POST /v1/leaderHealthCheck                          GET /api/server/v1/leaderHealthCheck
 POST /v1/settings/Change                            PUT /api/server/v1/settings
 POST /v1/settings/Get                               GET /api/server/v1/settings
 POST /v1/updates/Check                              GET /api/server/v1/updates

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
diff --git a/api/server/v1/json/client/server_service/version_responses.go b/api/server/v1/json/client/server_service/version_responses.go
diff --git a/api/server/v1/json/v1.json b/api/server/v1/json/v1.json
diff --git a/api/server/v1/server.pb.go b/api/server/v1/server.pb.go
diff --git a/api/server/v1/server.pb.gw.go b/api/server/v1/server.pb.gw.go
diff --git a/api/server/v1/server.proto b/api/server/v1/server.proto
@@ -202,7 +202,7 @@ message AWSInstanceCheckResponse {}
 service ServerService {
   // Version returns PMM Server versions.
   rpc Version(VersionRequest) returns (VersionResponse) {
-    option (google.api.http) = {get: "/v1/version"};
+    option (google.api.http) = {get: "/api/server/v1/version"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       summary: "Version"
       description: "Returns PMM Server versions."

diff --git a/api/swagger/swagger-dev.json b/api/swagger/swagger-dev.json
diff --git a/api/swagger/swagger.json b/api/swagger/swagger.json
diff --git a/build/ansible/roles/nginx/files/conf.d/pmm.conf b/build/ansible/roles/nginx/files/conf.d/pmm.conf
@@ -210,6 +210,11 @@
       proxy_http_version 1.1;
       proxy_set_header Connection "";
     }
+    location /api/ {
+      proxy_pass http://managed-json/api/;
+      proxy_http_version 1.1;
+      proxy_set_header Connection "";
+    }
 
     # qan-api gRPC APIs should not be exposed
 
@@ -220,8 +225,10 @@
       proxy_set_header Connection "";
     }
 
-    # for minimal compatibility with PMM 1.x
-    rewrite ^/ping$ /v1/readyz;
+    # minimal compatibility with PMM 1.x
+    rewrite ^/ping$ /api/server/v1/version;
+    # compatibility with PMM 2.x
+    rewrite ^/v1/readyz$ /api/server/v1/version;
 
     # logs.zip in both PMM 1.x and 2.x variants
     location /logs.zip {

diff --git a/managed/services/grafana/auth_server.go b/managed/services/grafana/auth_server.go
@@ -81,7 +81,7 @@ var rules = map[string]role{
 	"/ping":                 none, // PMM 1.x variant
 
 	// must not be available without authentication as it can leak data
-	"/v1/version": viewer,
+	"/api/server/v1/version": viewer,
 
 	"/v1/qan/": viewer,
 

diff --git a/managed/services/grafana/auth_server_test.go b/managed/services/grafana/auth_server_test.go
@@ -229,7 +229,7 @@ func TestAuthServerAuthenticate(t *testing.T) {
 		"/v1/readyz": none,
 		"/ping":      none,
 
-		"/v1/version": viewer,
+		"/api/server/v1/version": viewer,
 
 		"/v1/qan/ObjectDetails/GetQueryExample": viewer,