grpl cli Documentation – 0.2.145
Table of Contents
- 1. Introduction
- 2. grapple cli installation
- 3. grpl – 0.2.145
- 4. grpl application – 0.2.145
- 5. grpl cluster – 0.2.145
- 6. grpl example – 0.2.145
- 7. grpl resource – 0.2.145
- 8. grpl install – 0.2.145
- 9. grpl upgrade – 0.2.145
- 10. grpl version – 0.2.145
- 11. grpl dev – 0.2.145
- 12. grpl grapi – 0.2.145
- 13. grpl gruim – 0.2.145
- 14. grpl license – 0.2.145
1. Introduction
the grapple cli
2. grapple cli installation
brew tap grapple-solutions/grapple brew install grapple-cli
3. grpl – 0.2.145
Description:
Displays help menu of grpl cli
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 d or dev Devspace Dev doc Documentation grapi Grapi commands gruim Gruim commands * 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 d [commands] or grpl dev [commands] grpl grapi [commands] grpl gruim [commands] grpl doc [commands] grpl *
4. grpl application – 0.2.145
Description:
Displays help menu of 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 *
4.1. grpl application init
Description:
Initializes a new grapple application
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 AUTO_CONFIRM= 'false' / 'true' GITHUBTOKEN= Token to authenticate gh GRAPPLE_TEMPLATE= the grapple-template repository to clone (default grapple-solutions/grapple-template)
5. grpl cluster – 0.2.145
Description:
Displays help menu of grpl cluster
Usage:
grpl cluster [command]
Commands:
s or status Cluster status i or install Cluster installation p or patch Cluster patch c or create Cluster creation * Help menu
Examples:
grpl c s or grpl cluster status grpl c i or grpl cluster install grpl c p or grpl cluster patch grpl c c or grpl cluster create grpl c * or grpl cluster *
5.1. grpl cluster create
Description:
Creates cluster in specificed provider
Usage:
grpl cluster create [command]
Usage with params from cli:
grpl cluster create --params --<variable-name>=<variable value> e.g grpl cluster create --params --TARGET_PLATFORM=CIVO OR grpl cluster install --params --<variable-name> <variable value> e.g grpl cluster create --params --TARGET_PLATFORM=CIVO
Usage with params from configfile:
grpl cluster create --configfile <file-name>.json e.g grpl cluster create --configfile grpl-create-config.json
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 *
Variables:
Common Parameters:
TARGET_PLATFORM= CIVO / Kubernetes / minikube / Kubefirst
CLUSTER_NAME= name of the cluster
CIVO_API_KEY= civo api key (optional)
CIVO_REGION=Available CIVO regions (e.g. FRA1)
CIVO Parameters:
Notes:
* The '--create-firewall' will open the ports 80,443 and 6443 in the firewall if '--firewall-rules' is not used.
* The '--create-firewall' and '--existing-firewall' flags are mutually exclusive. You can't use them together.
* The '--firewall-rules' flag need to be used with '--create-firewall'.
* The '--firewall-rules' flag can accept:
* You can pass 'all' to open all ports.
* An optional end port using 'start_port-end_port' format (e.g. 8000-8100)
* An optional CIDR notation (e.g. 0.0.0.0/0)
* When no CIDR notation is provided, the port will get 0.0.0.0/0 (open to public) as default CIDR notation
* When a CIDR notation is provided without slash and number segment, it will default to /32
* Within a rule, you can use comma separator for multiple ports to have same CIDR notation
* To separate between rules, you can use semicolon symbol and wrap everything in double quotes (see below)
So the following would all be valid:
* "80,443,6443:0.0.0.0/0;8080:1.2.3.4" (open 80,443,6443 to public and 8080 just for 1.2.3.4/32)
* "80,443,6443;6000-6500:4.4.4.4/24" (open 80,443,6443 to public and 6000 to 6500 just for 4.4.4.4/24)
Flags:
-a, --applications string optional, use names shown by running 'civo kubernetes applications ls'
--cluster-type string optional, possible options: k3s,talos. (default "k3s")
-p, --cni-plugin string optional, possible options: flannel,cilium. (default "flannel")
-c, --create-firewall optional, create a firewall for the cluster with all open ports
-e, --existing-firewall string optional, ID of existing firewall to use
-u, --firewall-rules string optional, can be used if the --create-firewall flag is set, semicolon-separated list of ports to open (default "default")
-h, --help help for create
-m, --merge merge the config with existing kubeconfig if it already exists.
-t, --network string the name of the network to use in the creation (default "default")
-n, --nodes int the number of nodes to create (the master also acts as a node). (default 3)
-r, --remove-applications string optional, remove default application names shown by running 'civo kubernetes applications ls'
--save save the config
-s, --size civo size list -s kubernetes the size of nodes to create. You can list available kubernetes sizes by civo size list -s kubernetes (default "g4s.kube.medium")
--switch switch context to newly-created cluster
-v, --version string the k3s version to use on the cluster. Defaults to the latest. Example - 'civo k3s create --version 1.21.2+k3s1' (default "latest")
-w, --wait a simple flag (e.g. --wait) that will cause the CLI to spin and wait for the cluster to be ACTIVE
Global Flags:
--config string config file (default is $HOME/.civo.json)
-f, --fields string output fields for custom format output (use -h to determine fields)
-o, --output string output format (json/human/custom) (default "human")
--pretty Print pretty the json output
--region string Choose the region to connect to, if you use this option it will use it over the default region
-y, --yes Automatic yes to prompts; assume "yes" as answer to all prompts and run non-interactively
5.2. grpl cluster install
Description:
Installs grapple in specificed cluster
Usage:
grpl cluster install [command]
Usage with params from cli:
grpl cluster install --params --<variable-name>=<variable value> e.g grpl cluster install --params --GRAPPLE_VERSION=0.2.1 OR grpl cluster install --params --<variable-name> <variable value> e.g grpl cluster install --params --GRAPPLE_VERSION 0.2.1
Usage with params from configfile:
grpl cluster install --configfile <file-name>.json e.g grpl cluster install --configfile grpl-config.json
Usage with values yaml:
grpl cluster install --values <file1>.yaml <file2>.yaml e.g grpl cluster install --values config-values.yaml config-values2.yaml
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 / Kubefirst # general configurations GRAPPLE_VERSION = version of the grapple deployment (e.g. '0.2.0' or '0.2.1') AUTO_CONFIRM='false' / 'true' EMAIL = email ORGANIZATION = organization # kubernetes related configurations KUBE_CONTEXT=kubernetes context, if its set to currnet then it will use current kubectl 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_EMAIL_ADDRESS=email address of your CIVO account CIVO_API_KEY=api key of your CIVO account CLUSTER_IP= Cluster IP address KUBEFIRST_CLOUD_PROVIDER = cloud provider for kubefirst KUBEFIRST_CLOUD_REGION = cloud region of kubefirst cloud provider KUBEFIRST_CLUSTER_ID = cluster id of kubefirst cluster KUBEFIRST_CLUSTER_NAME = cluster name for kubefirst cluster GITHUB_USERNAME = github username GITLAB_USERNAME = gitlab username INSTALL_KUBEBLOCKS = 'true' / 'false', set to 'true' if you want to install kubeblocks
5.3. grpl cluster patch
Description:
Patches the cluster
Usage:
grpl cluster patch [command]
Commands:
h or help Help menu * to patch cluster
Examples:
grpl c p h or grpl cluster patch help grpl c p * or grpl cluster patch *
5.4. grpl cluster status
Description:
Displays status of the cluster
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 *
6. grpl example – 0.2.145
Description:
Displays help menu of 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 *
6.1. grpl example deploy
Description:
Deploys grapple example using specified template
Usage:
grpl example deploy [command]
Usage with params from cli:
grpl example deploy --params --<variable-name>=<variable value> e.g grpl example deploy --params --GRAS_TEMPLATE=db-file
Usage with params from configfile:
grpl example deploy --configfile <file-name>.json e.g grpl example deploy --configfile grpl-config.json
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:
GRAS_TEMPLATE: gras template e.g db-file, etc DB_TYPE: db type it can either internal or external KUBE_CONTEXT: kubectl context you want to use, if its set to current then it will use current kubectl context
6.2. grpl example status
Description:
Displays status of the grapple example deployment
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 *
7. grpl resource – 0.2.145
Description:
Displays help menu for 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 *
7.1. grpl resource deploy
Description:
Deploy a grapple resource with respect to specified gras template
Usage:
grpl resource deploy [command]
Usage with params from cli:
grpl resource deploy --params --<variable-name>=<variable value> e.g grpl resource deploy --params --GRAS_TEMPLATE=db-file OR grpl resource deploy --params --<variable-name> <variable value> e.g grpl resource deploy --params --GRAS_TEMPLATE=db-file
Usage with params from configfile:
grpl resource deploy --configfile <file-name>.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:
KUBE_CONTEXT: kubectl context you want to use, if its set to current then it will use current kubectl context 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 KUBE_NS: namespace to deploy gras, default ns is 'default' DATASOURCES: data sources configs DISCOVERIES: discoveries configs DATABASE_SCHEMA: database schema you want to use AUTO_DISCOVERY: to enable auto discovery
8. grpl install – 0.2.145
Description:
Displays help menu of grpl install
Usage:
grpl install [command]
9. grpl upgrade – 0.2.145
Description:
Displays help menu of 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 *
10. grpl version – 0.2.145
Description:
Displays help menu of 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 *
11. grpl dev – 0.2.145
Description:
Displays help menu for grpl dev
Usage:
grpl dev [command]
Commands:
h or help Help menu add Adds something to devspace.yaml analyze Analyzes a kubernetes namespace and checks for potential problems attach Attaches to a container build Builds all defined images and pushes them cleanup Cleans up resources completion Outputs shell completion for the given shell (bash or zsh) deploy Deploys the project enter Open a shell to a container init Initializes DevSpace in the current folder list Lists configuration logs Prints the logs of a pod and attaches to it open Opens the space in the browser print Prints displays the configuration purge Deletes deployed resources remove Removes devspace configuration render Builds all defined images and shows the yamls that would be deployed reset Resets an cluster token restart Restarts containers where the sync restart helper is injected run Executes a predefined command run-pipeline Starts a DevSpace pipeline set Sets global configuration changes sync Starts a bi-directional sync between the target container and the local path ui Opens the localhost UI in the browser update Updates the current config upgrade Upgrades the DevSpace CLI to the newest version use Uses specific config version Prints version of devspace ns to get namespace help menu ns <namespace> to set namespace for grapple enter grapi to enter grapi container enter gruim to enter grapi container
Flags:
–debug Prints the stack trace if an error occurs
–disable-profile-activation If true will ignore all profile activations
-h, –help help for devspace
–inactivity-timeout int Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
–kube-context string The kubernetes context to use
–kubeconfig string The kubeconfig path to use
-n, –namespace string The kubernetes namespace to use
–no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
–no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
–override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, –profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
–silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, –switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
–var strings Variables to override during execution (e.g. –var=MYVAR=MYVALUE)
-v, –version version for devspace
Examples:
grpl dev h or grpl dev help grpl dev grpl dev add grpl dev analyze grpl dev attach grpl dev build grpl dev cleanup grpl dev completion grpl dev deploy grpl dev enter grpl dev init grpl dev list grpl dev logs grpl dev open grpl dev print grpl dev purge grpl dev remove grpl dev render grpl dev reset grpl dev restart grpl dev run grpl dev run-pipeline grpl dev set grpl dev sync grpl dev ui grpl dev update grpl dev upgrade grpl dev use grpl dev version grpl dev ns grpl dev ns grapple-namespace grpl dev enter grapi grpl dev enter gruim
12. grpl grapi – 0.2.145
Description:
Displays help menu for grpl grapi
Usage:
grpl grapi [command]
Commands:
h or help Help menu grapi migrate-db to migrate db grapi --help to get list of grapi commands grapi <any command> to run any grapi command
Examples:
grpl grapi h or grpl grapi help or grpl grapi grpl grapi migrate-db grpl grapi --help grpl grapi <any comamnd>
13. grpl gruim – 0.2.145
Description:
Displays help menu for grpl gruim
Usage:
grpl gruim [command]
Commands:
h or help Help menu gruim rebuild to rebuild gruim gruim --help to get list of gruim commands gruim <any command> to run any gruim command
Examples:
grpl gruim h or grpl gruim help or grpl gruim grpl gruim rebuild grpl gruim --help grpl gruim <any comamnd>
14. grpl license – 0.2.145
Description:
Displays help menu of grpl license
Usage:
grpl license [command]
Commands:
h or help Help menu i or install to install license r or remove to remove license s or status to get license status
Examples:
grpl l h or grpl lic h or grpl license help grpl l i or grpl lic i or grpl license install grpl l r or grpl lic r or grpl license remove grpl l s or grpl lic s or grpl license status
14.1. grpl license install
Description:
Displays help menu of grpl license install
Usage:
grpl license install [command]
Commands:
h or help Help menu * to install license
Examples:
grpl l i h or grpl lic i h or grpl license install help grpl l i or grpl lic i or grpl license install
14.2. grpl license remove
Description:
Displays help menu of grpl license remove
Usage:
grpl license remove [command]
Commands:
h or help Help menu * to remove license
Examples:
grpl l i h or grpl lic i h or grpl license install help grpl l r or grpl lic r or grpl license remove
14.3. grpl license status
Description:
Displays help menu of grpl license status
Usage:
grpl license status [command]
Commands:
h or help Help menu * to get license status
Examples:
grpl l i h or grpl lic i h or grpl license install help grpl l s or grpl lic s or grpl license status