charmstore

README

juju/charmstore

Store and publish Juju charms.

Installation

To start using the charm store, run the following:

go get -u -v -t github.com/juju/charmstore/...

Go dependencies

The project uses godeps (https://launchpad.net/godeps) to manage Go dependencies. After installing the application, you can update the dependencies to the revision specified in the dependencies.tsv file with the following:

make deps

Use make create-deps to update the dependencies file.

Development environment

A couple of system packages are required in order to set up a charm store development environment. To install them, run the following:

make sysdeps

To run the elasticsearch tests you must run an elasticsearch server. If the elasticsearch server is running at an address other than localhost:9200 then set JUJU_TEST_ELASTICSEARCH=<host>:<port> where host and port provide the address of the elasticsearch server.

At this point, from the root of this branch, run the command::

make install

The command above builds and installs the charm store binaries, and places them in $GOPATH/bin. This is the list of the installed commands:

• charmd: start the charm store server;

A description of each command can be found below.

Testing

Run make check to test the application. Run make help to display help about all the available make targets.

Charmstore server

Once the charms database is fully populated, it is possible to interact with charm data using the charm store server. It can be started with the following command:

charmd -logging-config INFO cmd/charmd/config.yaml

The same result can be achieved more easily by running make server.

At this point the server starts listening on port 8080 (as specified in the config YAML file).

Documentation

Index

• Constants
• func NewServer(db *mgo.Database, es *elasticsearch.Index, config ServerParams, ...) (http.Handler, error)
• func Versions() []string
• type ServerParams

Constants

const (
	V4     = "v4"
	Legacy = ""
)

Versions of the API that can be served.

Functions

func NewServer

func NewServer(db *mgo.Database, es *elasticsearch.Index, config ServerParams, serveVersions ...string) (http.Handler, error)

NewServer returns a new handler that handles charm store requests and stores its data in the given database. The handler will serve the specified versions of the API using the given configuration.

func Versions

func Versions() []string

Versions returns all known API version strings in alphabetical order.

Types

type ServerParams

type ServerParams struct {
	AuthUsername string
	AuthPassword string
}

ServerParams holds configuration for a new API server.