fkh 0.2.121

Freddy's Kubernetes Helper

Command-line client for managing Business Central containers hosted in a Kubernetes cluster with a persisted SQL Server on Linux.

Fkh is also available as a VS Code extension: Freddy's Kubernetes Helper on the Marketplace.

Getting started

1. Deploy the Fkh Backend (see Fkh home)
2. Install the CLI from NuGet, using:

dotnet tool install --global fkh

Configuration

The CLI looks for the backend URL in this order:

1. --backendUrl <url> command-line option
2. FKH_BACKEND_URL environment variable
3. ~/.fkh/settings.json (recommended for global tool installs)
4. fkh.settings.json next to the executable

Create a settings file with:

{
    "backendUrl": "https://fkh-<org>-backend.azurewebsites.net/api"
}

Authentication

Authentication is resolved in this order:

1. --useOIDC — Fetch OIDC token from GitHub Actions environment (auto-refreshes)
2. GH_TOKEN environment variable
3. gh auth token — GitHub CLI (interactive fallback). Use --ghUser <user> to target a specific GitHub account.

Access Control

Access to the backend is guarded by two GitHub teams configured in your organization:

• Members team — grants usage access. Members can create, manage, and remove their own containers and images.
• Admins team — grants admin access. Admins can view all containers, list cluster nodes, and use admin-only commands like listcontainers --all and listvms.

In addition, GitHub repositories can be granted usage access via OIDC. Repositories listed in the allowed_oidc_repos configuration can authenticate from GitHub Actions workflows without any stored secrets. Containers created by a repository are owned by that repository.

For GitHub Actions workflows using OIDC, see Using OIDC in workflows.

Usage

fkh <command> [--key "value" ...]

Global Options

Commands

createcontainer

Creates a new Business Central container with a persisted SQL Server database.

fkh createcontainer --name mybc --artifactUrl "///us/latest" --adminUsername admin --adminPassword "P@ssw0rd"

removecontainer

Removes a container and its database permanently.

fkh removecontainer --name mybc

startcontainer

Starts a stopped container by scaling it to 1 replica.

stopcontainer

Stops a running container by scaling it to 0 replicas. The database is preserved.

extendautostop

Extends the auto-stop timer by 2 hours.

listcontainers

Lists your containers with status, image, auto-stop time, and memory usage.

fkh listcontainers
fkh listcontainers --asJson

allowsqlaccess

Opens external SQL Server access for a specific IP address.

revokesqlaccess

Revokes external SQL Server access immediately.

createimage

Builds a Business Central container image in Azure Container Registry.

fkh createimage --nowait

removeimage

Removes an image or tag from the Azure Container Registry.

listimages

Lists available images and tags in the Azure Container Registry.

listvms

Lists Kubernetes cluster nodes with status, CPU, memory, and container assignments. Admin only.

getcontainerlogs

Retrieves logs from a container.

fkh getcontainerlogs --name mybc

invokesqlcmd

Executes a SQL statement against a container's database.

Using OIDC in Workflows

Repositories configured in allowed_oidc_repos can authenticate without storing secrets:

permissions:
  id-token: write

steps:
  - name: Create container
    run: fkh createcontainer --name mybc --artifactUrl "///us/latest" --useOIDC