Users can install Shipa on any existing Kubernetes cluster (version 1.10.x and newer), and Shipa leverages Helm charts for the install.
Below are the steps required to have Shipa installed in your existing Kubernetes cluster:
1. Create a namespace where the Shipa services should be installed
NAMESPACE=shipa-system
kubectl create namespace $NAMESPACE
2. Create the values.override.yaml with the Admin user and password that will be used for Shipa
Admin Password
Shipa requires you to use a minimum password length of 7 or more characters.
cat > values.override.yaml << EOF
auth:
adminUser: admin-email-here
adminPassword: admin-password-here
EOF
3. Add Shipa helm repo
helm repo add shipa-charts https://shipa-charts.storage.googleapis.com
4. Install Shipa
helm install shipa shipa-charts/shipa -n $NAMESPACE --timeout=1000s -f values.override.yaml
Static vs Dynamic IPs
By default, during the install, Shipa uses dynamic public IP set by the cloud provider. If preferred, static IP can be used instead by applying the optional parameter below when using Helm install:
--set service.nginx.loadBalancerIP=
The output of the install should look like the following:
NAME: shipa
LAST DEPLOYED: <Deployment Date>
NAMESPACE: shipa-system
STATUS: deployed
REVISION: 1
Install time
After running the Helm install command, the install process will take several minutes, depending on the Cluster Node configuration.
During this process, containers will be created and restarted until all Shipa related services are running successfully.
Install completion
When you see the Shipa Dashboard service running, which should be called dashboard-web-1-x, the install is complete.
Uninstalling shipa
helm uninstall shipa uninstalls shipa except it leaves out MongoDB persistence volume claim so users can take a backup of the previous installation.
If you are creating a new installation on the same cluster and namespace used by the previous shipa installation, please delete persistence volume claims leftover by previously uninstalled shipa instance.
Updated 7 days ago