Dagger
Search

fedora

A Dagger module for working with and generating a container image from the
specified source Fedora image wrapping the dagger.Container type with several
Fedora specific methods

Installation

dagger install github.com/scottames/daggerverse/fedora@v0.0.1

Entrypoint

Return Type
Fedora !
Arguments
NameTypeDescription
registryString Container registry
orgString Container registry organization
variantString Variant or image name
suffixString Variant suffix string e.g. main (as related to ublue-os images)
tagString Tag or major release version
Example
func (m *myModule) example() *Fedora  {
	return dag.
			Fedora()
}
@function
def example() -> dag.Fedora:
	return (
		dag.fedora()
	)
@func()
example(): Fedora {
	return dag
		.fedora()
}

Types

Fedora 🔗

Fedora represents the constructed Fedora image

org() 🔗

Return Type
String 
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			Org(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.org()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.org()
}

registry() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			Registry(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.registry()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.registry()
}

suffix() 🔗

Return Type
String 
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			Suffix(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.suffix()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.suffix()
}

tag() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			Tag(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.tag()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.tag()
}

variant() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			Variant(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.variant()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.variant()
}

releaseVersion() 🔗

Return Type
String 
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			ReleaseVersion(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.release_version()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.releaseVersion()
}

baseImage() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			BaseImage(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.base_image()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.baseImage()
}

baseImageVersion() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			BaseImageVersion(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.base_image_version()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.baseImageVersion()
}

date() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			Date(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.date()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.date()
}

digests() 🔗

Return Type
[String ! ] !
Example
func (m *myModule) example(ctx context.Context) []string  {
	return dag.
			Fedora().
			Digests(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.fedora()
		.digests()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.fedora()
		.digests()
}

directories() 🔗

Return Type
[DirectoryFromSource ! ] !
Example
func (m *myModule) example() []*FedoraDirectoryFromSource  {
	return dag.
			Fedora().
			Directories()
}
@function
def example() -> List[dag.FedoraDirectoryFromSource]:
	return (
		dag.fedora()
		.directories()
	)
@func()
example(): FedoraDirectoryFromSource[] {
	return dag
		.fedora()
		.directories()
}

files() 🔗

Return Type
[FileFromSource ! ] !
Example
func (m *myModule) example() []*FedoraFileFromSource  {
	return dag.
			Fedora().
			Files()
}
@function
def example() -> List[dag.FedoraFileFromSource]:
	return (
		dag.fedora()
		.files()
	)
@func()
example(): FedoraFileFromSource[] {
	return dag
		.fedora()
		.files()
}

packageGroupsInstalled() 🔗

Return Type
[String ! ] !
Example
func (m *myModule) example(ctx context.Context) []string  {
	return dag.
			Fedora().
			PackageGroupsInstalled(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.fedora()
		.package_groups_installed()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.fedora()
		.packageGroupsInstalled()
}

packageGroupsRemoved() 🔗

Return Type
[String ! ] !
Example
func (m *myModule) example(ctx context.Context) []string  {
	return dag.
			Fedora().
			PackageGroupsRemoved(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.fedora()
		.package_groups_removed()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.fedora()
		.packageGroupsRemoved()
}

packagesInstalled() 🔗

Return Type
[String ! ] !
Example
func (m *myModule) example(ctx context.Context) []string  {
	return dag.
			Fedora().
			PackagesInstalled(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.fedora()
		.packages_installed()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.fedora()
		.packagesInstalled()
}

packagesRemoved() 🔗

Return Type
[String ! ] !
Example
func (m *myModule) example(ctx context.Context) []string  {
	return dag.
			Fedora().
			PackagesRemoved(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.fedora()
		.packages_removed()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.fedora()
		.packagesRemoved()
}

packagesSwapped() 🔗

Return Type
[Swap ! ] !
Example
func (m *myModule) example() []*FedoraSwap  {
	return dag.
			Fedora().
			PackagesSwapped()
}
@function
def example() -> List[dag.FedoraSwap]:
	return (
		dag.fedora()
		.packages_swapped()
	)
@func()
example(): FedoraSwap[] {
	return dag
		.fedora()
		.packagesSwapped()
}

repos() 🔗

Return Type
[Repo ! ] !
Example
func (m *myModule) example() []*FedoraRepo  {
	return dag.
			Fedora().
			Repos()
}
@function
def example() -> List[dag.FedoraRepo]:
	return (
		dag.fedora()
		.repos()
	)
@func()
example(): FedoraRepo[] {
	return dag
		.fedora()
		.repos()
}

execScriptPre() 🔗

Return Type
[File ! ] !
Example
func (m *myModule) example() []*File  {
	return dag.
			Fedora().
			ExecScriptPre()
}
@function
def example() -> List[dagger.File]:
	return (
		dag.fedora()
		.exec_script_pre()
	)
@func()
example(): File[] {
	return dag
		.fedora()
		.execScriptPre()
}

execScriptPost() 🔗

Return Type
[File ! ] !
Example
func (m *myModule) example() []*File  {
	return dag.
			Fedora().
			ExecScriptPost()
}
@function
def example() -> List[dagger.File]:
	return (
		dag.fedora()
		.exec_script_post()
	)
@func()
example(): File[] {
	return dag
		.fedora()
		.execScriptPost()
}

execPre() 🔗

Return Type
[List ! ] !
Example
func (m *myModule) example(ctx context.Context) []  {
	return dag.
			Fedora().
			ExecPre(ctx)
}
@function
async def example() -> List[]:
	return await (
		dag.fedora()
		.exec_pre()
	)
@func()
async example(): Promise<[]> {
	return dag
		.fedora()
		.execPre()
}

execPost() 🔗

Return Type
[List ! ] !
Example
func (m *myModule) example(ctx context.Context) []  {
	return dag.
			Fedora().
			ExecPost(ctx)
}
@function
async def example() -> List[]:
	return await (
		dag.fedora()
		.exec_post()
	)
@func()
async example(): Promise<[]> {
	return dag
		.fedora()
		.execPost()
}

labels() 🔗

Return Type
[ContainerLabel ! ] !
Example
func (m *myModule) example() []*FedoraContainerLabel  {
	return dag.
			Fedora().
			Labels()
}
@function
def example() -> List[dag.FedoraContainerLabel]:
	return (
		dag.fedora()
		.labels()
	)
@func()
example(): FedoraContainerLabel[] {
	return dag
		.fedora()
		.labels()
}

withReposFromUrls() 🔗

WithReposFromUrls will add the content at each given url and install them on the Container image prior to package installation via WithPackagesInstalled. Optionally removing the repository afterward, prior to exporting the container.

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
urls[String ! ] !-urls of yum repository files to install (i.e. GitHub raw file)
keepBoolean !-If true, the repository will not be removed on the generated Container image
Example
func (m *myModule) example(urls []string, keep bool) *Fedora  {
	return dag.
			Fedora().
			WithReposFromUrls(urls, keep)
}
@function
def example(urls: List[str], keep: bool) -> dag.Fedora:
	return (
		dag.fedora()
		.with_repos_from_urls(urls, keep)
	)
@func()
example(urls: string[], keep: boolean): Fedora {
	return dag
		.fedora()
		.withReposFromUrls(urls, keep)
}

withPackageGroupsInstalled() 🔗

WithPackageGroupsInstalled will install the given package groups

note: not supported on ostree-based images, will be skipped
Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
groups[String ! ] !-list of package groups to be installed
Example
func (m *myModule) example(groups []string) *Fedora  {
	return dag.
			Fedora().
			WithPackageGroupsInstalled(groups)
}
@function
def example(groups: List[str]) -> dag.Fedora:
	return (
		dag.fedora()
		.with_package_groups_installed(groups)
	)
@func()
example(groups: string[]): Fedora {
	return dag
		.fedora()
		.withPackageGroupsInstalled(groups)
}

withPackageGroupsRemoved() 🔗

WithPackageGroupsRemoved will remove the given package groups

note: not supported on ostree-based images, will be skipped
Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
groups[String ! ] !-list of package groups to be installed
Example
func (m *myModule) example(groups []string) *Fedora  {
	return dag.
			Fedora().
			WithPackageGroupsRemoved(groups)
}
@function
def example(groups: List[str]) -> dag.Fedora:
	return (
		dag.fedora()
		.with_package_groups_removed(groups)
	)
@func()
example(groups: string[]): Fedora {
	return dag
		.fedora()
		.withPackageGroupsRemoved(groups)
}

withPackagesInstalled() 🔗

WithPackagesInstalled will install the given packages on the generated Container image.

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
packages[String ! ] !-list of packages to be installed
Example
func (m *myModule) example(packages []string) *Fedora  {
	return dag.
			Fedora().
			WithPackagesInstalled(packages)
}
@function
def example(packages: List[str]) -> dag.Fedora:
	return (
		dag.fedora()
		.with_packages_installed(packages)
	)
@func()
example(packages: string[]): Fedora {
	return dag
		.fedora()
		.withPackagesInstalled(packages)
}

withPackagesRemoved() 🔗

WithPackagesRemoved will remove the given packages on the generated Container image.

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
packages[String ! ] !-list of packages to be removed on the generated Container image
Example
func (m *myModule) example(packages []string) *Fedora  {
	return dag.
			Fedora().
			WithPackagesRemoved(packages)
}
@function
def example(packages: List[str]) -> dag.Fedora:
	return (
		dag.fedora()
		.with_packages_removed(packages)
	)
@func()
example(packages: string[]): Fedora {
	return dag
		.fedora()
		.withPackagesRemoved(packages)
}

withPackagesSwapped() 🔗

Remove spec and install spec in one transaction equivalent to: dnf swap <remove> <install> ostree-based: rpm-ostree override remove <remove> --install <install>

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
removeString !-package to remove
installString !-package to install
Example
func (m *myModule) example(remove string, install string) *Fedora  {
	return dag.
			Fedora().
			WithPackagesSwapped(remove, install)
}
@function
def example(remove: str, install: str) -> dag.Fedora:
	return (
		dag.fedora()
		.with_packages_swapped(remove, install)
	)
@func()
example(remove: string, install: string): Fedora {
	return dag
		.fedora()
		.withPackagesSwapped(remove, install)
}

withLabel() 🔗

WithLabel will append a label to the generated Container image

maps not currently supported: https://github.com/dagger/dagger/issues/6138 if they do become supported this should be simplified to allow passing a map

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
nameString !-No description provided
valueString !-No description provided
Example
func (m *myModule) example(name string, value string) *Fedora  {
	return dag.
			Fedora().
			WithLabel(name, value)
}
@function
def example(name: str, value: str) -> dag.Fedora:
	return (
		dag.fedora()
		.with_label(name, value)
	)
@func()
example(name: string, value: string): Fedora {
	return dag
		.fedora()
		.withLabel(name, value)
}

withDescription() 🔗

WithDescription will append a label to the generated Container image with the given description

example: org.opencontainers.image.description=<description>
Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
descriptionString !-description to be added to the generated Container image
Example
func (m *myModule) example(description string) *Fedora  {
	return dag.
			Fedora().
			WithDescription(description)
}
@function
def example(description: str) -> dag.Fedora:
	return (
		dag.fedora()
		.with_description(description)
	)
@func()
example(description: string): Fedora {
	return dag
		.fedora()
		.withDescription(description)
}

withExecScripts() 🔗

WithExecScripts adds scripts (Files) to be uploaded and executed on the generated Container image

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
scripts[File ! ] !-scripts (Files) to be uploaded and executed
prePackagesBoolean !-if true, the script(s) will be run prior to any packages being installed on the Container image if false, they will be run after packages are installed as part of WithPackagesInstalled
Example
func (m *myModule) example(scripts []*File, prePackages bool) *Fedora  {
	return dag.
			Fedora().
			WithExecScripts(scripts, prePackages)
}
@function
def example(scripts: List[dagger.File], pre_packages: bool) -> dag.Fedora:
	return (
		dag.fedora()
		.with_exec_scripts(scripts, pre_packages)
	)
@func()
example(scripts: File[], prePackages: boolean): Fedora {
	return dag
		.fedora()
		.withExecScripts(scripts, prePackages)
}

withExec() 🔗

WithExec will execute the given command on the Container image

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
command[String ! ] !-the command to be executed
prePackagesBoolean !-if true, the command will be run prior to any packages being installed on the Container image if false, it will be run after packages are installed as part of WithPackagesInstalled
Example
func (m *myModule) example(command []string, prePackages bool) *Fedora  {
	return dag.
			Fedora().
			WithExec(command, prePackages)
}
@function
def example(command: List[str], pre_packages: bool) -> dag.Fedora:
	return (
		dag.fedora()
		.with_exec(command, pre_packages)
	)
@func()
example(command: string[], prePackages: boolean): Fedora {
	return dag
		.fedora()
		.withExec(command, prePackages)
}

withFile() 🔗

WithFile will upload the given File (file) at the given destination

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
destinationString !-path in Container image to place the source file
fileFile !-file to be uploaded to the Container image
Example
func (m *myModule) example(destination string, file *File) *Fedora  {
	return dag.
			Fedora().
			WithFile(destination, file)
}
@function
def example(destination: str, file: dagger.File) -> dag.Fedora:
	return (
		dag.fedora()
		.with_file(destination, file)
	)
@func()
example(destination: string, file: File): Fedora {
	return dag
		.fedora()
		.withFile(destination, file)
}

getBaseImage() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			GetBaseImage(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.get_base_image()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.getBaseImage()
}

defaultTags() 🔗

DefaultTags returns the default image tags for the output Fedora image as:

<release version> (if determined),
<release version>-<date>,
<latest> (if set to true)
Return Type
[String ! ] !
Arguments
NameTypeDefault ValueDescription
latestBoolean falseif true the "latest" tag will be appended to the returned list
Example
func (m *myModule) example(ctx context.Context) []string  {
	return dag.
			Fedora().
			DefaultTags(ctx)
}
@function
async def example() -> List[str]:
	return await (
		dag.fedora()
		.default_tags()
	)
@func()
async example(): Promise<string[]> {
	return dag
		.fedora()
		.defaultTags()
}

withDirectory() 🔗

WithDirectory will upload the given Directory (directory) at the given destination

Return Type
Fedora !
Arguments
NameTypeDefault ValueDescription
destinationString !-path in Container image to place the source directory
directoryDirectory !-directory to be uploaded to the Container image
Example
func (m *myModule) example(destination string, directory *Directory) *Fedora  {
	return dag.
			Fedora().
			WithDirectory(destination, directory)
}
@function
def example(destination: str, directory: dagger.Directory) -> dag.Fedora:
	return (
		dag.fedora()
		.with_directory(destination, directory)
	)
@func()
example(destination: string, directory: Directory): Fedora {
	return dag
		.fedora()
		.withDirectory(destination, directory)
}

containerAddress() 🔗

ContainerAddress returns the string representation of the source container address

Return Type
String !
Arguments
NameTypeDefault ValueDescription
registryString !-No description provided
orgString -No description provided
variantString !-No description provided
suffixString -No description provided
tagString !-No description provided
Example
func (m *myModule) example(ctx context.Context, registry string, variant string, tag string) string  {
	return dag.
			Fedora().
			ContainerAddress(ctx, registry, variant, tag)
}
@function
async def example(registry: str, variant: str, tag: str) -> str:
	return await (
		dag.fedora()
		.container_address(registry, variant, tag)
	)
@func()
async example(registry: string, variant: string, tag: string): Promise<string> {
	return dag
		.fedora()
		.containerAddress(registry, variant, tag)
}

container() 🔗

Container returns a Fedora container as a dagger.Container object

Return Type
Container !
Example
func (m *myModule) example() *Container  {
	return dag.
			Fedora().
			Container()
}
@function
def example() -> dagger.Container:
	return (
		dag.fedora()
		.container()
	)
@func()
example(): Container {
	return dag
		.fedora()
		.container()
}

containerFrom() 🔗

ContainerFrom returns a Fedora container as a dagger.Container object

Return Type
Container !
Arguments
NameTypeDefault ValueDescription
fromString !-base container image to pull FROM
Example
func (m *myModule) example(from string) *Container  {
	return dag.
			Fedora().
			ContainerFrom(from)
}
@function
def example(from_: str) -> dagger.Container:
	return (
		dag.fedora()
		.container_from(from_)
	)
@func()
example(from: string): Container {
	return dag
		.fedora()
		.containerFrom(from)
}

containerVersionFromLabel() 🔗

ContainerVersionFromLabel returns the label value for the image version, defined as ‘version’ OR ‘org.opencontainers.image.version’ and a possible error

Return Type
String !
Arguments
NameTypeDefault ValueDescription
ctrContainer -Container to use to determine the release version from
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			ContainerVersionFromLabel(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.container_version_from_label()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.containerVersionFromLabel()
}

containerReleaseVersionFromLabel() 🔗

ContainerReleaseVersionFromLabel returns the label value for the image version, defined as ‘version’ OR ‘org.opencontainers.image.version’ - if the version contains sub-versions & dates deliminted by ‘.’ they will parsed out

Return Type
String !
Arguments
NameTypeDefault ValueDescription
ctrContainer -Container to use to determine the release version from
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Fedora().
			ContainerReleaseVersionFromLabel(ctx)
}
@function
async def example() -> str:
	return await (
		dag.fedora()
		.container_release_version_from_label()
	)
@func()
async example(): Promise<string> {
	return dag
		.fedora()
		.containerReleaseVersionFromLabel()
}

DirectoryFromSource 🔗

DirectoryFromSource represents a Directory to be placed in the generated Container image at the Destination

source() 🔗

Return Type
Directory !
Example
Function FedoraDirectoryFromSource.source is not accessible from the fedora module
Function FedoraDirectoryFromSource.source is not accessible from the fedora module
Function FedoraDirectoryFromSource.source is not accessible from the fedora module

destination() 🔗

Return Type
String !
Example
Function FedoraDirectoryFromSource.destination is not accessible from the fedora module
Function FedoraDirectoryFromSource.destination is not accessible from the fedora module
Function FedoraDirectoryFromSource.destination is not accessible from the fedora module

FileFromSource 🔗

FileFromSource represents a File to be placed in the generated Container image at the Destination

destination() 🔗

Return Type
String !
Example
Function FedoraFileFromSource.destination is not accessible from the fedora module
Function FedoraFileFromSource.destination is not accessible from the fedora module
Function FedoraFileFromSource.destination is not accessible from the fedora module

source() 🔗

Return Type
File !
Example
Function FedoraFileFromSource.source is not accessible from the fedora module
Function FedoraFileFromSource.source is not accessible from the fedora module
Function FedoraFileFromSource.source is not accessible from the fedora module

Swap 🔗

remove() 🔗

Return Type
String !
Example
Function FedoraSwap.remove is not accessible from the fedora module
Function FedoraSwap.remove is not accessible from the fedora module
Function FedoraSwap.remove is not accessible from the fedora module

install() 🔗

Return Type
String !
Example
Function FedoraSwap.install is not accessible from the fedora module
Function FedoraSwap.install is not accessible from the fedora module
Function FedoraSwap.install is not accessible from the fedora module

Repo 🔗

Repo represents a yum repository object

url() 🔗

Return Type
String !
Example
Function FedoraRepo.url is not accessible from the fedora module
Function FedoraRepo.url is not accessible from the fedora module
Function FedoraRepo.url is not accessible from the fedora module

fileName() 🔗

Return Type
String !
Example
Function FedoraRepo.fileName is not accessible from the fedora module
Function FedoraRepo.fileName is not accessible from the fedora module
Function FedoraRepo.fileName is not accessible from the fedora module

keep() 🔗

Return Type
Boolean !
Example
Function FedoraRepo.keep is not accessible from the fedora module
Function FedoraRepo.keep is not accessible from the fedora module
Function FedoraRepo.keep is not accessible from the fedora module

ContainerLabel 🔗

ContainerLabel represents a Label to be placed in the generated Container image at the Destination

name() 🔗

Return Type
String !
Example
Function FedoraContainerLabel.name is not accessible from the fedora module
Function FedoraContainerLabel.name is not accessible from the fedora module
Function FedoraContainerLabel.name is not accessible from the fedora module

value() 🔗

Return Type
String !
Example
Function FedoraContainerLabel.value is not accessible from the fedora module
Function FedoraContainerLabel.value is not accessible from the fedora module
Function FedoraContainerLabel.value is not accessible from the fedora module