hope

command module
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2024 License: MIT Imports: 1 Imported by: 0

README

Home OPErations

Hope is not a strategy

-- Unknown

But it can be your cluster management command line tool!

-- Me

Hope is a command line tool to manage small (and generally static) Kubernetes clusters. Hope offers tooling to manage the virtual machines that Kubernetes nodes run on, as well as managing their membership in the cluster. It also enables managing the resources in the cluster, with some simple parameter expansion that can be managed through a yaml file.

Topology Resources

Hope provides a somewhat pluggable interface for managing different hypervisors. Although pluggable, the only system implemented today is VMWare 6.7.

With these hypervisors, VMs can be created and destroyed, and generally be managed up to the point where they can be SSHed into.

Once SSH is available, VMs can be configured and added to clusters, or used to create fresh clusters.

Cluster Resources

Hope offers a simple templatable YAML structure that allows for different resources within the cluster to be managed.

Resources that can be managed include:

  • Kubernetes YAML resources, either by filename, or by inline YAML content within the configuration file.
  • The building and pushing of Docker images to a registry.
  • Tasks that attach to running jobs within the cluster, and wait for completion.
  • Tasks that execute commands within already running pods within the cluster.

Development

Hope uses Go 1.19, and requires staticcheck to be installed to run its linting/validation recipes:

go install honnef.co/go/tools/cmd/staticcheck@v0.4.2

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
pkg
fileutil
https://stackoverflow.com/a/56314145
https://stackoverflow.com/a/56314145
hope
Package utils -- Utility functions to be used throughout cmd.
Package utils -- Utility functions to be used throughout cmd.
scp
ssh

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL