Installing and Using the apcera-install Tool

The Apcera Installer CLI tool (apcera-install) provides an easy way to quickly deploy Apcera Platform. It behaves as a wrapper for Terraform and Orchestrator tools to provision cloud infrastructure and deploy an Apcera Platform cluster.

NOTE: The apcera-install tool is currently available as a beta release and is not recommended for deploying Apcera Platform in a production environment. For production-grade deployments you should follow the standard Terraform deploy process using Apcera-provided Terraform scripts and cluster configuration files. See Installing Apcera Platform for more information.

Requirements for installing Apcera using the apcera-install tool

To run the apcera-install tool and install the Apcera Platform, we require the following:

  • Linux, Mac OS 10.7 or later, or Windows 64-bit
  • 16GB system RAM recommended (to install the platform locally)
  • Direct (non-proxied) connection to the internet
  • 12 GB free disk space
  • Standard IPv4 addressing (IPv6 is not supported at this time)

Downloading the apcera-install tool

To download the apcera-install tool, go to https://www.apcera.com/download to download the apcera-install tool for your platform: Linux, Mac OS X, or Windows 64-bit.

  • The file apcera-install-linux-latest.zip is for Linux 64-bit and includes the apcera-install binary file, CHANGELOG.md, and README.md.
  • The file apcera-install-darwin-latest.zip is for Mac OS X and includes the apcera-install binary file, CHANGELOG.md, and README.md.
  • The file apcera-install-win64-latest.zip is for Windows 64-bit and includes the apcera-install.exe binary file, CHANGELOG.md, and README.md.

Installing the apcera-install tool

To install the apcera-install tool:

  • Create a working directory on your local file system called apcera-install.
  • Extract the contents of the file apcera-install-<OS>-latest.zip that you downloaded to your working directory.

To run the apcera-install tool, you execute the binary file from the same directory where it is installed. In the instructions this is called your working directory.

On Unix-based systems, the current working directory is not in the $PATH by default. If you are using Mac or other Unix-based systems, you need to explicitly specify the working directory to run the tool.

For example: $ export PATH=$PATH:/Users/username/apcera-install (while your working directory is /Users/username/apcera-install).

Running the apcera-install tool

To run the tool:

  • Launch a terminal or command prompt session.
  • Change directory (cd) to your working directory (where you downloaded the apcera-install tool).
  • Run the command apcera-install --help and review the tool usage.
    For example, on Mac you run the command $ ./apcera-install --help from the same directory where the apcera-install tool is located.
  • If you cannot run the tool, see troubleshooting.

Tool usage

The apcera-install tool is used to configure, install, and manage Apcera Platform.

Syntax

  apcera-install [command]
  apcera-install [flags]

Commands

  apply         Builds or changes infrastructure
  config        Configure all apcera-install cluster parameters
  deploy        Deploy the Apcera Platform to the cluster
  destroy       Destroy the infrastructure
  export        Export Terraform configuration
  help          Help about any command
  loadpkgs      Download a set of packages to the cluster
  logs          Download logs from the cluster VMs
  plan          Generate and show an execution plan
  reboot        Reboot deployed cluster
  register-nfs  Register an NFS provider
  scp           scp copies files between localhost and the machines in cluster
  ssh           Connects to a given machine in the cluster via SSH
  status        Displays machine and cluster status

Flags

  -c, --config string    Specify the cluster configuration file (json supported)
      --version          Print version

Help

apcera-install [command] --help

Apcera Platform installation methods

Installing the Apcera Platform involves a series of actions that the apcera-install tool guides you through, including configuration, infrastructure creation, platform deployment, and system bootstrapping.

Run the following commands in sequence to complete the installation:

  • apcera-install config to configure the platform.
  • apcera-install plan to generate and show an execution plan.
  • apcera-install apply to create or change the infrastructure (cloud resources).
  • apcera-install deploy to deploy the Apcera Platform to the cluster.
  • apcera-install loadpkgs to import base packages into the cluster.
  • (Optional) apcera-install register-nfs to register an internal NFS service provider.

Config command

To get started, on a Mac (with your working directory not in your path), you run the following command:

$ ./apcera-install config

When you run the apcera-install config command, you are prompted to enter all configurable parameters for your cluster.

Refer to the instructions for your provider for detailed installation steps:

Installation logs and configuration files

When you run the apcera-install install or config commands, the tool generates the following files in the working directory:

  • logs/apcera-install.log for auditing and troubleshooting deployments
  • apcera-install.json contains configuration settings for your cluster, including sensitive credential information. Use caution if sharing this file.

You can also tail the logs during the apcera-install installation process using the command tail -f logs/apcera-install.log.

Updating apcera-install

Apcera provides an update service to automatically notify you when a new version of the apcera-install tool is available. See updating the apcera-install tool.