Reemote Documentation

Reemote is a Python API for task automation, configuration management and application deployment. You can use Reemote to install and configure software on multiple servers.

This example manages apk package versions on all servers in an inventory.

Contents:

• Installation
  • Install from PyPI
• Examples
  • Hello World CLI Example
  • Hello World GUI Example
  • Make Directory API Example
  • Get Facts Example
  • Read and Write Files Example
  • Make Directory GUI Example
  • Hello World API Example
  • Installing vim on Alpine API Example
• Inventory
  • Specifying the ssh connection
  • Using an inventory file
• Deployment
  • Deployment files
• Using the Reemote GUI
  • Starting the GUI
  • Inventory
  • Deployment Manager
  • Ad-hoc commands
  • File Manger
  • Package Manager
• Using the Reemote CLI
  • The Reemote CLI
  • Ad-hoc commands with reemote
  • Running operations
• Tutorial
  • Order of execution
  • Delarative and Idempotent operation
  • Reemote does not wrap shell commands
  • Reemote does not execute in phases
  • Reemote facts
  • Reemote is composable
  • Callbacks
• Creating files and directory structures on the server
• Facts and Operations
  • Facts
  • Commands
  • Operations
  • Deployments
• Commands
  • apk commands
  • apt commands
  • dnf commands
  • dpkg commands
  • pacman commands
  • pip commands
  • pipx commands
  • yum commands
  • zypper commands
• Operations
  • apk operations
  • apt operations
  • dnf operations
  • dpkg operations
  • builtin operations
  • filesystem operations
  • pacman operations
  • pip operations
  • pipx operations
  • scp operations
  • server operations
  • sftp operations
  • users operations
  • yum operations
  • zypper operations
• Facts
  • apk facts
  • apt facts
  • command facts
  • dnf facts
  • dpkg facts
  • inventory facts
  • lxc facts
  • pacman facts
  • pip facts
  • pipx facts
  • server facts
  • sftp facts
  • yum facts
  • zypper facts
• Deployments
  • file deployments
  • lxc deployments
  • nginx deployments
  • rust deployments
• Callbacks
  • progress callbacks
• utilities
  • read_inventory()
  • verify_python_file()
  • generate_grid()
  • generate_table()
  • convert_to_aggrid()
  • verify_source_file_contains_valid_class()
  • get_classes_in_source()
  • TemplateRenderer
  • verify_inventory_connect()
  • validate_list_of_strings()
  • make_inventory()
  • validate_inventory_file_and_get_inventory()
  • produce_output_table()
  • produce_grid()
  • produce_output_grid()
  • generate_grid()
  • generate_table()
  • convert_to_tabulate()
  • safe_convert()
  • produce_table()
  • validate_root_class_name_and_get_root_class()
  • write_responses_to_file()
  • add_localhost_to_known_hosts()
  • validate_inventory_structure()
  • convert_to_df()
  • produce_json()
  • parse_kwargs_string()