Merge branch 'master' into dle-4-0

Author: agneum

README.md

@@ -60,9 +60,11 @@ For example, cloning a 1 TiB PostgreSQL database takes just about 10 seconds. On
 <p><img src="./assets/dle-demo-animated.gif" border="0" /></p>
 
 Try it yourself right now:
-- enter [the Database Lab Platform](https://console.postgres.ai/), join the "Demo" organization, and test cloning of ~1 TiB demo database, or
-- check out another demo setup (DBLab 3.4): https://demo.aws.postgres.ai:446/instance, use the token `demo_token` to enter
-- if you are looking for DBLab 4.0, with branching and snapshotting support in API/CLI/UI, check out this demo instance: https://branching.aws.postgres.ai:446/instance, use the token `demo_token` to enter
+- Visit [Postgres.ai Console](https://console.postgres.ai/), set up your first organization and provision a DBLab Standard Edition (DBLab SE) to any cloud or on-prem
+    - [Pricing](https://postgres.ai/pricing) (starting at $62/month)
+    - [Doc: How to install DBLab SE](https://postgres.ai/docs/how-to-guides/administration/install-dle-from-postgres-ai)
+- Demo: https://demo.aws.postgres.ai (use the token `demo-token` to access)
+- if you are looking for DBLab 4.0, with branching and snapshotting support in API/CLI/UI, check out this demo instance: https://branching.aws.postgres.ai:446/instance, use the token `demo-token` to enter
 
 ## How it works
 Thin cloning is fast because it uses [Copy-on-Write (CoW)](https://en.wikipedia.org/wiki/Copy-on-write#In_computer_storage). DBLab supports two technologies to enable CoW and thin cloning: [ZFS](https://en.wikipedia.org/wiki/ZFS) (default) and [LVM](https://en.wikipedia.org/wiki/Logical_Volume_Manager_(Linux)).

assets/database-lab-dark-mode.svg

@@ -15,13 +15,13 @@ info:
   license:
     name: AGPL v3 / Database Lab License
     url: https://github.com/postgres-ai/database-lab-engine/blob/master/LICENSE
-  version: 3.4.0
+  version: 3.5.0
 externalDocs:
   description: DBLab Docs
   url: https://gitlab.com/postgres-ai/docs/tree/master/docs/database-lab
 
 servers:
-  - url: "https://demo.aws.postgres.ai:446/api"
+  - url: "https://demo.aws.postgres.ai:446"
     description: "DBLab 3.x demo server; token: 'demo-token'"
     x-examples:
       Verification-Token: "demo-token"
@@ -484,7 +484,7 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
 
-  /observation/download/{artifact_type}/{clone_id}/{session_id}:
+  /observation/download:
     get:
       tags:
         - Observation
@@ -497,27 +497,27 @@ paths:
           schema:
             type: string
           required: true
-        - in: path
+        - in: query
           required: true
           name: "artifact_type"
           schema:
             type: "string"
           description: "Type of the requested artifact"
-        - in: path
+        - in: query
           required: true
           name: "clone_id"
           schema:
             type: "string"
           description: "Clone ID"
-        - in: path
+        - in: query
           required: true
           name: "session_id"
           schema:
             type: "string"
           description: "Session ID"
       responses:
         200:
-          description: Downloaded the specified artificed of the specified
+          description: Downloaded the specified artifact of the specified
             observation session and clone
         400:
           description: "Bad request"
@@ -558,7 +558,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Instance'
+                $ref: "#/components/schemas/Error"
               example:
                 code: "UNAUTHORIZED"
                 message: "Check your verification token."
@@ -613,7 +613,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Instance'
+                $ref: "#/components/schemas/Error"
               example:
                 code: "UNAUTHORIZED"
                 message: "Check your verification token."
@@ -660,7 +660,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Instance'
+                $ref: "#/components/schemas/Error"
               example:
                 code: "UNAUTHORIZED"
                 message: "Check your verification token."
@@ -693,7 +693,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Instance'
+                $ref: "#/components/schemas/Error"
               example:
                 code: "UNAUTHORIZED"
                 message: "Check your verification token."
@@ -738,7 +738,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Instance'
+                $ref: "#/components/schemas/Error"
               example:
                 code: "UNAUTHORIZED"
                 message: "Check your verification token."
@@ -762,6 +762,76 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/WSToken"
+  /admin/billing-status:
+    get:
+      tags:
+        - Admin
+      summary: Checks billing status
+      description: ""
+      operationId: billingStatus
+      parameters:
+        - in: header
+          name: Verification-Token
+          schema:
+            type: string
+          required: true
+      responses:
+        200:
+          description: "Successful operation"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BillingStatus"
+        400:
+          description: "Bad request"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        401:
+          description: Unauthorized access
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+              example:
+                code: "UNAUTHORIZED"
+                message: "Check your verification token."
+  /admin/activate:
+    post:
+      tags:
+        - Admin
+      summary: "Activate billing"
+      description: "Activates billing and sends usage statistics of the instance"
+      operationId: activateBilling
+      parameters:
+        - in: header
+          name: Verification-Token
+          schema:
+            type: string
+          required: true
+      responses:
+        200:
+          description: "Successful operation"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Engine"
+        400:
+          description: "Bad request"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        401:
+          description: Unauthorized access
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+              example:
+                code: "UNAUTHORIZED"
+                message: "Check your verification token."
 
 components:
   schemas:
@@ -1245,7 +1315,6 @@ components:
           type: "string"
         dbVersion:
           type: "integer"
-          required: false
         tuningParams:
           type: "object"
           additionalProperties:

assets/database-lab-light-mode.svg

@@ -191,7 +191,7 @@ func (s *Server) Reload(cfg srvCfg.Config) {
 
 // InitHandlers initializes handler functions of the HTTP server.
 func (s *Server) InitHandlers() {
-	r := mux.NewRouter().StrictSlash(true)
+	r := mux.NewRouter().StrictSlash(true).UseEncodedPath()
 
 	authMW := mw.NewAuth(s.Config.VerificationToken, s.Platform)
 

assets/dle-simple.svg

@@ -7,6 +7,7 @@ package validator
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/pkg/errors"
 	passwordvalidator "github.com/wagslane/go-password-validator"
@@ -34,6 +35,10 @@ func (v Service) ValidateCloneRequest(cloneRequest *types.CloneCreateRequest) er
 		return errors.New("missing DB password")
 	}
 
+	if cloneRequest.ID != "" && strings.Contains(cloneRequest.ID, "/") {
+		return errors.New("Clone ID cannot contain slash ('/'). Please choose another ID")
+	}
+
 	if err := passwordvalidator.Validate(cloneRequest.DB.Password, minEntropyBits); err != nil {
 		return fmt.Errorf("password validation: %w", err)
 	}

assets/dle.svg

@@ -55,6 +55,13 @@ func TestValidationCloneRequestErrors(t *testing.T) {
 			createRequest: types.CloneCreateRequest{DB: &types.DatabaseRequest{Password: "password"}},
 			error:         "missing DB username",
 		},
+		{
+			createRequest: types.CloneCreateRequest{
+				DB: &types.DatabaseRequest{Username: "user", Password: "password"},
+				ID: "test/ID",
+			},
+			error: "Clone ID cannot contain slash ('/'). Please choose another ID",
+		},
 	}
 
 	for _, tc := range testCases {