Skip to content

Platform Configuration

When the platform deployment is completed, some post-install configuration update are required.

Production resources

The PunchPlatform team created a set of resource that you must set up to be production ready. The main purpose of these actions is to provide resources which use full platform logs in order to monitor Punchplatform in production.

From the root folder of the unzipped deployer (e.g. 'punchplatform-deployment-X.Y.Z'), the Elasticsearch and Kibana related resources are located at:

punchplatform-deployment-5.4.0
└── resources/
    ├── elasticsearch
    │   └── templates
    │       └── platform
    │           ├── pp_mapping_applications.json
    │           ├── pp_mapping_applicative_monitoring.json
    │           ├── pp_mapping_archive.json
    │           ├── pp_mapping_gateway.json
    │           ├── pp_mapping_metadata.json
    │           ├── pp_mapping_platform_health.json
    │           ├── pp_mapping_platform_logs.json
    │           ├── pp_mapping_platform_monitoring.json
    │           ├── pp_mapping_topology_metrics.json
    │           └── pp_monitoring_default_refresh.json
    └── kibana
        └── dashboards
            ├── archiving_monitoring
            │   └── archive_monitoring.ndjson
            ├── platform_monitoring
            │   └── platform_monitoring.ndjson
            ├── spark_monitoring
            │   └── spark_monitoring.ndjson
            └── tenants_monitoring
                └── tenants_monitoring.ndjson

Important

Before importing your custom Punch configuration to operator nodes, be sure to copy these resources into your configuration directory.

Import Punch configuration

Once your deployment is succeed, your operator nodes needs Punch configuration containing your channels and custom resources as well as the Punch provided resources to work properly.

You can do do that in different ways :

  • Manually copy your configuration to operator nodes
  • Git management
  • Post installation deployment through the Punch deployer

Here is the command to copy your Punch configuration thanks to Punch deployer :

punchplatform-deployer.sh --copy-configuration 

This is a post installation command so you have the same prerequisites as for a classic deployment before executing it

Elasticsearch Templates

Once your Punch configuration have been imported to operator nodes, you have now some Elasticsearch templates in your resources

The template mapping that you must load are the ones under the "platform" directory. They are needed to correctly insert the monitoring events generated by the PunchPlatform itself.

To do so, you can do it by hand using this command for each file:

$ curl -H "Content-Type: application/json" -XPUT localhost:9200/_template/mapping_metrics -d @mapping_metrics.json

Or you can load them all at once using the dedicated punchplatform-push-es-templates.sh command:

$ punchplatform-push-es-templates.sh --directory resources/elasticsearch/templates/platform --url http://localhost:9200 --verbose

Kibana Dashboards

Once your Punch configuration have been imported to operator nodes, you have now some Kibana dashboards in your resources

The PunchPlatform comes with already made custom Kibana dashboard to easily monitor your platform All these dashboards are available under the "dashboard" directory

To import the dashboards you can use this command-line:

punchplatform-setup-kibana.sh --import 

Or manually, follow these quick steps:

  1. Go to Kibana UI
  2. On the left-side panel, go to the "Management > Saved Objects > Import"
  3. Drag-n-drop or select the previous NDJSON file
  4. Go to the "Dashboard" tab and start exploring your dashboards !

You can get information about these dashboards here : Punch Dashboards