KAPP

KAPP

  • Docs
  • API
  • Github
  • Help

›Getting Started

Getting Started

  • Getting Started with KAPP
  • Installation
  • Deploying Sample Application

Basic Tutorial

  • Basic Tutorial Overview
  • Creating an Application
  • Deploying
  • Scaling
  • Rollback

Guides

  • Using Ingress for HTTPS
  • Connecting to Google Cloud

FAQ

  • Features
  • Terminology
  • Permissions
  • Authorization

Installation

To get started with KAPP, you need a kubernetes cluster running version x.x.x or greater. For localhost development, install minikube, then execute the following instructions:

minikube start --memory 8192 --cpus 4  --kubernetes-version v1.15.0
minikube addons enable metrics-server

Download KAPP

Installation Script

The simplest way to install KAPP is through our installation script (which doesn't exist yet)

curl -L https://kapp.sh | sh - 

Install from source

Alternatively, you could install from source:

Clone the repository

git clone https://github.com/kapp-staging/kapp.git
cd kapp

(temp: select the latest dev branch)

git checkout --track origin/refactor-application-crd

Install the KAPP custom controller. From the root directory of the project:

make install
make run

Warning: this step will out put (make: *** [install] Error 1), which may make you believe the step has failed and you cannot proceed. Just ignore this Error and stuff probably still work.

This will start a foreground process running the controller. Open a new shell window for the next step.

Start the web API server:

cd api
go run .

This will start a (second) foreground process running the API server. Open a new shell window for the next step.

cd frontend

Create a .env file containing the url to the localhost API server.

cp .env.sample .env

Start the web client:

npm install
npm start

Warning 2: when you first load the browser, it may take an extremely long time(2-5minutes) to load. I believe this is the typescript compiling, and I have no idea why it takes so long. Just keep waiting, eventually the browser will load a page like this:

[screenshot]

At this time you should have the full stack KAPP running, containing 3 shell windows:

  1. First window running controller
  2. Second window running API server
  3. Third window running the web dev server

[screenshot]

Install authorization token

The following script (which doesn't exist) will install a token and output the secret to an environment variable $KAPP_LOGIN_TOKEN

./scripts/install-test-user.sh
echo $KAPP_TEST_TOKEN

Since the handy script doesn't exist, follow the directions in Create test service account.

Either way, once you obtain the token, paste it into the webapp

[screenshot]

Congratulations, KAPP is now running alongside your cluster.

Next, we will install a sample application onto your kuberentes cluster.

← Getting Started with KAPPDeploying Sample Application →
  • Download KAPP
    • Installation Script
    • Install from source
    • Install authorization token
KAPP
Docs
Getting StartedGuidesAPI Reference
Community
Stack OverflowProject ChatTwitter
More
GitHubStar
KAPP Open Source
Copyright © 2020 Your Name or Your Company Name