👖Pocketbase

One-Click uses the open source backend pocketbase to achieve things like authentication and storing data. It also serves the frontend of One-Click. In the release process the pocketbase and frontend code will get compiled and put into a single container image and pushed to the Github container registry.

Pocketbase offers the ability to extend it with our own golang code. You can listen on certain events and then execute code. We use that to make the Kubernetes api calls and manage the Kubernetes resources created via the frontend interface.

You can find the code under the following link: https://github.com/janlauber/one-click/tree/main/pocketbase

Authentication

Pocketbase uses JWT tokens for authentication. The frontend sends a request to the pocketbase backend with the user credentials. The backend then checks if the user exists and if the password is correct. If everything is correct, the backend will return a JWT token. The frontend will then store this token in the local storage and use it for every request to the backend.

We also support the ability to use the following authentication providers:

• Google

• Github

• Microsoft

The frontend will automatically display the login buttons for these providers if they are enabled in the pocketbase backend.

pocketbase settings

Database UML

Generated with the PocketBaseUML tool.

UML

Endpoints

Pocketbase allows you to create custom endpoints. These endpoints can be used to execute custom code. We use this feature to serve everything to the frontend. The custom endpoints are written in golang and you can find them in the main.go file under the app.OnBeforeServe().Add(func(e *core.ServeEvent) error { function.

Get the status of a specific deployment

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

deploymentIdstringRequired

Responses

200

Deployment status

application/json

404

Deployment not found

get

/pb/{projectId}/{deploymentId}/status

HTTPcURLJavaScriptPython

GET /api/pb/{projectId}/{deploymentId}/status HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "replicas": 1,
  "podNames": [
    "text"
  ],
  "resources": {
    "requestSum": {
      "cpu": "text",
      "memory": "text"
    },
    "limitSum": {
      "cpu": "text",
      "memory": "text"
    }
  },
  "status": "text"
}

Get metrics for a specific deployment

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

deploymentIdstringRequired

Responses

200

Deployment metrics

application/json

404

Deployment not found

get

/pb/{projectId}/{deploymentId}/metrics

HTTPcURLJavaScriptPython

GET /api/pb/{projectId}/{deploymentId}/metrics HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "metrics": [
    {
      "name": "text",
      "cpu": "text",
      "memory": "text"
    }
  ]
}

Get events for a specific deployment

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

deploymentIdstringRequired

Responses

200

Events list for the deployment

application/json

404

Deployment not found

get

/pb/{projectId}/{deploymentId}/events

HTTPcURLJavaScriptPython

GET /api/pb/{projectId}/{deploymentId}/events HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "events": [
    {
      "reason": "text",
      "message": "text",
      "typus": "text"
    }
  ]
}

Get logs for a specific pod

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

podNamestringRequired

Responses

200

Pod logs

application/text

404

Pod not found

get

/pb/{projectId}/{podName}/logs

HTTPcURLJavaScriptPython

GET /api/pb/{projectId}/{podName}/logs HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "logs": "text"
}

Retrieve a blueprint by ID

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

blueprintIdstringRequired

Responses

200

Blueprint details

application/json

404

Blueprint not found

get

/pb/blueprints/{blueprintId}

HTTPcURLJavaScriptPython

GET /api/pb/blueprints/{blueprintId} HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "details": "text"
}

Share a blueprint

post

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

blueprintIdstringRequired

Responses

200

Blueprint shared successfully

application/json

404

Blueprint not found

post

/pb/blueprints/shared/{blueprintId}

HTTPcURLJavaScriptPython

POST /api/pb/blueprints/shared/{blueprintId} HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "text"
}

Trigger an automatic update

post

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

autoUpdateIdstringRequired

Responses

200

Update initiated

application/json

post

/pb/auto-update/{autoUpdateId}

HTTPcURLJavaScriptPython

POST /api/pb/auto-update/{autoUpdateId} HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Update initiated

{
  "status": "text"
}

Retrieve cluster information

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Responses

200

Cluster information

application/json

get

/pb/cluster-info

HTTPcURLJavaScriptPython

GET /api/pb/cluster-info HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Cluster information

{
  "clusterId": "text",
  "status": "text"
}

Delete a specific pod

delete

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

podNamestringRequired

Responses

204

Pod deleted successfully

404

Pod not found

delete

/pb/{projectId}/{podName}

HTTPcURLJavaScriptPython

DELETE /api/pb/{projectId}/{podName} HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Open a WebSocket to receive live deployment updates

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Responses

101

WebSocket connection established

get

/ws/k8s/deployments

HTTPcURLJavaScriptPython

GET /api/ws/k8s/deployments HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

101

WebSocket connection established

No content

Open a WebSocket to receive live logs from pods

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Responses

101

WebSocket connection established

get

/ws/k8s/logs

HTTPcURLJavaScriptPython

GET /api/ws/k8s/logs HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

101

WebSocket connection established

No content

Open a WebSocket to receive live events from deployments

get

Required scopes

This endpoint requires the following scopes:

• : read access
• : write access

Authorizations

OAuth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Responses

101

WebSocket connection established

get

/ws/k8s/events

HTTPcURLJavaScriptPython

GET /api/ws/k8s/events HTTP/1.1
Host: example.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

101

WebSocket connection established

No content

Table

Endpoint	Method	Description
/	*	Serves the frontend
/api	*	Serves the backend
/_	*	Serves the backend
/rollouts/:projectId/:rolloutId/status	GET	Get rollout status
/rollouts/:projectId/:rolloutId/metrics	GET	Get rollout metrics
/rollouts/:projectId/:rolloutId/events	GET	Get rollout events
/rollouts/:projectId/:podName/logs	GET	Get pod logs
/pb/blueprints/:blueprintId	GET	Get blueprint
/pb/blueprints/shared/:blueprintId	POST	Share blueprint
/auto-update/:autoUpdateId	POST	Auto update
/cluster-info	GET	Get cluster info
/rollouts/:projectId/:podName	DELETE	Delete pod
/ws/k8s/rollouts	GET	Websocket to get resource updates of a rollout
/ws/k8s/logs	GET	Websocket to get pod logs
/ws/k8s/events	GET	Websocket to get pod events

All endpoints are protected by the JWT authentication, except the websocket endpoints. The frontend will send the JWT token in the header of the request.

Environment Variables

Variable Name	Default	Description
LOCAL	false	Set to true if you're running KubeLab locally. It will take your local kubeconfig under .kube/config
LOCAL_KUBECONFIG_FILE	~/.kube/config	Set to the path of your kubeconfig file if you're running KubeLab locally. It will take your local kubeconfig under the specified path
CronTick	*/1 * * * *	The tick in cron notation at which the auto image update will check for new updates in the registry. Do not change this under 1min

Extended Information

For more information about pocketbase, please visit the official documentation. Also dig into the source code of our implementations and try to understand how we use pocketbase in our project.