Docker

Installation#

Kupboard can be run in any environment where Docker runtime is installed.

Pull kupboard container image#

You can pull the container image with the command below.

$ docker pull kupboard/kupboard

Run kupboard container#

If the kupboard container is pulled properly, you should see the following results when using the docker run command.

$ docker run --rm -it kupboard/kupboard

 ___   _  __   __  _______  _______  _______  _______  ______    ______
|   | | ||  | |  ||       ||  _    ||       ||   _   ||    _ |  |      |
|   |_| ||  | |  ||    _  || |_|   ||   _   ||  |_|  ||   | ||  |  _    |
|      _||  |_|  ||   |_| ||       ||  | |  ||       ||   |_||_ | | |   |
|     |_ |       ||    ___||  _   | |  |_|  ||       ||    __  || |_|   |
|    _  ||       ||   |    | |_|   ||       ||   _   ||   |  | ||       |
|___| |_||_______||___|    |_______||_______||__| |__||___|  |_||______|
v0.9.0

01:54:32.150 KBD ▶ INFO  [Configuration : kupboard]
01:54:32.150 KBD ▶ INFO   version: v0.1
01:54:32.150 KBD ▶ INFO   company: atopcloud
01:54:32.150 KBD ▶ INFO   name: hello kupboard


kupboard is a root command for managements of the Kupboard platform.

Usage:
  kupboard [flags]
  kupboard [command]

Available Commands:
  build       Build application containers
  kollection  Deploy applications and install packages
  deploy      Deploy services on target clusters
  help        Help about any command
  setup       Initialize target clusters
  ssh         ssh connection to a target host

Flags:
      --config string   config file (default "kupboard")
      --debug           enable debug
  -e, --envvar string   ansible envvars
  -h, --help            help for kupboard
      --hide-log        diable logging
      --hide-logo       hide kupboard logo

Use "kupboard [command] --help" for more information about a command.

Bash script for running kupboard (Recommended)#

Instead of using docker run to run the kupboard container, you can use bash script below, which is much simpler.

#!/bin/bash
docker run --rm -it kupboard/kupboard "$@"

This is an example of using the bash script to run kupboard.

$ kupboard setup --init-user

Servers#

Now we need to prepare servers for installation of a cloud native environment with the kupboard commands.

note

Kupboard is basically not dependent on IaaS. It can be deployed on any IaaS platform, such as AWS, GCP, Azure and so on, including bare-metal.