APPR Command Line Tool
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
wget https://github.com/cn-app-registry/appr-cli/releases/download/v0.3.7-dev/registry-appr-v0.3.7-dev-osx-x64-helm-plugin.tar.gz
mkdir -p ~/.helm/plugins/
tar xzvf registry-appr-v0.3.7-dev-osx-x64-helm-plugin.tar.gz -C ~/.helm/plugins/
Linux
wget https://github.com/cn-app-registry/appr-cli/releases/download/v0.3.7-dev/registry-appr-v0.3.7-dev-linux-x64-helm-plugin.tar.gz
mkdir -p ~/.helm/plugins/
tar xzvf registry-appr-v0.3.7-dev-linux-x64-helm-plugin.tar.gz -C ~/.helm/plugins/
Windows
wget https://github.com/cn-app-registry/appr-cli/releases/download/v0.3.7-dev/registry-appr-v0.3.7-dev-win-x64-helm-plugin.tar.gz
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/appr.sh
Deploy Jenkins Using Helm from the Quay Registry
helm registry version app.quay.io
Output should be:
Api-version: {u'appr-api': u'0.X.Y'}
Client-version: 0.X.Y
Install Jenkins
helm init
helm registry list app.quay.io
helm registry install app.quay.io/helm/jenkins
Create and Push Your Own Chart
First, create an account on https://app.quay.io (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 app.quay.io
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 app.quay.io
helm registry install app.quay.io/$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
- git clone https://github.com/cn-app-registry/appr-server.git && cd appr-server
- pip install -e . && pip install gunicorn
- Run the appr-server on port 5000
gunicorn appr.api.wsgi:app -b :5000
or "./run-server" - See the curl-based examples
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:
Helm charts
Demo using usingPublish a chart
Create and encode the chart tarball
~/charts/elasticsearch $
tar czvf ../elastichart.tar.gz Chart.yaml manifests README.md
cat ../elastichart.tar.gz | base64 -w 0
H4sIAGBoF1gAA+2XTY/aMBCGc86vGKlngk02iRpVq1aUQw+VKlr1bowhVp0P2QZp/33tZFkCy0dVAburnUdCBs/EMyR5XyfjgmkbPbBSBVeDONL0zo80S0h/bInTLKAxIUmaxkmSBoTSu3QUALleS1tWxjINELDKxvRE3rn4G6VipchBKGas5EYwzYuwqP1cYW1j8uFwKW2xmkW8LoePacPd9LXQRtZVDiQaRSScC8O1bGw7NelnwlQYu1gp+Nn9nFRLWYmwZLKy7uOWyUOAAXxjFYzrxUI8wCfJ2y+f50Ia38O9W98lqzb1VyENjP0dDI2u19KVBgYzZiTfq/w06LXkIgpf+rS/GkpWyYW7LGZ4vRpe41mWHNW/Y1//yYgEkFyvpS3vXP/b678j6oFZ84vtCmf9P4n3rn9KKEH/vwWskb83/r2m4R9ZzXPnz61NhqWz2jmzzHvtoY0CQLGZ6LwYNhasn2cBFEJLy5Z+WxGqDE0juD+oqbV9NP1ufa6kqGy3nIvl8HFESC/eCKH70biNGqEEt7U+3cdLn+pXyTH968vJ/6z+M0r39J+kNEP934KD+p+KRknO/CPcuK6srpVysru6G+iurMmB/rOoAawoG8Ws6PL6TXoON+rpN3uu4U2HHl73n1Y9gxNVAGTZ/tOdYD6KaES3pTc2uFnvqcaPvgkei3oT/F93m06+fP0+icr5Re+qXc7pn9L9/Z+6SdT/Lfiw+6IUhvhOhSAIgiAIgiAIgiAIgiAIgiBvnr97lKMIACgAAA==
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