Setup VKPR
To be using the VKPR CLI, the user must have the Docker and Git installed in their local environment. It is used in certain formulas to structure the applications and create the local cluster.
Currently VKPR was specifically designed to be used in UNIX environments, so VKPR won't support being used in Windows distributions.
Installing VKPR CLI
VKPR was built on top of Ritchie, but he abstracts most of his interaction with him. To install it, you must run the following command.
curl -fsSL https://get.vkpr.net/ | bash
echo 'alias vkpr="rit vkpr"' >> ~/.bashrc # If you use another Unix Shell, specify your specific source
Running the above command will run a script that will install the following tools that are used in VKPR:
- kubectl: The Kubernetes command-line tool, allows you to run commands against Kubernetes clusters.
- helm: Helm helps you manage Kubernetes applications.
- k3d: k3d is a lightweight wrapper to run
k3s(Rancher Lab’s minimal Kubernetes distribution) in docker. - arkade: arkade provides a portable marketplace for downloading CLIs and installing helm charts.
- jq: jq is a lightweight and flexible command-line JSON processor.
- yq: yq is a lightweight and portable command-line YAML processor
- aws: The AWS Command Line Interface (AWS CLI) is a unified tool to manage your AWS services.
- okteto: gives you free access to secure Kubernetes namespaces, fully integrated with remote development capabilities.
We recommend updating the PATH so that you can use these tools from the command line.
export PATH=$HOME/.vkpr/bin:$PATH
We do not use local tools that have already been installed previously, VKPR is fully responsible for their structure and their necessary tools for use.
VKPR Structure
All VKPR binaries and utilities are installed in the home directory.
Its structure is separated as follows:
.vkpr
|_ bin # Application binaries directory
|__ tmp # Application temporary storage directory
|___ kubeconfig # Application cluster settings directory
|____ config # VKPR local infra config