apid

README

apid

apid is a container for publishing APIs that provides core services to its plugins including configuration, API publishing, data access, and a local pub/sub event system.

To build and run

make build - will build apid by linking with all the apid plugins mentioned in main.go
make fresh - will build after updating glide (glide up -v)

For command line options:

./apid -help

Configuration

Configuration can be done via yaml file or environment variables. Keys are case-insensitive. By default, apid will look for a file called apid_config.yaml in the current working directory. See apid_config_sample.yaml in this directory for an example file.

Defaults

api_listener: 127.0.0.1:9000  # api listener will bind to specified host and port
data_path: /var/tmp           # all data stored on disk will be under this path 
log_level: debug              # valid values: Debug, Info, Warning, Error, Fatal, Panic 

Environment variable overrides

Config will pick up env vars automatically. Use "apid_" as a prefix for settings. For example, for apid's "log_level" configuration setting, set env var "apid_log_level".

Helpful Hints

• Use export APID_DATA_TRACE_LOG_LEVEL=debug to see DB Tracing

Components

Core

• ApigeeSync

Included apid plugins

• ApigeeSync
• ApiMetadata
• GatewayConfDeploy
• ApigeeAnalytics

To change plugins list, edit main.go add to glide.yaml and follow the release process below.

Release process

To update the build dependencies and release, follow this process:

1. Update glide.yaml to the correct versions
2. Run make fresh and ensure you get build complete
3. Commit glide.yaml
4. Add a Git label on the commit for the version of the release (use semver, ie. "1.2.3")
5. Push commit and label to Github to cause Travis to create a release and attach binaries for OS X and Linux
6. Once the release has been created, you may edit it on Github to add release notes
7. Do not commit glide.lock file.
8. Run ./apid -commits and ensure the new plugin commit Id matches the entry seen in glide.lock

Adding a new plugin

To add a new plugin, update the build dependencies and release, follow this process:

1. Update glide.yaml to include the new apid plugin and its version
2. Update main.go by importing the new plugin, and adding updating plugin info in cmtIdFlag section
3. Run make fresh and ensure you get build complete
4. Commit glide.yaml
5. Add a Git label on the commit for the version of the release (use semver, ie. "1.2.3")
6. Push commit and label to Github to cause Travis to create a release and attach binaries for OS X and Linux
7. Once the release has been created, you may edit it on Github to add release notes
8. Do not commit glide.lock file.
9. Run ./apid -commits and ensure the new plugin commit Id matches the entry seen in glide.lock

Notes on release process

In order to have a reproducible build, we have the following rules:

• All glide.yaml packages must specify a version.
• Any 3rd-party libraries used by apid-core or used by any plugin must be checked into the vendor dir.
• Use an empty $GOPATH (aside from apid itself) to ensure a clean build
• apid-core and all plugins must only rely on libraries including by this apid module. If there are additional libraries that are needed, they must be approved, added to glide.yaml, and checked in to the vendor directory.