Giter Club home page Giter Club logo

razeedash's Introduction

Razeedash

Greenkeeper badge

Travis Build Status https://travis-ci.com/razee-io/razeedash

Razeedash is an app to manage deployments on Kubernetes

Requirements

  • Kubernetes CLI Tools
  • Kubernetes Cluster
  • razeedash-api
  • MongoDB
  • Register GitHub Application

Environment Varibles

Name Required Value Description
MONGO_URL Required - URL to your mongo instance
OAUTH_SECRET_KEY Optional - GitHub OAuth Secret Key
GITHUB_URL Optional https://github.com GitHub URL. Required if LOGIN_TYPE=ghe
GITHUB_API Optional https://api.github.com GitHub API URL. Required if LOGIN_TYPE=ghe
BUILD_ID Optional Travis build ID Travis Build ID
LAST_COMMIT_ID Optional GitHub commit hashcode git log --pretty=format:'%h' -n 1
LOGIN_TYPE Optional github Use local to enable local id/password logins. Use ghe for github enterprise instead of GitHub authentication

Register GitHub application

To use OAUTH authentication to GitHub you need to Register a new Github OAuth App Example registration for running locally.

Field Value
Name Local Razeedash Development
Description Local development
Homepage URL http://localhost:3000
User authorization callback URL http://localhost:3000/_oauth/github

Using GitHub enterprise for authentication

  • create the LOGIN_TYPE environment variable and set it to ghe. ex: LOGIN_TYPE="ghe"

  • create the GITHUB_URL environment variable and point it to your enterprise github url. ex: GITHUB_URL="github.your_company.com"

  • create the GITHUB_API environment variable and point it to your enterprise github url. ex: GITHUB_API="github.your_company.com/api/v3"

Enable email/password authentication

To use email/password authentication instead of GitHub authentication you need to create the LOGIN_TYPE environment variable and set it to local. If the environment variable is not set then you will only see the Sign in with GitHub option.

For password resets set a MAIL_URL variable as described here

Deploy components

Follow razeedash-api instructions to setup razeedash-api and MongoDB.

# Get latest release of razeedash and deploy
kubectl apply -f "https://github.com/razee-io/Razeedash/releases/latest/download/resource.yaml"

Check logs across pods using kc_logs.sh script from kube-cloud-scripts

kc_logs.sh razee razeedash 1m

Local Development

Requirements:

Install Packages

npm install

Local development with Minikube

local dev with minikube

NPM Commands

Name Description
npm install Install packages
npm start Run app
npm run lint Run lint ES6, yaml, json, docker and markdown
npm run eslint Fix common ES6 lint issues
npm run jsonlint Lint JSON files
npm run dockerlint Lint Dockerfile
npm run shlint Lint shell scripts
npm run markdownlint Lint markdown files
npm test Run unit tests
npm run test:local Run tests and watch for changes
npm run test:local:coverage Run tests, generate coverage and watch
npm run test:unit Run tests
npm run test:unit:coverage Run tests and generate coverage

razeedash's People

Contributors

dalehille avatar rmgraham avatar adamkingit avatar alewitt2 avatar jpapejr avatar greenkeeper[bot] avatar mckaymic avatar geoffcorey avatar dependabot[bot] 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.