Fleet docs v0.2.0-rc.448

Projects

A project is a repo that agents work in. The page Projects (/projects) adds one from the repos of the fleet's git host, gives the machines read access to it, and lists the secrets it needs (#741, docs/fleet/onboarding.md step 4). No step needs a terminal.

Add a project

The list shows the repos fleet can read on its git host (today: the fleet's Forgejo connection). Add makes the repo a project and gives the machines read access to it:

  • Fleet makes an ssh key and adds its public half to the repo as a read-only deploy key. The key can clone and fetch this one repo and nothing else; it cannot push.
  • The private half goes to the vault as the project secret PROJECT_DEPLOY_KEY. A turn of the project gets it as a 0600 file in its own temporary dir, and git reads the repo's https URL over ssh with it. Pushes still go to the https URL with the agent's own login.
  • A machine needs nothing set up for the repo: the access comes with each turn.

The checklist

Each project has rows, each with a state from a check made when the page loads:

Row Blocking Green when
repo access yes the deploy key is on the host, read-only, and its private half is in the vault
secret NAME later the project secret NAME is set

The secret rows are the project's secret_keys and the UPPER_CASE names in the repo's .fleet/needs.yaml. A red row is missing or failing; its last error says why. A missing secret has a paste field: the value is stored once and never shown again (the same store as Secrets). Retry on the access row makes a new deploy key when the old one is gone.

Remove a project

Remove deletes the deploy key on the git host first, then the key's private half, then the project. If the host refuses, the project stays, so no key is left behind. A project that comes from the overlay repo (projects/*.yaml) comes back at the next sync; remove its file there.