infrahouse_toolkit package

Subpackages

• infrahouse_toolkit.aws package
  • Subpackages
    • infrahouse_toolkit.aws.tests package
      • Subpackages
      • Module contents
  • Submodules
  • infrahouse_toolkit.aws.asg module
    • ASG
      • ASG.cancel_instance_refresh()
      • ASG.complete_lifecycle_action()
      • ASG.instance_refreshes
      • ASG.instances
  • infrahouse_toolkit.aws.asg_instance module
    • ASGInstance
      • ASGInstance.asg_name
      • ASGInstance.lifecycle_state
      • ASGInstance.mark_unhealthy()
  • infrahouse_toolkit.aws.config module
    • AWSConfig
      • AWSConfig.aws_home
      • AWSConfig.config_parser
      • AWSConfig.config_path
      • AWSConfig.get_account_id()
      • AWSConfig.get_region()
      • AWSConfig.get_role()
      • AWSConfig.get_sso_region()
      • AWSConfig.get_start_url()
      • AWSConfig.profiles
      • AWSConfig.regions
  • infrahouse_toolkit.aws.ec2_instance module
    • EC2Instance
      • EC2Instance.availability_zone
      • EC2Instance.instance_id
      • EC2Instance.state
      • EC2Instance.tags
  • infrahouse_toolkit.aws.exceptions module
    • IHAWSException
  • infrahouse_toolkit.aws.resource_discovery module
    • EBSVolume
      • EBSVolume.delete()
      • EBSVolume.exists
    • ECSCapacityProvider
      • ECSCapacityProvider.delete()
      • ECSCapacityProvider.exists
    • ECSCluster
      • ECSCluster.delete()
      • ECSCluster.exists
    • ECSService
      • ECSService.delete()
      • ECSService.exists
    • ECSTaskDefinition
      • ECSTaskDefinition.delete()
      • ECSTaskDefinition.exists
    • KeyPair
      • KeyPair.delete()
      • KeyPair.exists
    • LaunchTemplate
      • LaunchTemplate.delete()
      • LaunchTemplate.exists
    • NetworkInterface
      • NetworkInterface.delete()
      • NetworkInterface.exists
    • SecurityGroupRule
      • SecurityGroupRule.delete()
      • SecurityGroupRule.exists
    • find_iam_roles_by_tag()
    • find_resources_by_tags()
    • format_resources_arns()
    • format_resources_json()
    • format_resources_table()
    • parse_arn()
    • resource_for_arn()
  • Module contents
    • assume_role()
    • aws_sso_login()
    • get_aws_client()
    • get_aws_session()
    • get_client()
    • get_credentials_from_environ()
    • get_secret()
• infrahouse_toolkit.cli package
  • Subpackages
    • infrahouse_toolkit.cli.ih_aws package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.ih_certbot package
      • Module contents
    • infrahouse_toolkit.cli.ih_ec2 package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.ih_elastic package
      • Subpackages
      • Submodules
      • infrahouse_toolkit.cli.ih_elastic.cmd_api module
      • Module contents
    • infrahouse_toolkit.cli.ih_github package
      • Subpackages
      • Submodules
      • infrahouse_toolkit.cli.ih_github.cmd_backup module
      • infrahouse_toolkit.cli.ih_github.exceptions module
      • Module contents
    • infrahouse_toolkit.cli.ih_openvpn package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.ih_plan package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.ih_puppet package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.ih_registry package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.ih_s3 package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.ih_s3_reprepro package
      • Submodules
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_check module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_checkpool module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_deleteunreferenced module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_dumpunreferenced module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_get_secret_value module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_includedeb module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_list module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_migrate module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_remove module
      • infrahouse_toolkit.cli.ih_s3_reprepro.cmd_set_secret_value module
      • Module contents
    • infrahouse_toolkit.cli.ih_secrets package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.ih_skeema package
      • Subpackages
      • Module contents
    • infrahouse_toolkit.cli.tests package
      • Submodules
      • infrahouse_toolkit.cli.tests.conftest module
      • infrahouse_toolkit.cli.tests.test_get_bucket module
      • Module contents
  • Submodules
  • infrahouse_toolkit.cli.exceptions module
    • IHCLIError
  • infrahouse_toolkit.cli.gpg module
    • gpg()
    • gpg_home()
    • write_gpg_cong()
  • infrahouse_toolkit.cli.lib module
    • get_backend_key()
    • get_bucket()
    • get_elastic_password()
    • get_s3_client()
    • read_from_file_or_prompt()
  • infrahouse_toolkit.cli.utils module
    • check_dependencies()
    • execute()
    • local_s3()
    • mkdir_p()
    • mount_s3()
    • repo_env()
    • retry()
    • sanitize_env()
    • sanitize_secret()
    • sha256()
    • tmpfs_s3()
    • umount_s3()
  • Module contents
• infrahouse_toolkit.lock package
  • Subpackages
    • infrahouse_toolkit.lock.tests package
      • Submodules
      • infrahouse_toolkit.lock.tests.test_system_lock module
      • Module contents
  • Submodules
  • infrahouse_toolkit.lock.base module
    • BaseLock
      • BaseLock.exclusive
      • BaseLock.name
      • BaseLock.shared
  • infrahouse_toolkit.lock.exceptions module
    • LockAcquireError
  • infrahouse_toolkit.lock.system module
    • SystemLock
  • Module contents
• infrahouse_toolkit.terraform package
  • Subpackages
    • infrahouse_toolkit.terraform.backends package
      • Subpackages
      • Submodules
      • infrahouse_toolkit.terraform.backends.exceptions module
      • infrahouse_toolkit.terraform.backends.s3backend module
      • infrahouse_toolkit.terraform.backends.tfbackend module
      • Module contents
    • infrahouse_toolkit.terraform.tests package
      • Subpackages
      • Submodules
      • infrahouse_toolkit.terraform.tests.test_parse_comment module
      • infrahouse_toolkit.terraform.tests.test_parse_plan module
      • infrahouse_toolkit.terraform.tests.test_strip_lines module
      • Module contents
  • Submodules
  • infrahouse_toolkit.terraform.exceptions module
    • IHParseError
    • IHTFException
  • infrahouse_toolkit.terraform.githubpr module
    • GitHubPR
      • GitHubPR.comments
      • GitHubPR.delete_my_comments()
      • GitHubPR.edit_comment()
      • GitHubPR.find_comment_by_backend()
      • GitHubPR.github
      • GitHubPR.github_token
      • GitHubPR.publish_comment()
      • GitHubPR.pull_request
      • GitHubPR.repo
  • infrahouse_toolkit.terraform.status module
    • RunOutput
      • RunOutput.stderr
      • RunOutput.stdout
    • RunResult
      • RunResult.add
      • RunResult.change
      • RunResult.destroy
    • TFStatus
      • TFStatus.comment
      • TFStatus.metadata
      • TFStatus.summary_counts
      • TFStatus.summary_resources
    • decolor()
    • strip_lines()
  • Module contents
    • execute()
    • parse_comment()
    • parse_plan()
    • terraform_apply()
    • terraform_output()
• infrahouse_toolkit.tests package
  • Submodules
  • infrahouse_toolkit.tests.test_timeout module
    • test_timeout()
  • Module contents

Submodules

infrahouse_toolkit.exceptions module

Top level exceptions.

The exception hierarchy repeats the structure of the infrahouse_toolkit package. Each module in the package has its own exceptions.py module. The module exceptions are inherited from the upper module exceptions.

exception infrahouse_toolkit.exceptions.IHException

Bases: Exception

Generic InfraHouse exception

exception infrahouse_toolkit.exceptions.IHRetriableError(returncode=None, cmd=None, output=None, stderr=None)

Bases: IHException

Operation failed, but can be retried.

infrahouse_toolkit.fs module

InfraHouse Toolkit file system module.

infrahouse_toolkit.fs.ensure_permissions(path: str, permissions: int)

For a path on the file system check permissions and set if they differ.

Parameters:

• path (str) – Filesystem path to a file or directory.

• permissions (int) – Permissions the file or directory must have. Can be an integer like 0o755 or 0o644.

infrahouse_toolkit.timeout module

InfraHouse Toolkit timeout module.

infrahouse_toolkit.timeout.timeout(seconds: int)

Timeout context manager.

Parameters:

seconds (int) – Max execution time in seconds.

Raises:

TimeoutError – when the code under a with is running more than seconds.

Module contents

Top-level package for InfraHouse Toolkit.

Author:

Oleksandr Kuzminskyi

Version:

2.59.3

Email:

aleks@infrahouse.com