tinklet

command module
v0.3.3 Latest Latest
Warning

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

Go to latest
Published: Jun 1, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

README

tinklet

Test and Build Code Coverage Go Report Card

⚠ This is a WIP as it is not a drop in replacement for tink-worker yet ⚠

tinklet is an implementation of the tinkerbell worker.

Notable Features

  • auth for multiple container registries
  • multiple client-side TLS options for communicating with Tink server
  • multiple backends [docker, kubernetes] for running workflow task actions

Usage

USAGE
  tinklet [flags] <subcommand>

SUBCOMMANDS
  docker  run the tinklet using the docker backend.
  kube    run the tinklet using the kubernetes backend.

FLAGS
  -config tinklet.yaml                       config file (optional)
  -identifier ...                            worker id (required)
  -loglevel info                             log level (optional)
  -registry {"Name":"","User":"","Pass":""}  container image registry (optional)
  -tink ...                                  tink server url (required)
  -tls false                                 tink server TLS (optional)

Design Philosophies

  1. prefer easy to understand over easy to do
  2. pkg packages do not log only return errors
  3. pkg is generic, reuseable code
  4. functions/methods should follow the single responsibility principle
  5. less code, less bugs
  6. prefer explicit over implicit
  7. avoid global/package level variables as much as possible

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
pkg

Jump to

Keyboard shortcuts

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