Overview

The Anapaya GATE implements the IP-in-SCION tunneling module and is typically deployed by ISPs to collect the IP traffic of their residential customers which should be routed into the SCION network.

Interacting with an Anapaya Appliance

The Anapaya appliance offers a feature-rich HTTP REST API supporting the following interactions (more will be added in the future):

  • Manipulating the configuration of the appliance.

  • Inspecting the status of the appliance.

  • Provisioning cryptographic material, such as TRCs and certificates.

  • Using basic SCION tools such as scion ping and scion showpaths that help with exploring the network basic troubleshooting.

The OpenAPI 3 specification of the appliance management API is available here.

The entire appliance configuration is described in a single JSON file. This facilitates backup and restore of the appliance configuration - an appliance can be restored to a previous state by enacting a backup of the configuration or even freshly provisioned by installing the appliance base image and applying the configuration.

To interact with the management API, there is a range of frontends available:

  • appliance-cli, a command-line tool to interact with the appliance API.

  • curl (or similar) to interact with the appliance via HTTP from the command line.

  • Anapaya Console enables central orchestration of EDGE, CORE and GATE appliances.

It is also possible to use tools like Ansible to orchestrate a fleet of appliances, however, this is out of scope of this knowledge base.

Section Appliance Configuration describes in detail the configuration of an Anapaya appliance.

Telemetry

Each appliance exports rich telemetry data, logs, and events to a central collector based on Prometheus. Details on the exported metrics and their semantics are described in section Telemetry.

Next Steps

If you are just starting out with the Anapaya appliance, we recommend that you begin with the Getting Started section.

If you are already familiar with the Anapaya appliance, we invite you to check out the Appliance Configuration section or read one of our User Guides.