Python Toolbox


genvid.toolbox.ExecutableNotInPathError Exception thrown when a file is not found in the path.
genvid.toolbox.ServiceIsNotRunningError Raise when a service is not running.
genvid.toolbox.HttpError An error from the Cluster API.

Basic Tools

genvid.toolbox.AWSTool A set of utilities to access and manipulate AWS cluster resources.
genvid.toolbox.BaseHttpApiTool This is the base class for the HTTP API.
genvid.toolbox.BaseTool Base class for all tools.
genvid.toolbox.ConsulTemplateTool A wrapper over consul-template that generates files from variables set in Consul, Vault, or from the environment.
genvid.toolbox.ConsulTool This class allows you to access different Consul services.
genvid.toolbox.DockerTool Handle manipulation of a Docker image archive.
genvid.toolbox.BastionAPI Client for the Bastion API.
genvid.toolbox.ClusterAPI Handles the communication with a cluster.
genvid.toolbox.JobsAPI The jobs api.
genvid.toolbox.LogsAPI The logs api.
genvid.toolbox.Clusters This class is used as a base class to manage clusters.
genvid.toolbox.HttpError An error from the Cluster API.
genvid.toolbox.SDK Common commands for setting up the SDK.
genvid.toolbox.NetworkTool Platform abstraction of network utilities.
genvid.toolbox.NomadTool A class for handling Nomad jobs.
genvid.toolbox.VaultTool A class for interfacing with Vault.

Services Base Tools

genvid.toolbox.ConsulService Base class for configuring the Consul service.
genvid.toolbox.NomadService Base Configuration of the Nomad service.
genvid.toolbox.ServiceInstaller Base class for installing all services.
genvid.toolbox.ServiceTool Base class for all services.
genvid.toolbox.VaultService Base Configuration of the Vault service.

Services Local Tools

genvid.toolbox.LocalService This class wraps a service to be run locally as a background process.
genvid.toolbox.LocalServiceInstaller Installer for the local services.

Services Linux Tools

genvid.toolbox.LinuxDockerService(**kwargs) A ServiceTool for configuring docker on a Linux server.
genvid.toolbox.LinuxConsulService(**kwargs) Configure Consul as a service on a Linux server.
genvid.toolbox.LinuxNomadService(**kwargs) Configure Nomad as a service on a Linux server.
genvid.toolbox.LinuxServiceInstaller(**kwargs) Install the supervisor services on a Linux server.
genvid.toolbox.LinuxVaultService(**kwargs) Configure Vault as a service on a Linux server.
genvid.toolbox.SystemdTool(**kwargs) Base ServiceTool for Linux servers under systemd.
genvid.toolbox.SystemdInstaller(**kwargs) Base ServiceInstaller for LinuxServiceInstaller under systemd.

Deprecated Tools


These modules have been deprecated. Although they still work for our oldest version, they aren’t expected to work with the new Bastion API.

genvid.toolbox.AllInOneTool Main tool for managing the all-in-one local environment for development.
genvid.toolbox.ClusterTool This class allows the configuration of a cluster.
genvid.toolbox.ConfigTool Manage Genvid configuration.
genvid.toolbox.EventsTool Tool that manages events configuration.
genvid.toolbox.ProjectTool Tool for managing project files.
genvid.toolbox.RuntimeTool Common tool for managing the different environments.
genvid.toolbox.TerraformTool Main tool for managing the cloud environment using Terraform.

The following classes have also been renamed (but an alias is still provided):