The Shipa Developer Hub

Welcome to the Shipa developer hub. You'll find comprehensive guides and documentation to help you start working with Shipa as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Shipa with Minikube

Minikube can also be used to quickly install Shipa and start deploying applications

📘

Minikube

Users can find detailed information on how to install Minikube by using link below:

https://kubernetes.io/docs/tasks/tools/install-minikube/

📘

Virtualbox

Virtualbox can be downloaded by using the following link:

Note: Ensure that Virtualbox is installed prior to executing the instructions below.

https://www.virtualbox.org/wiki/Downloads

After installing MiniKube and Virtualbox, it's time to get a cluster up and running by using the command below:

minikube start --kubernetes-version='v1.18.2' --memory='5gb' --disk-size='20gb' --driver=virtualbox

Once the cluster is running, download the Shipa Helm chart using the following command:

git clone https://github.com/shipa-corp/helm-chart.git

Access the downloaded folder and apply the Shipa Helm chart limits to your local cluster by using the following command:

kubectl apply -f limits.yaml

Next, update the chart dependencies by using the following command:

helm dep up

With dependencies updated, proceed to install Shipa by using the following command:

helm install shipa . \
--timeout=15m \
[email protected] \
--set=auth.adminPassword=shipa2020 \
--set=shipaCore.serviceType=ClusterIP \
--set=shipaCore.ip=10.100.10.20 \
--set=service.nginx.serviceType=ClusterIP \
--set=service.nginx.clusterIP=10.100.10.10

📘

Install process

Shipa installs its services in the default namespace of your local clusters.

To check its progress, run kubectl get pods.

Once the dashboard-web-1-x service is running, Shipa is ready to be used!

With Shipa installed and running, the next step is to add route to the ngnix ingress. To do this, use the following command:

sudo route -n add -host -net 10.100.10.10/32 $(minikube ip )

Now, add the route to the Traefik ingress:

sudo route -n add -host -net 10.100.10.20/32 $(minikube ip )

Once the route to ngnix and Traefik have been added, next add your local Shipa instance as a target to your Shipa CLI:

shipa target-add -s shipa-v101 10.100.10.10

📘

Shipa CLI Download

Users can download the Shipa CLI by using this link

Updated about a month ago

Shipa with Minikube


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.