Introduction
What Harthelm gives a team, who does what, and what you need to start.
Harthelm gives your team cloud workspaces and runs the apps you build in them on Kubernetes. A workspace is a code
editor and terminals in the browser, on your own copy of the code. The app it runs is described in one file,
harthelm.yml, and Harthelm starts it, gives it an address, puts it to sleep when nobody uses it and wakes it on the
next visit.
You need nothing but a browser. The hart command line does the same from your
terminal or a CI pipeline.
What you get
- Workspaces. Your code in
/data/appon a volume of its own, a VS Code editor, terminals, and thehartcommand line, already signed in to the right team. A workspace starts empty or from a Git repository. - Landscapes.
harthelm.ymldescribes the steps that prepare and test your code and the services that run it. Sync creates the services, Run starts them. - Dev URLs. Every running landscape answers at
https://<id>-3000.<workspace domain>, private to your team by default. Paths of that address go to the services you choose. - Managed services. A PostgreSQL database is a few lines in
harthelm.yml; Harthelm creates it, keeps its password in the workspace's vault and dumps it every night. - Custom domains. Put your own host name in front of one or more workspaces, with a certificate Harthelm requests and renews.
- Sleeps when idle. Workspaces and services sleep after a while without use (60 minutes by default) and wake on the next request. Files and settings are kept.
Who does what
Harthelm runs in your company's own Kubernetes cluster. Three kinds of people meet it:
| You are | You do | Start with |
|---|---|---|
| A developer in a team | Create workspaces, write code, describe and run the landscape | Quickstart |
| A team admin | Invite members, add custom domains and container registries, look after the team's quota | Organizations and teams |
| An operator | Install and upgrade Harthelm, connect sign-in and Git, set plans and quotas | Self-hosting |
These docs are written for any Harthelm installation. Your installation's console has its own address; the pages call it <console>, and the domain of its dev URLs <workspace domain>.
What you need
- An account at your installation's sign-in provider. Harthelm has no passwords of its own: it signs you in through your company's identity provider.
- A team. Someone invites you by email, or adds you if you have signed in before. Accepting needs the account with the same email address the invitation went to.
- For Git repositories, a connection to your installation's Git provider. You make it once in the console; see Start from a repository.