Giter VIP home page Giter VIP logo

klb's Introduction

klb

Build Status

Nash library to mimic the life of @lborguetti (aka klb).

Ok, just kidding, use klb to automate the creation of your infrastructure on AWS or Azure.

Demo

asciicast

Dependencies

To aid you we provide some scripts to install the deps, per distro. For arch linux you can use:

sudo ./deps/arch.sh

Or for debian linux you can use:

sudo ./deps/debian.sh

Contributions for other distros are welcomed. The scripts can assume that Go is already installed, all the other dependencies will be installed automatically.

Install

Just run:

make install

To install klb on your NASHPATH.

Running with Docker

A neowaylabs/klb image is also provided with the project, saving you the hussle of installing the dependencies on your machine.

To create a fast nash shell where you can play around with klb you can run:

make shell

To enter the shell you need to export the required variables that will enable you to use klb. More details on getting your credentials and exporting them on your environment can be found bellow.

The image is ready to run nash scripts that import klb modules.

Updating vendored dependencies

make vendor

Testing

Just run make test.

For each cloud you'll need the environment variables. See the docs for each cloud to help you with each one.

Logging by default will be saved on files, since the tests can be pretty long running and you can check out the progress on the files.

Inside each test package the logs will be saved at ./testdata/logs.

To run redirecting logs to stdout:

Just run make test logger=stdout.

There are also examples that can be run automatically, to validate if they are working. Just run:

make test-examples

They are not included on the CI or the common tests because they take too much time to run, but it is a good way to validate that complex scenarios are working fine.

Docs

P.S.:

  • barefoot running is not implemented.

Cleanup

The automated tests strives to always cleanup ALL created resources. But sometimes it may fail to delete resources, it can happen even because of a intermitent cloud service failure.

If you want to be absolutely sure to delete all test resources created by klb run:

make cleanup

Do not worry, resources are just going to be deleted after you carefully check the list of resources and accept it, it won't go beserk deleting everything on your account.

klb's People

Contributors

katcipis avatar i4ki avatar lborguetti avatar lucianobfaustino avatar kamilash avatar matheusvill avatar vitorarins avatar leocbs avatar uisso avatar wilsonnalmeida avatar ppizarro avatar paulopizarro avatar thiagocaiubi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.