libcalico-go

module
v1.4.3 Latest Latest
Warning

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

Go to latest
Published: Jun 12, 2017 License: Apache-2.0

README

Build Status Slack Status IRC Channel GoDoc

libcalico-go

This repositiory contains Calico's Go components:

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

This library is used by:

If you wish to use libcalico for integration with Calico networking and policy, the main entry point to managing Calico configuration is through the client.

  • Documentation for the client is in lib/client GoDoc.
  • The resource structure definitions are defined in lib/api, this includes detailed per-resource and per-field level descriptions.
  • Resource definitions can be found in Calico docs
  • This repository also includes the implementation for Calico IPAM which can be found in lib/client

If you are developing against the code in libcalico, please run the tests before submitting a Pull Request.

To run the tests locally (requires a full golang environment Go 1.7+):

make ut

To run the tests within a containerized environment:

make test-containerized

Directories

Path Synopsis
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.
converter
Package converter implements adaptors for for conversion between API and Backend models.
Package converter implements adaptors for for conversion between API and Backend models.
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;
ipip
Package ipip implements a field type that represent different ipip modes.
Package ipip implements a field type that represent different ipip modes.
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