annotations
Annotations for the manifest.
Most org.opencontainers.image annotations are set automatically if the GitHub option is enabled.
Type: attribute set of anything
Default:
{ }
autoTags
Configuration for tags that are generated automatically.
Type: submodule
Default:
{ }
autoTags.branch
Whether to enable add a tag based on the branch name.
Type: boolean
Default:
true
Example:
false
autoTags.latest
Whether to enable add a ‘latest’ tag if branch == defaultBranch.
Type: boolean
Default:
true
Example:
false
autoTags.major
Whether to enable add a tag based on the major version (e.g., 1).
Type: boolean
Default:
true
Example:
false
autoTags.majorMinor
Whether to enable add a tag based on the major and minor version (e.g., 1.2).
Type: boolean
Default:
true
Example:
false
autoTags.version
Whether to enable add a tag based on the version (e.g., 1.2.3).
Type: boolean
Default:
true
Example:
false
branch
Name of the git branch (e.g., main).
Type: null or string
Default:
"github.branch || null"
defaultBranch
Name of the git branch that is used as default for the latest tag.
Type: string
Default:
"if `github.enable` then `$GITHUB_DEFAULT_BRANCH` else `main`"
format
The format of the manifest
Type: one of “oci”, “v2s2”
Default:
"oci"
github
GitHub integration configuration
Type: submodule
Default:
{ }
github.enable
Whether the GitHub integration is enabled.
If set to true, you need to run nix with the --impure flag in order to access the GitHub API.
Type: boolean
Default:
false
Example:
true
github.enableRegistry
Whether to enable the GitHub container registry.
Type: boolean
Default:
true
Example:
false
github.actor
GitHub actor.
Used as default value for registries."ghcr.io".username.
Type: null or string
Default:
"$GITHUB_ACTOR || null"
github.apiEndpoint
GitHub API endpoint. Can be used for custom GitHub installations.
Type: string
Default:
"https://api.github.com"
github.branch
Name of the git branch.
Type: null or string
Default:
"$GITHUB_REF_NAME || null"
github.registry
Name of the GitHub registry
Type: string
Default:
"ghcr.io"
github.repo
Full name of the GitHub repository (e.g., mirkolenz/flocken).
Used as default value for registries."ghcr.io".repo.
Type: null or string
Default:
"$GITHUB_REPOSITORY || null"
github.token
GitHub access token.
Used as default value for registries."ghcr.io".password.
Type: string
Default:
"$GITHUB_TOKEN"
imageFiles
List of Docker images to be added to the manifest.
Can for instance be produced using dockerTools.buildLayeredImage.
Note: This should be a list of identical images for different architectures.
Type: list of package
Default:
[ ]
imageStreams
List of Docker image streams to be added to the manifest.
Can for instance be produced using dockerTools.streamLayeredImage.
Note: This should be a list of identical images for different architectures.
Type: list of package
Default:
[ ]
images
Alias of imageFiles.
Type: list of package
manifestName
The name of the manifest
Type: string
Default:
"flocken"
registries
Configuration for the Docker registries to be used.
The key is the name of the registry (e.g., ghcr.io).
Type: attribute set of (submodule)
Default:
{ }
registries.<name>.enable
Whether to enable pushing to the registry.
Type: boolean
Default:
true
Example:
false
registries.<name>.name
The name/domain of the registry
Type: string
Default:
"‹name›"
registries.<name>.password
Password for pushing to the registry.
Type: string
registries.<name>.repo
Fully qualified name of the Docker image in the registry (e.g., mirkolenz/flocken).
Type: string
registries.<name>.username
Username for pushing to the registry.
Type: string
tags
List of custom/additional tags to be added to the manifest.
Type: list of string
Default:
[ ]
version
Semantic version of the image (e.g., v1.0.0 or 1.0.0).
Type: null or string
Default:
"$VERSION || null"