Skip to content

Latest commit

 

History

History
141 lines (107 loc) · 4.67 KB

API.md

File metadata and controls

141 lines (107 loc) · 4.67 KB
Raw

1.0.0 API Reference

Command Line Arguments

Required Flags

  • -a, --accessKey <token> - AWS access key [string]'.
  • -s, --secretKey <token> - AWS secret key [string].
  • -b, --bucket <string> - AWS S3 Bucket [string].

Optional Flags

  • -h, --help - print help page.
  • -H, --host <host> - host address to listen with (defaults to 0.0.0.0). [string]
  • -P, --port <port> - port to listen with (defaults to 8080). [integer]
  • -r, --region <string> - AWS region (defaults to us-east-1. [string]
  • -f, --file <path> - Path to configuration file. [string]
  • -u, --url <string>- host + path Url to build the canonical chart link with. Defaults to https://s3.amazonaws.com// [string]
  • -c, --canacl <string>- AWS S3 Canned ACL (private, public-read, public-read-write, etc...). Defaults to public-read [string]

Configuration File

The configuration file is in JSON format.

{
    "accessKey" : "<AWS access key>",
    "secretKey" : "<AWS secret key>",
    "region" : "<AWS region>",
    "bucket" : "<AWS S3 bucket>",
    "canacl" : "private",
    "port" : "8080",
    "host" : "127.0.0.1",
    "url" : "https://s3.amazonaws.com/your-bucket"
}

Environment Variables

  • ACCESSKEY - AWS access key [string]
  • SECRETKEY - AWS secret key [string]
  • REGION - AWS region (defaults to us-east-1) [string]
  • BUCKET - AWS S3 Bucket [string]
  • CANACL - AWS S3 Canned ACL [string]
  • HOST - host address to listen with. [string]
  • PORT - port to listen with. [integer]
  • URL - host + path Url to build the canonical chart link with. [string]

Endpoints

POST /chart

Allows you to post new charts to the repository. If the name of the uploaded chart matches one in S3, the call will fail. This call will also update the index.yaml manifest.

Form Parameters

  • subRepo - name of the prefix / subfolder to push the chart into [string] Optional
  • chart - content of the file [file] Required
curl -i -X POST -F repo=qa -F chart=@/home/bob/prometheus-0.1.0.tgz http://localhost:8080/chart

PUT /chart

Allows you to update an existing chart to the repository. This call will also update the index.yaml manifest.

Form Parameters

  • subRepo - name of the prefix / subfolder to push the chart into [string] Optional
  • chart - content of the file [file] Required
curl -i -X PUT -F repo=qa -F chart=@/home/bob/prometheus-0.1.0.tgz http://localhost:8080/chart

POST /index/rebuild

Allows for a full rebuild of the index.yaml file. If the manifest is out of sync with the actual content of the bucket, this will fix it.

Form Parameters

  • subRepo - name of the prefix / subfolder to push the chart into [string] Optional
curl -X POST -F subRepo=qa http://localhost:8080/index/rebuild

GET /{subRepo?}/index.yaml

Allows for retrieval of the charts manifest file.

Path segments

  • subRepo - name of the prefix / subfolder used to push a previous chart [string] Optional
# No use of subRepo
curl -v -X GET http://localhost:8080/index.yaml

# Use of subRepo named qa
curl -v -X GET http://localhost:8080/qa/index.yaml

GET /{subRepo?}/{chartName}.tgz

Allows for retrieval of the charts manifest file.

Path segments

  • subRepo - name of the prefix / subfolder used to push a previous chart [string] Optional
  • chartName - name of the chart [string] Required
# No use of subRepo
curl -v -X GET http://localhost:8080/influxdb-1.1.1.tgz

# Use of subRepo named qa
curl -v -X GET http://localhost:8080/qa/influxdb-1.1.1.tgz

GET /healthy

Simple healthy check endpoint.

curl -v -X GET http://localhost:8080/healhty