Submariner is always deployed using a Go-based Kubernetes custom controller, called an
Operator, that provides API-based installation and management. Deployment tools like
subctl command line utility and Helm charts wrap the Operator. The recommended deployment method is
it is currently the default in CI and provides diagnostic features.
Download the subctl binary and make it available on your PATH.
curl -Ls https://get.submariner.io | bash
echo export PATH=\$PATH:~/.local/bin >> ~/.profile
If you have Go and the source code, you can build and install subctl instead:
go build -o $GOBIN/subctl github.com/submariner-io/subctl/cmd
(and ensure your
go/bin directory is on your
The Broker is a set of Custom Resource Definitions (CRDs) backed by the Kubernetes datastore. The Broker must be deployed on a cluster whose Kubernetes API is accessible by all of the participating clusters.
subctl deploy-broker --kubeconfig <PATH-TO-KUBECONFIG-BROKER>
This will create:
Cluster CRDs in the cluster.
It also generates the
broker-info.subm file which contains the following elements:
The cluster in which the Broker is deployed can also participate in the dataplane connectivity with other clusters, but it will need to be joined (see following step).
You can customize the Broker namespace using the
--broker-namespace flag, allowing you to use
a namespace of your choice on the Broker for synchronising resources between clusters.
subctl deploy-broker --broker-namespace <CUSTOM-NAMESPACE> ...
subctl deploy-broker flag docs for additional details.
For each cluster you want to join, issue the following command:
subctl join --kubeconfig <PATH-TO-JOINING-CLUSTER> broker-info.subm --clusterid <ID>
subctl will automatically discover as much as it can, and prompt the user for any missing necessary information.
Note that each cluster must have a unique cluster ID; the cluster ID can be specified, or otherwise is going to be generated by default
based on the cluster name in the
kubeconfig file. The cluster ID must be a valid
DNS-1123 Label. If the cluster name
kubeconfig file isn’t valid, a valid cluster ID must be specified with