On-Premise Deployment with Kubernetes

This guide will assist you in deploying the Proxus IIoT platform on-premise using Kubernetes.

Prerequisites

Before beginning, make sure you have the following installed:

• kubectl: This is the Kubernetes command-line tool that allows you to run commands against Kubernetes clusters. You can find installation instructions in the official documentation.

• A Kubernetes Cluster: You need an accessible Kubernetes cluster. For local development and testing, you can use Minikube or kind.

Download Kubernetes Configuration Files

The necessary Kubernetes configuration files are located in the ks8 directory. To download them, execute the following commands:

BASE_URL="https://raw.githubusercontent.com/proxusiiotplatform/docs/main/k8s/" FILES=("config-persistentvolumeclaim.yaml" "pod-reader-role.yaml" "proxus-api-deployment.yaml" "proxus-api-service.yaml" "proxus-db-volume-persistentvolumeclaim.yaml" "proxus-server-deployment.yaml" "proxus-server-service.yaml" "proxus-ui-claim1-persistentvolumeclaim.yaml" "proxus-ui-deployment.yaml" "proxus-ui-service.yaml" "timescaledb-deployment.yaml" "timescaledb-service.yaml") for file in "${FILES[@]}"; do wget "${BASE_URL}${file}" done

Deploying Proxus IIoT Platform

Once you have all the necessary Kubernetes configuration files, follow these steps:

1. Navigate to the directory containing the Kubernetes configuration files.

2. Apply the Kubernetes configurations to create the necessary Deployments, Services, and Ingress (if required):

kubectl apply -f

Accessing the Proxus IIoT Platform

After deploying, you can access the platform using the external IP or domain configured in the Ingress. If an Ingress was not set up, you can usekubectlto port-forward the services to your local machine:

kubectl port-forward service/proxus-ui 8080

Restarting Services in Kubernetes

Sometimes you may need to restart services in your Kubernetes cluster to apply configuration changes or update the running images. Kubernetes does not have a directrestartcommand, but you can achieve this by deleting the pods and letting the deployment recreate them.

Restarting All Services

To restart all services and force a rollout, you can use the following command:

kubectl rollout restart

This command will trigger a rolling update for all deployments in the current namespace. If you want to restart services in a specific namespace, add the-nor--namespaceflag followed by the name of the namespace.

Restarting a Specific Service

To restart a specific service, identify the deployment managing the service and restart it:

kubectl rollout restart

Replace<deployment-name>with the name of the deployment you wish to restart. This will ensure that all associated pods are gracefully terminated and new ones are started with the updated configuration or image.

Now, you can access the platform by opening a web browser and navigating to http://localhost:8080.

Updating Proxus IIoT Platform

To update your deployment:

1. Download the latest Kubernetes configuration files from the Proxus IIoT GitHub repository.

2. Apply the new configuration files:

kubectl apply -f

Kubernetes will perform a rolling update to your deployments.

Backup and Restore Procedures

For backup and restore procedures, you will need to use Kubernetes volumes and potentially a database backup tool compatible with your database solution.

Backup

To backup data, you might usekubectl cpto copy data from your pods to a local directory or use your database's native backup tools.

Restore

To restore data, you might usekubectl cpto copy data from your local directory to your pods or use your database's native restore tools.

Troubleshooting

If you encounter any issues:

• Check the pod status:

kubectl get

• Review logs for specific pods:

For further assistance, consult the Proxus IIoT platform's documentation or support channels.