Skip to main content

cloud-native app registry server

Project description

[![build status](](
[![Coverage Status](](
[![Swagger API Reference](](Documentation/server/appr-api-swagger.yaml)

# APPR Command Line Tool
[CLI commands overview](Documentation/

## Install the Helm Registry Plugin

First, Install the latest [Helm release](

If you are an OSX user, quickstart with brew: `brew install kubernetes-helm`

Next download and install the registry plugin for Helm.

### OSX

mkdir -p ~/.helm/plugins/
tar xzvf registry-appr-v0.3.7-dev-osx-x64-helm-plugin.tar.gz -C ~/.helm/plugins/

### Linux

mkdir -p ~/.helm/plugins/
tar xzvf registry-appr-v0.3.7-dev-linux-x64-helm-plugin.tar.gz -C ~/.helm/plugins/

### Windows

mkdir -p ~/.helm/plugins/
tar xzvf registry-appr-v0.3.7-dev-linux-x64-helm-plugin.tar.gz -C ~/.helm/plugins/

Note: You must have bash in your path and change the `registry/plugin.yaml` execution to call `bash -c $HELM_PLUGIN_DIR/`

## Deploy Jenkins Using Helm from the Quay Registry

helm registry version

Output should be:
Api-version: {u'appr-api': u'0.X.Y'}
Client-version: 0.X.Y

### Install Jenkins

helm init
helm registry list
helm registry install

## Create and Push Your Own Chart

First, create an account on (staging server) and login to the CLI using the username and password

Set an environment for the username created at Quay to use through the rest of these instructions.

export USERNAME=philips

Login to Quay with the Helm registry plugin:

helm registry login -u $USERNAME

Create a new Helm chart, the default will create a sample nginx application:

helm create nginx

Push this new chart to Quay and then deploy it from Quay.

cd nginx
helm registry push --namespace $USERNAME
helm registry install$USERNAME/nginx

# appr-server

APPR implements a registry for storing Kubernetes application manifests that attempts to reuse as much knowledge from the rest of the Linux container ecosystem as possible.

Differentiating features include:

- A protocol and data model that can more easily be implemented by pre-existing container registries
- This includes a common API for uploading, downloading, and searching for applications
- The reuse and integration with many elements from [OCI](
- Content addressable manifest scheme for security, signing, and non-trusted mirroring
- Reuse of common data structures such as Descriptors
- Unification of Manifest Lists as the means of content negoitation for both Images and Applications

## Getting started

1. git clone && cd appr-server
2. pip install -e . && pip install gunicorn
3. Run the appr-server on port 5000 `gunicorn appr.api.wsgi:app -b :5000`
or "./run-server"
4. See the [curl-based examples](Documentation/

## Architecture at a glance

There are two top-level objects:

- Package: metadata describing an application
- Blob: a gzipped tarball of the package encoded in base64

Packages are primarily indexed by 3 notable fields:

- package-name: it follows container-image format: `namespace/name`.
- release: it's the version of the package, immutable it can be viewed as an alias to a digest
- mediaType: the format of the package formats (eg: docker-compose, dab, helm, kpm)

Data storage is specified by the `STORAGE` environment variable. The following are supported:

- `filesystem` (default)
- [`etcd`](
- [`redis`](

## Demo using using [Helm]( charts

### Publish a chart

Create and encode the chart tarball

~/charts/elasticsearch $
tar czvf ../elastichart.tar.gz Chart.yaml manifests
cat ../elastichart.tar.gz | base64 -w 0

POST the chart to APPR

curl -XPOST http://localhost:5000/api/v1/packages/myname/elasticsearch -d '
"blob": "H4sIAP3mAFgAA....",
"release": "2.2.1",
"media_type": "helm"

### Pull the chart

Find the digest from the package-name/release/media-type

curl -XGET http://localhost:5000/api/v1/packages/myname/elasticsearch/2.2.1/helm
"channels": [],
"content": {
"digest": "72ed15c9a65961ecd034cca098ec18eb99002cd402824aae8a674a8ae41bd0ef",
"mediaType": "application/vnd.appr.package.helm.v1.tar+gzip",
"size": 583,
"urls": []
"created_at": "2016-11-16T17:13:07.806579",
"mediaType": "application/vnd.appr.package-manifest.helm.v1.json",
"package": "myname/elasticsearch",
"release": "2.2.1"


Fetch the blob

curl -XGET \
http://localhost:5000/api/v1/packages/myname/elasticsearch/blobs/sha256/72ed15c9a65961ecd034cca098ec18eb99002cd402824aae8a674a8ae41bd0ef \
-o elasticsearch-chart.tar.gz

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

appr-0.7.4.tar.gz (317.4 kB view hashes)

Uploaded source

Built Distribution

appr-0.7.4-py2.py3-none-any.whl (484.7 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page