Template

Template models.

class renku.domain_model.template.RenderedTemplate(path, template, metadata)

Bases: object

A rendered version of a Template.

get_files()

Return all files in a rendered renku template.

class renku.domain_model.template.Template(id, name, description, parameters, icon, ssh_supported, aliases, immutable_files, allow_update, source, reference, version, path, templates_source)

Bases: object

Template files and metadata from a template source.

get_all_references()

Return all available references for the template.

get_files()

Return all files in a rendered renku template.

render(metadata, ignore_template_errors=False)

Render template files in a new directory.

property templates_source

Return template’s source.

validate(skip_files, raise_errors=True)

Validate a template.

class renku.domain_model.template.TemplateMetadata(metadata, immutable_files)

Bases: object

Metadata required for rendering a template.

property allow_update

Is template updatable.

classmethod from_dict(metadata)

Return an instance from a metadata dict.

classmethod from_project(project)

Return an instance from reading template-related metadata from a project.

property id

Template id.

property reference

Template reference.

property source

Template source.

update(template)

Update metadata from a template.

property version

Template version.

class renku.domain_model.template.TemplateParameter(name, description, type, possible_values, default)

Bases: object

Represent template variables.

convert(value)

Convert a given value to the proper type and raise if value is not valid.

classmethod from_dict(name, value)

Create an instance from a dict.

property has_default

Return True if a default value is set.

validate(raise_errors=True)

Validate manifest content.

class renku.domain_model.template.TemplatesManifest(content, skip_validation=False)

Bases: object

Manifest file for Renku templates.

classmethod from_path(path, skip_validation=False)

Extract template metadata from the manifest file.

classmethod from_string(content, skip_validation=False)

Extract template metadata from the manifest file.

get_raw_content()

Return raw manifest file content.

property templates

Return list of available templates info in the manifest.

validate(manifest_only=False)

Validate manifest content.

class renku.domain_model.template.TemplatesSource(path, source, reference, version, skip_validation=False)

Bases: object

Base class for Renku template sources.

abstract classmethod fetch(source, reference)

Fetch an embedded or remote template.

abstract get_all_references(id)

Return all available versions for a template id.

abstract get_latest_reference_and_version(id, reference, version)

Return latest reference and version number of a template.

abstract get_template(id, reference)

Return a template at a specific reference.

is_update_available(id, reference, version)

Return True if an update is available along with the latest reference of a template.

property templates

Return list of templates.

renku.domain_model.template.calculate_dockerfile_checksum(*, dockerfile=None, dockerfile_content=None)

Calculate checksum for the given file or content.

NOTE: We ignore empty lines and whitespace characters at the end of the lines when calculating Dockerfile checksum if it has Renku-specific section markers.

renku.domain_model.template.find_renku_section(lines)

Return start and end line numbers of the Renku-specific section.

renku.domain_model.template.get_renku_section_from_dockerfile(content)

Return the Renku-specific section of the Dockerfile or the whole Dockerfile if it doesn’t exist.

renku.domain_model.template.hash_template_file(*, relative_path, absolute_path)

Use proper hash on a template file.

renku.domain_model.template.update_dockerfile_content(source, destination)

Update the Renku-specific section of the destination Dockerfile with the one from the source Dockerfile.