Skip to content

Before You Start

How It Works

To deploy a punchplatform you need a deployer laptop or server and the target servers where you want to deploy your platform. The starting situation is illustrated next.

image

The punchplatform-deployer.sh tool is a punchplatform software tool delivered as part of the installation package. All you have to provide is a description of your target platform. I.e. what component you want to deploy on what server.

Running that tool is easy and fully automated. What is not automated and what is key for you to have is a clear idea of your design. Because the punchplatform (and its deployer) are extremely modular, you have a wide range of options from deploying a small one-node system up to a full-fledged giant clustered platform.

In short: make sure you go through the rest of this chapter before you start deploying. It will help you.

Configuration Management

To start with it is important to understand the punch configuration logic, and how users interact with the platform. The deployer helps you to create the working environment for the platform operators and user. An operator typically acts upon the platform through a few terminal command line utilities. It does that from a well identified administration server where these commands have been installed. This is depicted next where the yellow server is the one where the operator environment has been deployed:

image

These commands are of two kinds. The first two (punchplatform-getconf.sh and punchplatform-putconf.sh) let him save or load the per-tenant configuration folder.The other two let the user start or stop channels and services. To store the configuration, the punch relies on zookeeper. ZooKeeper is a centralized service for maintaining configuration information. Loading or saving the configuration is as simple as executing getconf and putconf:

image

At the very start, somebody has to create a new configuration tree for the tenant. Here is how it typically works: after the punch is deployed, there is no configuration defined. I.e. the deployer is not in charge of creating a tenant configuration. The platform is up and ready, but empty. It looks like this:

image

Somebody must therefore create the first configuration. This is typically a post-deployment operation. It can be done from the deployer machine as illustrated next:

image

The operator is then ready to go and use its platform.

Note

As you can see, it cannot be simpler. The punch design driver is to make deployment and operation as straightforward as possible.

Choose package

First, you can download a deployer package from the Punch website in the download area section.
Next, you should identify the right configuration package which fit to your need.

Deployer package

This option is the easiest to start with. This option lets you define your platform on your own. We recommend you use this with the punch expert service assistance.

Tip

These packages are meant to accelerate your deployment. For more details, do not hesitate contacting us at contact@punchplatform.com. We also we provide trainings to help your integrators during the installation.

Before you begin follow this OS specific setup

Docker Deployer package

Before you begin follow this Docker specific setup

Kubernetes Deployer package

Before you begin follow this Docker Kubernetes specific setup