Introduction

the grapple cli

Version: 0.2.28

grpl

Usage:

grpl [command]

Commands:

i or install                Installation

c or cluster                Cluster commands

e or example                Example commands

v or version                List version

u or upgrade                Upgrade grpl

a or app or application     Initialize grpl application

*                           Help menu

Examples:

grpl i [commands]    or    grpl install [commands]

grpl c [commands]    or    grpl cluster [commands]

grpl e [commands]    or    grpl example [commands]

grpl v [commands]    or    grpl version [commands]

grpl u [commands]    or    grpl upgrade [commands]

grpl a [commands]    or    grpl app     [commands]    or    grpl application [commands]

grpl *

grpl application

Usage:

grpl application [command]

Commands:

i or init       Initialize new grpl application

*               Help menu

Examples:

grpl a i    or    grpl app init    or    grpl application init

grpl a *    or    grpl app *       or    grpl application *

grpl application init

Usage:

grpl application init [command]

Commands:

h or help     Help menu

*             to Initialize a grpl application

Examples:

grpl a i h    or    grpl app init help    or    grpl application init help

grpl a i *    or    grpl app init *       or    grpl application init *

Variables:

PROJECT_NAME=Name of the project

RESOURCE_TEMPLATE=Resource of the template

grpl cluster

Usage:

grpl cluster [command]

Commands:

s or status     Cluster status

i or install    Cluster installation

c or create     Cluster creation

*               Help menu

Examples:

grpl c s    or    grpl cluster status

grpl c i    or    grpl cluster install

grpl c c    or    grpl cluster create

grpl c *    or    grpl cluster *

grpl cluster create

Usage:

grpl cluster create [command]

Commands:

h or help     Help menu

*             to create cluster

Examples:

grpl c c h    or    grpl cluster create help

grpl c c *    or    grpl cluster create *

grpl cluster install

Usage:

grpl cluster install [command]

Usage with params from cli:

grpl cluster install --params --=

e.g grpl cluster install --params --GRAPPLE_VERSION=0.2.1

OR

grpl cluster install --params -- 

e.g grpl cluster install --params --GRAPPLE_VERSION 0.2.1

Usage with params from configfile:

grpl cluster install --configfile .json

e.g grpl cluster install --configfile grpl-config.json

Commands:

h or help     Help menu

*             to install cluster

Examples:

grpl c i h    or    grpl cluster install help

grpl c i *    or    grpl cluster install *

Variables:

TARGET_PLATFORM=CIVO / Kubernetes / minikube

# general configurations

GRAPPLE_VERSION = version of the grapple deployment (e.g. '0.2.0' or '0.2.1')

AUTO_CONFIRM='false' / 'true'

# kubernetes related configurations

KUBE_CONTEXT=kubernetes context

# minikube related configurations

# no additional configurations

# CIVO related configurations

CIVO_REGION=Available CIVO regions (e.g. FRA1)

CIVO_CLUSTER=CIVO cluster

CIVO_CLUSTER_ID=CIVO cluster ID

CIVO_MASTER_IP=CIVO cluster master IP address

CIVO_EMAIL_ADDRESS=email address of your CIVO account

grpl cluster status

Usage:

grpl cluster status [command]

Commands:

h or help     Help menu

*             to get cluster status

Examples:

grpl c s h    or    grpl cluster status help

grpl c s *    or    grpl cluster status *

grpl example

Usage:

grpl example [command]

Commands:

s or status     status of example

d or deploy     deploy an example

*               Help menu

Examples:

grpl e s    or    grpl example status

grpl e d    or    grpl example deploy

grpl e *    or    grpl example *

grpl example deploy

Usage:

grpl example deploy [command]

Commands:

h or help     Help menu

*             to get deploy example test-cases

Examples:

grpl e d h    or    grpl example deploy help

grpl e d *    or    grpl example deploy *

Variables:

example   all / db / dbfile

EDITION=grpl-basic-all / grpl-basic / grpl-basic-db / grpl-basic-dbfile

grpl example status

Usage:

grpl example status [command]

Commands:

h or help     Help menu

*             to get example status

Examples:

grpl e s h    or    grpl example status help

grpl e s *    or    grpl example status *

grpl resource

Usage:

grpl resource [command]

Commands:

d or deploy     to deploy a grpl template

r or render     to render a grpl template

*               Help menu

Examples:

grpl r d    or    grpl resource deploy

grpl r r    or    grpl resource render

grpl r *    or    grpl resource *

grpl resource deploy

Usage:

grpl resource deploy [command]

Usage with params from cli:

grpl resource deploy --params --=

e.g grpl resource deploy --params --GRAS_TEMPLATE=db-file

OR

grpl resource deploy --params -- 

e.g grpl resource deploy --params --GRAS_TEMPLATE=db-file

Usage with params from configfile:

grpl resource deploy --configfile .json

e.g grpl resource deploy --configfile grpl-config.json

Commands:

h or help     Help menu

*             to deploy grpl template

Examples:

grpl r d h    or    grpl resource deploy help

grpl r d *    or    grpl resource deploy *

Variable:

KUBECTL_CONTEXT: kubectl context you want to use e.g minikube, civo, etc

GRAS_NAME: name of the project

GRAS_TEMPLATE: gras template e.g db-file, etc

SOURCE_DATA: source of the data

DB_FILE_PATH: path where data is stored, default path is /data/db.json

DB_TYPE: db type it can either internal or external

ENABLE_GRUIM: to enable gruim, it can either be Yes or No

MODELS: input of models

RELATIONS: models relations

GRAS_NS: namespace to deploy gras, default ns is 'default'

grpl install

Usage:

grpl install [command]

grpl upgrade

Usage:

grpl upgrade [command]

Commands:

h or help     Help menu

*             to upgrade

Examples:

grpl u h    or    grpl upgrade help

grpl u *    or    grpl upgrade *

grpl version

Usage:

grpl version [command]

Commands:

h or help     Help menu

*             to get version details

Examples:

grpl v h    or    grpl version help

grpl v *    or    grpl version *