Installation and Administration

All you need to know to get your HPCC Systems up and running, and keep it running smoothly.

Installing & Running the HPCC Systems Platform

These instructions will guide you through installing and running the HPCC Systems Community Edition on a single node to start and then optionally, expand it to a larger cluster of nodes.

Release (v 8.10.6-1) View the PDF

Using WsSQL

WsSQL is a service that provides an SQL interface into HPCC Systems. This web service accepts a subset of prepared and standard SQL queries. Learn how to use WsSQL to get access to most HPCC Systems and published queries.

Release (v 8.10.6-1) View the PDF

Using Configuration Manager

This document covers configuring an HPCC Systems environment using the Configuration Manager, including Advanced View.

Release (v 8.10.6-1) View the PDF

HPCC Systems Administrator’s Guide

These instructions will guide you through installing and running the HPCC Systems Community Edition on a single node to start and then optionally, expand it to a larger cluster of nodes.

Release (v 8.10.6-1) View the PDF

Running HPCC Systems in a Virtual Machine

This outlines the system requirements and steps for installing and running an HPCC Systems platform on a single node inside a virtual machine.

Please Note: HPCC Systems 8.2.0 is the last release that will include a Virtual Machine image, which can be used under Oracle VM VirtualBox™ to bring up a single-node system in a virtual machine. More details of how to run the HPCC Systems platform on a local machine (for version 8.4.0, and forward) can be found here.

Release (v 8.2.0-1) View the PDF

HPCC Systems Preflight and Certification

This document provides steps you can use to certify your HPCC Systems environment. Use this procedure when you create a new HPCC Systems platform or after you make any changes or upgrades to the system. This will ensure that your system is functioning properly.

Release (v 8.10.6-1) View the PDF

HPCC Systems Monitoring and Reporting (Technical Preview)

This document describes the technical preview of the graphical monitoring and reporting components in the HPCC Systems platform.

As of 8.12.x, support for our Nagios/Ganglia Reporting and Monitoring plugin will be deprecated. The plugin will no longer be built or distributed. The installer packages for older versions of the plugin will continue to be available on our archive page. Standalone system monitoring via Ganglia/Nagios is not affected by this change. You can also choose to use other options, such as Prometheus, Grafana, or cloud-provided services.

Release (v 8.2.50) View the PDF

ROXIE: The Rapid Data Delivery Engine

This guide is an introduction to the Rapid Data Delivery Engine (ROXIE).

Release (v 8.10.6-1) View the PDF

ECL Watch

This document describes ECL Watch, an interface to the HPCC Systems platform that allows you to view information and interrogate nodes to confirm all expected processes are running. This provides a simple Web-based view into the system and a means to perform Workunit and data files maintenance.

Release (v 8.10.6-1) View the PDF

Dynamic ESDL

This manual covers Dynamic ESDL (Enterprise Service Description Language) –a methodology that helps you develop and manage web-based query interfaces quickly and consistently.

Dynamic ESDL takes an interface-first development approach. It leverages the ESDL Language to create a common interface “contract” that both ROXIE Query and Web interface developers will adhere to. It is intended to allow developers to create production web services, with clean interfaces that can evolve and grow over time without breaking existing applications.

Release (v 8.10.6-1) View the PDF

ESDL Language Reference

The ESDL Language Reference covers the ESDL (Enterprise Service Description Language) and its syntax. ESDL is a methodology that helps you develop and manage web-based query interfaces quickly and consistently. This goes hand-in-hand with Dynamic ESDL.

Release (v 8.10.6-1) View the PDF

Security Manager Plug-in Framework

The Security Manager Plug-in framework provides a mechanism for the creation and deployment of custom security manager plug-in implementations.

Release (v 8.10.6-1) View the PDF

Configure an HPCC Systems Cluster on AWS

Running an HPCC Systems cluster inside an Amazon Web Services (AWS) Elastic Cloud (EC2) allows you to instantiate and run HPCC Systems clusters of different sizes on the fly.

This is useful for:

  • Proof-of-concept
  • Experimentation
  • Learning
  • Leveraging the HPCC Systems platform without incurring cost of hardware and administration
  • Create and use an HPCC Systems cluster immediately without purchasing and installing new hardware

You can create a small cluster for small tasks or larger clusters for larger jobs. This flexibility allows you to match cost and processing power to the job at hand.

Temporary EC2 nodes allow you to “rent” computing capacity without long term commitments. In this manner, you pay as you go instead of incurring large fixed costs at the start. Keep in mind that you should terminate any unneeded instances to avoid paying for computing time you don’t need.

Release (v 8.10.6-1) View the PDF

System Requirements

The following system requirements cover what is needed to support the HPCC Systems Platform and ECL IDE included in the Community Edition.

View HTML

Red Book and Community Wiki

The HPCC Systems Community Wiki includes information provided by the community covering best practices, tips, sample code and examples. The HPCC Systems Red Book also contains useful information to help users manage the transition between releases.

View HTML