OPC Router Helm Chart Sample Project

A sample project for kubernetes deployment of the opc router with the helm chart.
OPC Router - Contact

About the Sample

Contents

• About the Sample
  • Contents
  • General Information
    • What is the sample doing?
• Getting Started
  • Prequisites
  • Installation
  • Uninstalling

General Information

This is a project sample for the opc router helm chart. It is for demonstrating how to deploy a opc router project from a git repository with the helm chart. Read more about the OPC Router Helm Chart here.

What is the sample doing?

• This sample is a fully functional OPC Router 5 project sample.
• It is a very simple project that will periodically write a file in the home directory of the docker container it is deployed in.
• The written file is a text file containing the string of an environment variable and a random number.
• The environment variable is declared in the config.yaml and initialized in the helm install command parameters.

Getting Started

Prequisites

• Kubernetes 1.12+
• Helm 3.1.0

Installation

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm has been set up correctly, add the repo as follows:

helm repo add opc-router https://opc-router.github.io/helm-charts

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages. You can then run helm search repo <alias> to see the charts.

You can now install this project on any kubernetes cluster using the helm chart with this command:

$ helm install my-opcrouter opc-router/opc-router \
  --set project.projectRepo=https://github.com/OPC-Router/helm-sample-project.git \
  --set project.projectPath=Sampleproject.rpe \
  --set project.configPath=config.yaml \
  --set envVars[0].Config="This is a random number: " \
  --set I_do_accept_the_EULA=true

This command will install the opc router with standard settings, as a service with a seperate mongodb container. The mongodb won't require authentification, which is not recommended. Accepting the End User License Agreement by setting I_do_accept_the_EULA to true is required for the OPCRouter to run.

Uninstalling

The chart with the name my-opcrouter can simply be uninstalled by executing:

$ helm uninstall my-opcrouter

However, keep in mind that the persitant volumes of the mongodb container don't get deleted by this. When reinstalling the chart under the same name you will have to use the previous mongodb root password and replica set key or delete the persistant volume beforehand.