# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

CopyFile copies a file to the remote host.
CreateDirectory creates the directory and sets owner permissions.
CreateOrUpdateUser takes an wanted user specification and creates or updates a user to the specification.
CreateUser takes a context, transport, and user and creates the user on the remote machine.
DeleteFile deletes a file on the remote host, retrying if necessary.
Download downloads a file on a remote machine with enos-flight-control, retrying if necessary.
FindUser attempts to find details about a user on a remote machine.
InstallFlightControl installs the enos-flight-control binary on a remote host in an idempotent fashion.
NewCopyFileRequest takes functional options and returns a new file copy request.
NewCreateDirectoryRequest takes functional options and returns a new directory.
NewDeleteFileRequest takes functional options and returns a new file deletion request.
NewDownloadRequest takes functional options and returns a new download request.
NewInstallFlightControlRequest takes functional options and returns a new install request.
NewPackageInstallRequest takes functional options and returns a new script run req.
NewRunScriptRequest takes functional options and returns a new script run req.
NewTargetRequest takes optional arguments and returns a new instance of TargetRequest.
NewUnzipRequest takes functional options and returns a new unzip request.
NewUser takes functional options and returns a new user.
PackageInstall copies the script to the remote host, executes it, and cleans it up.
PackageInstallInstallerForFile attempts to determine a suitable package installation method given the file name.
RunScript copies the script to the remote host, executes it, and cleans it up.
TargetArchitecture is a helper that determines the targets architecture.
TargetDistro is a helper that determines the targets distribution.
TargetDistroVersion is a helper that determines the targets distribution version.
TargetHomeDir is a helper that determines the targets HOME directory.
TargetHostInfo is a helper that determines the targets host information.
TargetHostname is a helper that determines the targets hostname.
TargetPlatform is a helper that determines the targets platform.
TargetPlatformVersion is a helper that determines the targets platform version.
TargetProcessManager is a helper that determines the targets process manager.
Unzip unzips an archive on a remote machine with enos-flight-control.
WithCopyFileChmod sets permissions.
WithCopyFileChown sets ownership.
WithCopyFileContent sets content to be copied.
WithCopyFileDestination sets file destination.
WithCopyFileRetryOptions sets retry options for file copy operations.
WithCopyFileTmpDir sets temporary directory to use.
WithDeleteFilePath sets which file to delete for file delete operations.
WithDeleteFileRetryOptions sets retry options for file delete operations.
WithDirChown sets directory name.
WithDirName sets directory name.
WithDownloadRequestAuthPassword sets basic auth password.
WithDownloadRequestAuthUser sets basic auth user.
WithDownloadRequestDestination sets destination path of the downloaded file.
WithDownloadRequestFlightControlPath sets the location of the enos-flight-contro binary.
WithDownloadRequestHTTPMethod sets the download HTTP method.
WithDownloadRequestMode sets the mode for the downloaded file.
WithDownloadRequestReplace determines if the download command should replace existing files.
WithDownloadRequestRetryOptions sets retry options for dowload operation.
WithDownloadRequestSHA256 sets required SHA256 sum.
WithDownloadRequestURL sets the download drL.
WithDownloadRequestUseSudo determines if the download command should be run with sudo.
WithInstallFlightControlRequestPath sets the install path.
WithInstallFlightControlRequestTargetRequest sets the target request.
WithInstallFlightControlRequestUseHomeDir installs enos-flight-control into the home directory.
WithPackageInstallCopyPath sets get location of an artifact that is being copied from the local machine.
WithPackageInstallDestination sets final destination for binaries.
WithPackageInstallDownloadOpts sets the package download options.
WithPackageInstallGetter sets the package install get.
WithPackageInstallInstaller sets the package installer.
WithPackageInstallTemporaryDirectory sets the temporary directory.
WithPackageInstallUnzipOpts sets the package unzip options.
WithRunScriptChmod sets permissions.
WithRunScriptChown sets ownership.
WithRunScriptContent sets content to be copied.
WithRunScriptDestination sets file destination.
WithRunScriptEnv sets the environment variables.
WithRunScriptNoCleanup disable the auto cleanup.
WithRunScriptTmpDir sets temporary directory to use.
WithRunScriptUseSudo runs the script with sudo.
WithTargetRequestRetryOpts allows the caller to define retry options.
WithUnzipRequestCreateDestinationDir determines if the destination directory should be created.
WithUnzipRequestDestinationDir sets the unzip directory.
WithUnzipRequestDestinationDirMode sets the mode for destination directory if it is created.
WithUnzipRequestFileMode sets the mode for files that are expanded.
WithUnzipRequestFlightControlPath sets the location of the enos-flight-contro binary.
WithUnzipRequestReplace determines if the unzip command should overwrite the destination file if it exists.
WithUnzipRequestSourcePath sets the zip archive source path.
WithUnzipRequestUseSudo determines if the unzip command should be run with sudo.
WithUserGID sets the user gid.
WithUserHomeDir sets the home dir.
WithUserName sets the user name.
WithUserShell sets the user shell.
WithUserUID sets the user uid.
WrapErrorWith returns a custom error message.

# Constants

DefaultFlightControlPath is the default location of our binary.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrPackageInstallGetterUnknown means the package get has not been set.
ErrPackageInstallGetterUnsupported means the package get is unsupported not been set.
ErrPackageInstallInstallerUnknown means the package method has not been set.
ErrPackageInstallInstallerUnsupported means the package method is unsupported.
Package install gets.
Package install gets.
Package install gets.
Package install gets.
Package install methods.
Package install methods.
Package install methods.
Package install methods.
Package install methods.

# Structs

CopyFileRequest copies a file to the remote host.
CreateDirectoryRequest creates a directory on remote host.
DeleteFileRequest deletes a file on the remote host.
DownloadRequest performs a remote flight control download.
DownloadResponse is a flight control download response.
HostInfo represents information about the target host.
InstallFlightControlRequest is a flight control install request.
InstallFlightControlResponse is a flight control install response.
PackageInstallGetter is where the package is coming from.
PackageInstallInstaller is how a package is going to be installed.
PackageInstallRequest is a request to install a package on a target machine.
PackageInstallResponse is the response of the script run.
RunScriptRequest copies a file to the remote host.
RunScriptResponse is the response of the script run.
TargetRequest is a Target* request.
UnzipRequest performs a remote flight control unzip.
UnzipResponse is a flight control unzip response.
User is a system user.

# Interfaces

GetLogsResponse interface defining the functions required for any get logs request response.

# Type aliases

CopyFileRequestOpt is a functional option for file copy.
CreateDirectoryRequestOpt is a functional option for creating directory.
DeleteFileRequestOpt is a functional option for file deletion.
DownloadOpt is a functional option for an download request.
InstallFlightControlOpt is a functional option for an install request.
No description provided by the author
No description provided by the author
PackageInstallRequestOpt is a functional option for running a script.
RunScriptRequestOpt is a functional option for running a script.
TargetRequestOpt is a functional option for a new Target.
UnzipOpt is a functional option for an unzip request.
UserOpt is a functional option for an user request.