README
¶
Skupper Version 2
Skupper allows you to create a Virtual Application Network (VAN) enabling secure, location independent communication between systems including public cloud, private cloud, virtual machines (VMs), bare metal hosts, and mainframes.
Version 1 of Skupper, v1 branch is working in many production environments and has significantly reduced the time, effort and expense of deploying applications to a hybrid multicloud.
The main branch focuses on the development of the upcoming major release of the Skupper project based on feedback from users.
The plan is to produce a number of "previews" on the branch in order to get further user feedback and refine the implementation of this major release. The v2 version is intended for evaluation purposes only and should not be used in production environments.
Highlights
The objective of the next Skupper major release is to better support a full declarative model so that applications and VANs can be more easily deployed in fully automated frameworks.
The release includes:
- The introducton of Custom Resource Definitions CRDs for a more intuitive and flexible declarative interfaces for users, with an equivalent implementation for Linux.
- Architectural improvements for the primary components (e.g. controller, cli, and non-kube executable)
- A flexible PKI implementation allowing users to easily provide their own certificates as required
- A network collector and console that is deployed separately from the site components
- Simpler integrations for centralized application network definition
Interoperability with Version 1
Skupper v2 sites are not interoperable with v1 sites. The plan is to provide tools to assist users to migrate their v1 installations to a v2 deployment as the release approaches.
Skupper v1 will continue to be maintained but no new significant features are planned.
Useful Links
Using Skupper v2
Questions and Feedback
For any questions, feedback or reporting of issues encountered using the v2 preview, please use the Skupper community mailing list or create a GitHub issue as described on the Skupper web site community page
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
cmd
|
|
|
controller
command
|
|
|
kube-adaptor
command
|
|
|
network-observer
command
|
|
|
network-observer/codegen
command
|
|
|
network-observer/internal/api
extra hand written stuffs to make working with generated code easier
|
extra hand written stuffs to make working with generated code easier |
|
network-observer/internal/collector
Package collector implements the vanflow event listener that backs the network console collector.
|
Package collector implements the vanflow event listener that backs the network console collector. |
|
network-observer/internal/server
Package server implements the server interface in internal/api
|
Package server implements the server interface in internal/api |
|
network-observer/internal/server/views
Package view implements a mapping layer between vanflow records and the collector api.
|
Package view implements a mapping layer between vanflow records and the collector api. |
|
skupper
command
|
|
|
system-controller
command
|
|
|
internal
|
|
|
cmd/generate-doc
command
|
|
|
kube/certificates
Package certificates provides the ability to create or update instances of the v2alpha1 Certificate resource, and ensure that a corresponding Secret resource is maintained for each.
|
Package certificates provides the ability to create or update instances of the v2alpha1 Certificate resource, and ensure that a corresponding Secret resource is maintained for each. |
|
kube/client
Package client provides access to various APIS used to interact with the Kubernetes API server.
|
Package client provides access to various APIS used to interact with the Kubernetes API server. |
|
kube/watchers
Package watchers provides a means of watching changes in different Kubernetes resources.
|
Package watchers provides a means of watching changes in different Kubernetes resources. |
|
pkg
|
|
|
generated/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
generated/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
generated/client/clientset/versioned/typed/skupper/v2alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
generated/client/clientset/versioned/typed/skupper/v2alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
vanflow
Package vanflow defines types for the message and record types specified in the VanFlow specification.
|
Package vanflow defines types for the message and record types specified in the VanFlow specification. |
|
vanflow/encoding
encoding exposes functionality to convert between an arbitrary maps and native Go structs in service of the Vanflow protocol.
|
encoding exposes functionality to convert between an arbitrary maps and native Go structs in service of the Vanflow protocol. |
|
vanflow/eventsource
The eventsource package contains mechanisims for discovering and interacting with vanflow event sources.
|
The eventsource package contains mechanisims for discovering and interacting with vanflow event sources. |
|
vanflow/session
session implements amqp connection and session management though the concept of a Container, inspired by the Container interface exposed by the qpid proton amqp libraries.
|
session implements amqp connection and session management though the concept of a Container, inspired by the Container interface exposed by the qpid proton amqp libraries. |