Flux Deploy Keys

⚠️ Note: We now use a GitHub App to authenticate Flux with GitHub instead of SSH deploy keys. For more information see Flux GitHub App Authentication.

Creating deploy keys

Deploy keys are created by generating an SSH key locally like you would for your own account.

You then go to your repo settings and find Deploy keys. Click Add deploy key and paste in the contents of the SSH public key you’ve created.

Give the deploy key a sensible name and save.

Warning Each environment should have a unique key! Do not share keys between environments!

This SSH key can now be used to authenticate to this GitHub repo. By default, it has read-only access.

You should only require read/write access when flux needs to write back to GitHub. This would only be required on our PTL cluster as it has the image automation controller configured on it.

See flux image automation for more information.

Saving deploy keys in Key Vault

You can follow these instructions to store the SSH deploy keys in Key Vault.

This page was last reviewed on 17 June 2025. It needs to be reviewed again on 17 June 2026 by the page owner platops-build-notices .

This page was set to be reviewed before 17 June 2026 by the page owner platops-build-notices. This might mean the content is out of date.