pod_porter package

Subpackages

• pod_porter.render package
  • Submodules
  • pod_porter.render.render module
    • Render
      • Render.BASE_DIRECTORY
      • Render.TEMPLATE_DIRECTORY
      • Render.from_file()
      • Render.from_string()
  • Module contents
• pod_porter.util package
  • Submodules
  • pod_porter.util.directories module
    • create_temp_working_directory()
    • delete_temp_working_directory()
  • pod_porter.util.file_read_write module
    • create_new_map()
    • create_tar_gz_file()
    • extract_tar_gz_file()
    • get_ignore_patterns()
    • should_ignore()
    • write_file()
  • pod_porter.util.schemas module
    • MapSchema
      • MapSchema.api_version
      • MapSchema.app_version
      • MapSchema.description
      • MapSchema.name
      • MapSchema.version
  • Module contents

Submodules

pod_porter.pod_porter module

Pod Porter Main Application

class pod_porter.pod_porter.PorterMapsRunner(path: str, release_name: str | None = None, values_override: str | None = None)

Bases: object

A class to represent the PorterMapRunner for collecting and running maps

Parameters:

• path (str) – The path to the directory containing the map.yaml and values.yaml files

• release_name (Optional[str] = None) – The name of the release

Return type:

None

Returns:

Nothing

get_map_data() → MapSchema

Get the map data

Return type:

MapSchema

Returns:

The map data

render_compose() → str

Render the compose file

Return type:

str

Returns:

The rendered compose file

static validate_compose_json_schema(compose_data: dict) → None

Validate the created compose data against the compose spec JSON schema https://github.com/compose-spec/compose-spec/blob/main/schema/compose-spec.json

Parameters:

compose_data (dict) – The compose data

Return type:

None

Returns:

Nothing it validates the JSON data against the JSON schema

pod_porter.pod_porter.validate_json_against_schema(values_data: dict, json_schema: dict) → None

Validate a data set against a JSON schema

Parameters:

• values_data (dict) – The data to validate

• json_schema (dict) – The schema to validate against

Return type:

None

Returns:

Nothing

Raises:

ValueError: If the validation fails

pod_porter.pod_porter_cli module

CLI for pod_porter

pod_porter.pod_porter_cli.cli() → None

Function to run the command line

Return type:

None

Returns:

Nothing it is the CLI

pod_porter.pod_porter_cli.cli_argument_parser() → ArgumentParser

Function to create the argument parser

Return type:

ArgumentParser

Returns:

The argument parser

pod_porter.pod_porter_cli.common_sub_parser_arguments(sub_arg_parser: ArgumentParser) → None

Add common arguments to a sub parser

Parameters:

sub_arg_parser (ArgumentParser) – The sub parser to add the arguments to

Return type:

None

Returns:

Nothing it appends the arguments to the sub parser

pod_porter.pod_porter_cli.common_sub_parser_map_arguments(sub_arg_parser: ArgumentParser) → None

Add common arguments to a sub parser

Parameters:

sub_arg_parser (ArgumentParser) – The sub parser to add the arguments to

Return type:

None

Returns:

Nothing it appends the arguments to the sub parser

pod_porter.pod_porter_cli.common_sub_parser_output_path(sub_arg_parser: ArgumentParser) → None

Add common arguments to a sub parser

Parameters:

sub_arg_parser (ArgumentParser) – The sub parser to add the arguments to

Return type:

None

Returns:

Nothing it appends the arguments to the sub parser

Module contents

init for pod_porter