README
¶
Submariner Operator
The submariner operator installs the submariner components on a Kubernetes cluster.
It's available on OperatorHub:submariner.
Quickstart
Please refer the quickstart guides:
Subctl Releases
Latest Stable Release
This release has the latest stable binaries: latest release
Latest Merged Release
This release is constantly updated with the latest code, and might be unstable: devel release
Development
Prerequisites
The build environment uses Dapper, which requires a working Docker setup. You will also need GNU Make.
Build Operator
You can compile the operator image running:
make build-operator
The source code can be validated (golint, gofmt, unit testing) running:
make validate test
Build Subctl
To build subctl locally
go mod vendor
make bin/subctl
You will be able to run subctl using ./bin/subctl from the submariner-operator directory.
Testing
To run end-to-end tests:
make e2e cleanup
Setup development environment
You will need docker installed in your system, and at least 8GB of RAM. Run:
make deploy
Reference
For reference, here's a link to the script generating the scaffold code of the 0.0.1 version of the operator gen_subm_operator.sh.
Updating OperatorHub
The OperatorHub definitions can be found here:
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
apis
module
|
|
|
cmd
|
|
|
pkg
|
|
|
apis/submariner
Package submariner contains submariner API versions.
|
Package submariner contains submariner API versions. |
|
apis/submariner/v1alpha1
Package v1alpha1 contains API Schema definitions for the submariner v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=submariner.io Package v1alpha1 contains API Schema definitions for the submariner v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=submariner.io
|
Package v1alpha1 contains API Schema definitions for the submariner v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=submariner.io Package v1alpha1 contains API Schema definitions for the submariner v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=submariner.io |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/submariner/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/submariner/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |