Anbox Application Registry (AAR) Charmed Operator

Description

Anbox Cloud

Anbox Cloud provides a rich software stack that enables you to run Android applications in the cloud for different use cases, including high-performance streaming of graphics to desktop and mobile client devices.

Anbox Cloud maintains a single Android system per instance, providing higher density and better performance per host while ensuring security and isolation of each instance. Depending on the target platform, payload, and desired application performance (for example, frame rate), Anbox Cloud can run more than 100 instances on a single machine.

Also have a look at the official Anbox Cloud website (https://anbox-cloud.io) for more information.

NOTE: Anbox Cloud is a paid offering. You will need a Ubuntu Pro (https://ubuntu.com/pro) subscription for this charm to work. You can learn more at https://anbox-cloud.io

WARNING: The Ubuntu Pro (infra only) subscription every Ubuntu user gets for free for personal use does NOT work and will result in a failed deployment! You either need a Ubuntu Pro or Ubuntu Pro (apps only) subscription to be able to deploy successfully.

Anbox Application Registry

The Anbox Application Registry, or AAR, charm provides a central repository for applications created on Anbox Cloud. It is extremely useful for larger deployments involving multiple regions in order to keep applications in sync.

Client Types

There are two types of consumers that can connect to AAR:

• Client/Pull Only: A Read-Only Client which can only pull from the registry
• Publisher/Push & Pull: A Read-Write Client which can pull as well as publish applications to the registry

For more information on how to configure the AAR and its clients, visit the official documentation at https://anbox-cloud.io/docs/installation/installation-application-registry

Usage

WARNING: This charm requires a resource to work which is described as follows:

resources:
  aar-snap:
    type: file
    description: Snap for Anbox Application Registry
    filename: aar.snap

This resource represents the AAR snap package which will be installed when the charm gets installed.

Basic Usage

$ juju deploy aar --resource aar-snap=aar.snap

Integrations (Relations)

aar interface:

This interface is used to register a client and interact with AAR.

Provides Side:

provides:
  client:
    interface: aar
  publisher:
    interface: aar

This interface is used by two integrations in the charm both corresponding to the types of clients to register. The data provided to the consumer charms looks like the following:

certificate: <self-signed certificate of the registry>
fingerprint: <fingerprint of the certificate>
ip: <ipv4 address of the listener>
port: <port of the listener>

Requires Side:

The data provided to the provider side should look like the following:

certificate: "-----BEGIN CERTIFICATE-----\n
            ....
            -----END CERTIFICATE-----\n"
mode: "publisher"

Security

Security issues in the operator can be reported through LaunchPad on the Anbox Cloud project. Please do not file GitHub issues about security issues.

Contributing

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and CONTRIBUTING.md for developer guidance.

License

The AAR Charm is distributed under the Apache Software License, version 2.0.