inspr

module
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2021 License: MIT

README ΒΆ


Inspr is an engine for running distributed applications, using multiple communication patterns such as pub sub and more, focused on type consistency and development simplicity.

  • πŸ’ͺ Robust: built on top of golang, kubernetes and other state of the art technologies
  • ✨ Distributed: created to allow complex and hierarchical distributed design patterns
  • ☁ Cloud native: lightweight and modular, built with interchangeable pieces
  • πŸ›  Versatile: can adapt to any cloud environment

Table of Contents

πŸŽ‰ Getting Started

Cluster

The recommended way to install inspr in a kubernetes cluster is by using helm.

the first step is add the helm chart repository to the cluster:

helm repo add inspr https://inspr-charts.storage.googleapis.com

Then install inspr with the command:

helm install inspr_name inspr/insprd

replacing inspr_name by the desired inspr cluster name.

Aditionaly you can check the default values file for the helm chart. They are included in the build/helm folder and can be edited for further refinement of the properties.

CLI

To install the CLI get the latest release for your architecture from the releases page and add it to your PATH. TODO: Add link to the install script for the CLI.

Documentation

The full documentation for Inspr can be found on our website. The source for the Inspr documentation and website is hosted on a separate repo, @inspr/docs.

Architecture

  • TBD

πŸ‘ Contributing

The main purpose of this repository is to continue evolving Inspr core. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. To contribute, please check out our guide.

πŸ“„ License

  • Inspr is licenced under MIT license.
  • Inspr documentation is Creative Commons licensed, as found in the license-docs file.

πŸ“£ Contact

To contact us, please join our Discord community. Aditionally we are at Reddit

Directories ΒΆ

Path Synopsis
cmd
insprd/memory
Package memory provides simple interfaces for the in memory management of the cluster.
Package memory provides simple interfaces for the in memory management of the cluster.
docs
cli
examples
pkg
cmd
rest
Package rest contains the functions that make it easier to manager api handler functions
Package rest contains the functions that make it easier to manager api handler functions
utils
Package utils has a number of useful operations that are used in multiple places of the inspr packages, contains operations such as: - go-cmp: "comparators and evaluator for slices and maps" - string_slice: "set of operations of custom string slice"
Package utils has a number of useful operations that are used in multiple places of the inspr packages, contains operations such as: - go-cmp: "comparators and evaluator for slices and maps" - string_slice: "set of operations of custom string slice"

Jump to

Keyboard shortcuts

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