projectcalico-libcalico-go

module

v1.0.0-rc2 Latest Latest Go to latest Published: Nov 30, 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/thxCode/projectcalico-libcalico-go

README ¶

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 both calicoctl, calico-cni and felix.

If you are looking for the golang version of calicoctl it is in the process of moving and can be found in our calico-containers repo / golang branch.

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.
The resource structure definitions are defined in lib/api, this includes detailed per-resource and per-field level descriptions.

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.
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/k8s
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 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.
selector
selector/parser
selector/tokenizer
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.
validator

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