libcalico-go

module
v0.0.0-...-cf83b6a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 15, 2016 License: Apache-2.0

README

CircleCI

libcalico-go

This repositiory contains Calico's Go components:

  • libcalico, which can be imported as "github.com/projectcalico/libcalico-go/lib"
  • calicoctl

Common set-up

Assuming you have already installed go version 1.7.1+, perform the following simple steps to get building:

git clone git@github.com:projectcalico/libcalico-go.git $GOPATH/src/github.com/projectcalico/libcalico-go
  • Switch to your project directory:
cd $GOPATH/src/github.com/projectcalico/libcalico-go
  • Populate the vendor/ directory in the project's root with this project's dependencies:
glide install

Building calicoctl

Non-release build

To do a quick, non-release build of calicoctl, suitable for local testing, run

make bin/calicoctl

The binary will be put in ./bin:

./bin/calicoctl --help
Release build

For releases, we use a Docker-based build to ensure a clean environment with an appropriate glibc. Specifically, we use a CentOS 6.6 container image to build against glibc v2.12. this ensures compatibility with any later glibc.

To do a release build, run:

make release/calicoctl

The binary will be emitted to ./releases/calicoctl-<version>

Directories

Path Synopsis
resourcemgr
Package resourcemgr implements generic resource handling methods.
Package resourcemgr implements generic resource handling methods.
lib
api
Package api implements the struct definitions used on the northbound client API.
Package api implements the struct definitions used on the northbound client API.
backend
Package backend implements the backend data store client and associated backend data type.
Package backend implements the backend data store client and associated backend data type.
client
Package client implements the northbound client used to manage Calico configuration.
Package client implements the northbound client used to manage Calico configuration.
errors
Package errors implements various error types that are used both internally, and that may be returned from the client interface.
Package errors implements various error types that are used both internally, and that may be returned from the client interface.
hwm
The hwm package contains the HighWatermarkTracker;
The hwm package contains the HighWatermarkTracker;
net
Package net implements a set of net types that are extensions to the built-in net package.
Package net implements a set of net types that are extensions to the built-in net package.
numorstring
Package numorstring implements a set of type definitions that in YAML or JSON format may be represented by either a number or a string.
Package numorstring implements a set of type definitions that in YAML or JSON format may be represented by either a number or a string.
scope
Package scope implements field types that represent different scopes for resource types.
Package scope implements field types that represent different scopes for resource types.
testutils
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL