README
¶
juju/charmstore
Store and publish Juju charms.
Installation
To start using the charm store, first ensure you have a valid Go environment, then run the following:
go get -d gopkg.in/juju/charmstore.v4
cd $GOPATH/gopkg.in/juju/charmstore.v4
Go dependencies
The project uses godeps (https://launchpad.net/godeps) to manage Go dependencies. To install this, run:
go get launchpad.net/godeps
After installing it, 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. If you do not wish to run the
elasticsearh tests, set JUJU_TEST_ELASTICSEARCH=none.
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;
- essync: synchronize the contents of the Elastic Search database with the charm store.
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.
Note that this configuration should not be used when running
a production server, as it uses a known password for authentication.
At this point the server starts listening on port 8080 (as specified in the config YAML file).
Documentation
¶
Index ¶
Constants ¶
const ( V4 = "v4" Legacy = "" )
Versions of the API that can be served.
Variables ¶
This section is empty.
Functions ¶
func NewServer ¶
func NewServer(db *mgo.Database, es *elasticsearch.Database, idx string, 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.
Types ¶
type ServerParams ¶
type ServerParams struct {
// AuthUsername and AuthPassword hold the credentials
// used for HTTP basic authentication.
AuthUsername string
AuthPassword string
// IdentityLocation holds the location of the third party authorization
// service to use when creating third party caveats.
IdentityLocation string
// PublicKeyLocator holds a public key store.
// It may be nil.
PublicKeyLocator bakery.PublicKeyLocator
}
ServerParams holds configuration for a new API server.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
charmd
command
|
|
|
cshash256
command
|
|
|
essync
command
|
|
|
The config package defines configuration parameters for the charm store.
|
The config package defines configuration parameters for the charm store. |
|
The csclient package provides access to the charm store API.
|
The csclient package provides access to the charm store API. |
|
internal
|
|
|
charmstore
This is the internal version of the charmstore package.
|
This is the internal version of the charmstore package. |
|
debug
The debug package holds various functions that may be used for debugging but should not be included in production code.
|
The debug package holds various functions that may be used for debugging but should not be included in production code. |
|
legacy
The legacy package implements the legacy API, as follows:
|
The legacy package implements the legacy API, as follows: |
|
router
The router package implements an HTTP request router for charm store HTTP requests.
|
The router package implements an HTTP request router for charm store HTTP requests. |
|
The params package holds types that are a part of the charm store's external contract - they will be marshalled (or unmarshalled) as JSON and delivered through the HTTP API.
|
The params package holds types that are a part of the charm store's external contract - they will be marshalled (or unmarshalled) as JSON and delivered through the HTTP API. |