👖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

GEThttps://example.com/api/pb/{projectId}/{deploymentId}/status

Path parameters

projectId*string

deploymentId*string

Response

200404

Deployment status

Body

application/json

replicasinteger

podNamesarray of string

resourcesDeploymentResources (object)

statusstring

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/{projectId}/{deploymentId}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get metrics for a specific deployment

GEThttps://example.com/api/pb/{projectId}/{deploymentId}/metrics

Path parameters

projectId*string

deploymentId*string

Response

200404

Deployment metrics

Body

application/json

metricsarray of PodMetrics (object)

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/{projectId}/{deploymentId}/metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get events for a specific deployment

GEThttps://example.com/api/pb/{projectId}/{deploymentId}/events

Path parameters

projectId*string

deploymentId*string

Response

200404

Events list for the deployment

Body

application/json

eventsarray of Event (object)

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/{projectId}/{deploymentId}/events', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get logs for a specific pod

GEThttps://example.com/api/pb/{projectId}/{podName}/logs

Path parameters

projectId*string

podName*string

Response

200404

Pod logs

Body

application/text

logsstring

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/{projectId}/{podName}/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "logs": "text"
}

Retrieve a blueprint by ID

GEThttps://example.com/api/pb/blueprints/{blueprintId}

Path parameters

blueprintId*string

Response

200404

Blueprint details

Body

application/json

idstring

detailsstring

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/blueprints/{blueprintId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Share a blueprint

POSThttps://example.com/api/pb/blueprints/shared/{blueprintId}

Path parameters

blueprintId*string

Response

200404

Blueprint shared successfully

Body

application/json

messagestring

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/blueprints/shared/{blueprintId}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

Trigger an automatic update

POSThttps://example.com/api/pb/auto-update/{autoUpdateId}

Path parameters

autoUpdateId*string

Response

200

Update initiated

Body

application/json

statusstring

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/auto-update/{autoUpdateId}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text"
}

Retrieve cluster information

GEThttps://example.com/api/pb/cluster-info

Response

200

Cluster information

Body

application/json

clusterIdstring

statusstring

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/cluster-info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Delete a specific pod

DELETEhttps://example.com/api/pb/{projectId}/{podName}

Path parameters

projectId*string

podName*string

Response

204404

Pod deleted successfully

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/pb/{projectId}/{podName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Open a WebSocket to receive live deployment updates

GEThttps://example.com/api/ws/k8s/deployments

Response

101

WebSocket connection established

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/ws/k8s/deployments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Open a WebSocket to receive live logs from pods

GEThttps://example.com/api/ws/k8s/logs

Response

101

WebSocket connection established

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/ws/k8s/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Open a WebSocket to receive live events from deployments

GEThttps://example.com/api/ws/k8s/events

Response

101

WebSocket connection established

Request

JavaScriptCurl

const response = await fetch('https://example.com/api/ws/k8s/events', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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.