libcalico-go

module

v1.0.0-alpha.1 Latest Latest Go to latest Published: Sep 1, 2016 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/klarrio/libcalico-go

README ¶

libcalico-go

This repositiory contains Calico's Go components:

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

Common set-up

Assuming you have already installed go v1.6+, perform the following simple steps to get building:

Install Glide
Clone this repository to your Go project path:

git clone git@github.com:tigera/libcalico-go.git $GOPATH/src/github.com/tigera/libcalico-go

Switch to your project directory:

cd $GOPATH/src/github.com/tigera/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
calicoctl
commands WARNING: This file is overwritten by a script in the release build process.	WARNING: This file is overwritten by a script in the release build process.
commands/node
resourcemgr Package resourcemgr implements generic resource handling methods.	Package resourcemgr implements generic resource handling methods.
lib
api Package api implements the resource struct definitions used by the northbound client API.	Package api implements the resource struct definitions used by the northbound client API.
api/unversioned
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.
backend/api
backend/compat
backend/etcd
backend/model
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.
hash
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 represent either a number or a string.	Package numorstring implements a set of type definitions that represent 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.
selector
selector/parser
selector/tokenizer
validator

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