broker

package

v0.23.1 Latest Latest Go to latest Published: Mar 12, 2026 License: Apache-2.0 Imports: 36 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/submariner-io/subctl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CreateNewBrokerAdminSA(ctx context.Context, kubeClient kubernetes.Interface, inNamespace string) error
func CreateNewBrokerRoleBinding(ctx context.Context, kubeClient kubernetes.Interface, ...) (*rbacv1.RoleBinding, error)
func CreateNewBrokerSA(ctx context.Context, kubeClient kubernetes.Interface, ...) error
func CreateOrUpdateBrokerAdminRole(ctx context.Context, clientset kubernetes.Interface, inNamespace string) (bool, error)
func CreateOrUpdateBrokerAdminRoleBinding(ctx context.Context, kubeClient kubernetes.Interface, inNamespace string) (bool, error)
func CreateOrUpdateClusterBrokerRole(ctx context.Context, kubeClient kubernetes.Interface, inNamespace string) (bool, error)
func CreateSAForCluster(ctx context.Context, kubeClient kubernetes.Interface, ...) (*v1.Secret, error)
func Ensure(ctx context.Context, crdUpdater crd.Updater, kubeClient kubernetes.Interface, ...) error
func GenerateRandomPSK() ([]byte, error)
func NewBrokerRoleBinding(serviceAccount, role, namespace string) *rbacv1.RoleBinding
func NewBrokerSA(submarinerBrokerSA string) *v1.ServiceAccount
func RecoverData(ctx context.Context, submCluster *cluster.Info, broker *v1alpha1.Broker, ...) error
func WriteInfoToFile(ctx context.Context, restConfig *rest.Config, ...) error
type Info
- func ReadInfoFromFile(filename string) (*Info, error)

Constants ¶

View Source

const (
	LocalClientBrokerSecretName = "submariner-broker-secret"
	SubmarinerBrokerClusterRole = "submariner-k8s-broker-cluster"
)

View Source

const InfoFileName = "broker-info.subm"

Variables ¶

View Source

var (
	InfoFileDir = ""

	NewKubeClient = func(config *rest.Config) (kubernetes.Interface, error) {
		c, err := kubernetes.NewForConfig(config)
		return c, err
	}
)

View Source

var NewSubmarinerClientset = func(config *rest.Config) (submarinerClientset.Interface, error) {
	c, err := submarinerClientset.NewForConfig(config)
	return c, err
}

Functions ¶

func CreateNewBrokerAdminSA ¶ added in v0.16.0

func CreateNewBrokerAdminSA(ctx context.Context, kubeClient kubernetes.Interface, inNamespace string) error

func CreateNewBrokerRoleBinding ¶

func CreateNewBrokerRoleBinding(ctx context.Context, kubeClient kubernetes.Interface, serviceAccount, roleName, inNamespace string) (
	*rbacv1.RoleBinding, error,
)

func CreateNewBrokerSA ¶

func CreateNewBrokerSA(ctx context.Context, kubeClient kubernetes.Interface, submarinerBrokerSA, inNamespace string) error

func CreateOrUpdateBrokerAdminRole ¶

func CreateOrUpdateBrokerAdminRole(ctx context.Context, clientset kubernetes.Interface, inNamespace string) (bool, error)

func CreateOrUpdateBrokerAdminRoleBinding ¶ added in v0.16.0

func CreateOrUpdateBrokerAdminRoleBinding(ctx context.Context, kubeClient kubernetes.Interface, inNamespace string) (bool, error)

func CreateOrUpdateClusterBrokerRole ¶

func CreateOrUpdateClusterBrokerRole(ctx context.Context, kubeClient kubernetes.Interface, inNamespace string) (bool, error)

func CreateSAForCluster ¶

func CreateSAForCluster(ctx context.Context, kubeClient kubernetes.Interface, clusterID, inNamespace string) (*v1.Secret, error)

CreateSAForCluster creates a new SA for each new cluster joined and binds it to the submariner cluster role.

func Ensure ¶

func Ensure(ctx context.Context, crdUpdater crd.Updater, kubeClient kubernetes.Interface, componentArr []string, createCRDs bool,
	brokerNS string,
) error

func GenerateRandomPSK ¶ added in v0.15.0

func GenerateRandomPSK() ([]byte, error)

GenerateRandomPSK returns a securely generated array suitable for use as a PSK.

func NewBrokerRoleBinding ¶

func NewBrokerRoleBinding(serviceAccount, role, namespace string) *rbacv1.RoleBinding

NewBrokerRoleBinding creates a role for to bind the cluster admin (subctl) SA.

func NewBrokerSA ¶

func NewBrokerSA(submarinerBrokerSA string) *v1.ServiceAccount

func RecoverData ¶ added in v0.15.0

func RecoverData(ctx context.Context, submCluster *cluster.Info, broker *v1alpha1.Broker, brokerNamespace, brokerURL string,
	brokerRestConfig *rest.Config, status reporter.Interface,
) error

func WriteInfoToFile ¶

func WriteInfoToFile(ctx context.Context, restConfig *rest.Config, brokerNamespace, brokerURL string, ipsecPSK []byte,
	components set.Set[string], customDomains []string, status reporter.Interface,
) error

Types ¶

type Info ¶

type Info struct {
	BrokerURL        string         `json:"brokerURL"`
	ClientToken      *corev1.Secret `json:"clientToken,omitempty"`
	IPSecPSK         *corev1.Secret `json:"ipsecPSK,omitempty"`
	ServiceDiscovery bool           `json:"serviceDiscovery,omitempty"`
	Components       []string       `json:",omitempty"`
	CustomDomains    *[]string      `json:"customDomains,omitempty"`
}

func ReadInfoFromFile ¶

func ReadInfoFromFile(filename string) (*Info, error)

func (*Info) GetBrokerAdministratorConfig ¶

func (d *Info) GetBrokerAdministratorConfig(ctx context.Context, insecure bool) (*rest.Config, error)

func (*Info) GetComponents ¶

func (d *Info) GetComponents() set.Set[string]

func (*Info) IsConnectivityEnabled ¶

func (d *Info) IsConnectivityEnabled() bool

func (*Info) IsServiceDiscoveryEnabled ¶

func (d *Info) IsServiceDiscoveryEnabled() bool

func (*Info) WriteToFile ¶ added in v0.22.0

func (d *Info) WriteToFile(filename string) error

Source Files ¶

View all Source files

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