kit

module
Version: v0.0.0-...-e689ca2 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2021 License: MIT

README

Kolide Kit GoDoc

Kolide Kit is a collection of Go libraries used in projects at Kolide. This repository also includes a few other features which are useful for Go developers:

  • A lightweight style guide
  • Links to libraries which are commonly used at Kolide
  • Links to learning resources outlining some Go best practices

Install

git clone git@github.com:kolide/kit.git $GOPATH/src/github.com/kolide/kit

Documentation

Run godoc -http=:6060 and then open http://localhost:6060/pkg/github.com/kolide/kit/ in your browser. You'll see all the available packages in this repository.

Style Guide

You will also be able to find Kolide's Go style guide at styleguide.md. We write a lot of Go at Kolide and we like talking about how we can all write better, more consistent Go. In our style guide, we've amalgamated the results of numerous internal discussions and agreed upon best approaches.

Git and Dependency Workflow

Our development and dependency management workflow is outlined in workflow.md. At a high-level, we use glide most of the time, but we use dep for newer projects. Our git workflow has us using forks and feature branches extensively.

Directories

Path Synopsis
contexts
uuid
Package uuid provides helpers for propagating UUIDs across services.
Package uuid provides helpers for propagating UUIDs across services.
Package dbutil provides utilities for managing connections to a SQL database.
Package dbutil provides utilities for managing connections to a SQL database.
Package entrypoint replaces the shell version of exec $@ which is often use when creating docker entrypoint scripts to wrap a binary with some initial setup.
Package entrypoint replaces the shell version of exec $@ which is often use when creating docker entrypoint scripts to wrap a binary with some initial setup.
Package env provides utility functions for loading environment variables with defaults.
Package env provides utility functions for loading environment variables with defaults.
Package fs provides filesystem-related functions.
Package fs provides filesystem-related functions.
Package health adds methods for checking the health of service dependencies.
Package health adds methods for checking the health of service dependencies.
Package httputil provides utilities on top of the net/http package.
Package httputil provides utilities on top of the net/http package.
package instrumentation providies utilities for instrumenting Go code.
package instrumentation providies utilities for instrumenting Go code.
Package logutil has utilities for working with the Go Kit log package.
Package logutil has utilities for working with the Go Kit log package.
Munemo is a reversible numeric encoding library.
Munemo is a reversible numeric encoding library.
Package pgutil provides utilities for Postgres
Package pgutil provides utilities for Postgres
Package testutil provides utilities for use in tests.
Package testutil provides utilities for use in tests.
Package tlsutil provides utilities on top of the standard library TLS package.
Package tlsutil provides utilities on top of the standard library TLS package.
Package version provides utilities for displaying version information about a Go application.
Package version provides utilities for displaying version information about a Go application.

Jump to

Keyboard shortcuts

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