broker

Documentation

Overview

SPDX-License-Identifier: Apache-2.0

Copyright Contributors to the Submariner project.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func ClusterSAName(clusterID string) string
• func CreateGlobalnetConfigMap(kubeClient kubernetes.Interface, globalnetEnabled bool, ...) error
• func CreateNewBrokerRoleBinding(kubeClient kubernetes.Interface, serviceAccount, roleName, inNamespace string) (brokerRoleBinding *rbacv1.RoleBinding, err error)
• func CreateNewBrokerSA(kubeClient kubernetes.Interface, submarinerBrokerSA, inNamespace string) (brokerSA *v1.ServiceAccount, err error)
• func CreateOrUpdateBrokerAdminRole(clientset kubernetes.Interface, inNamespace string) (created bool, err error)
• func CreateOrUpdateClusterBrokerRole(kubeClient kubernetes.Interface, inNamespace string) (bool, error)
• func CreateSAForCluster(kubeClient kubernetes.Interface, clusterID, inNamespace string) (*v1.Secret, error)
• func Ensure(crdUpdater crd.Updater, kubeClient kubernetes.Interface, componentArr []string, ...) error
• func GetGlobalnetConfigMap(kubeClient kubernetes.Interface, namespace string) (*v1.ConfigMap, error)
• func NewBrokerAdminRole() *rbacv1.Role
• func NewBrokerClusterRole() *rbacv1.Role
• func NewBrokerRoleBinding(serviceAccount, role, namespace string) *rbacv1.RoleBinding
• func NewBrokerSA(submarinerBrokerSA string) *v1.ServiceAccount
• func NewGlobalnetConfigMap(globalnetEnabled bool, defaultGlobalCidrRange string, ...) (*v1.ConfigMap, error)
• func UpdateGlobalnetConfigMap(k8sClientset kubernetes.Interface, namespace string, configMap *v1.ConfigMap, ...) error
• func WaitForClientToken(kubeClient kubernetes.Interface, submarinerBrokerSA, inNamespace string) (*v1.Secret, error)
• func WriteInfoToFile(restConfig *rest.Config, brokerNamespace, ipsecFile string, ...) error
• type ClusterInfo
• type Info
  • func ReadInfoFromFile(filename string) (*Info, error)
  • func (d *Info) GetBrokerAdministratorConfig() (*rest.Config, error)
  • func (d *Info) GetComponents() stringset.Interface
  • func (d *Info) IsConnectivityEnabled() bool
  • func (d *Info) IsServiceDiscoveryEnabled() bool

Constants

const (
	GlobalCIDRConfigMapName     = "submariner-globalnet-info"
	GlobalnetStatusKey          = "globalnetEnabled"
	ClusterInfoKey              = "clusterinfo"
	GlobalnetCidrRange          = "globalnetCidrRange"
	GlobalnetClusterSize        = "globalnetClusterSize"
	DefaultGlobalnetCIDR        = "242.0.0.0/8"
	DefaultGlobalnetClusterSize = 65536 // i.e., x.x.x.x/16 subnet mask
)

const InfoFileName = "broker-info.subm"

Functions

func ClusterSAName

func ClusterSAName(clusterID string) string

func CreateGlobalnetConfigMap

func CreateGlobalnetConfigMap(kubeClient kubernetes.Interface, globalnetEnabled bool, defaultGlobalCidrRange string,
	defaultGlobalClusterSize uint, namespace string) error

func CreateNewBrokerRoleBinding

func CreateNewBrokerRoleBinding(kubeClient kubernetes.Interface, serviceAccount, roleName, inNamespace string) (
	brokerRoleBinding *rbacv1.RoleBinding, err error)

nolint:wrapcheck // No need to wrap here

func CreateNewBrokerSA

func CreateNewBrokerSA(kubeClient kubernetes.Interface, submarinerBrokerSA, inNamespace string) (brokerSA *v1.ServiceAccount, err error)

nolint:wrapcheck // No need to wrap here

func CreateOrUpdateBrokerAdminRole

func CreateOrUpdateBrokerAdminRole(clientset kubernetes.Interface, inNamespace string) (created bool, err error)

nolint:wrapcheck // No need to wrap here

func CreateOrUpdateClusterBrokerRole

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

nolint:wrapcheck // No need to wrap here

func CreateSAForCluster

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

CreateSAForCluster creates a new SA, and binds it to the submariner cluster role.

func Ensure

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

func GetGlobalnetConfigMap

func GetGlobalnetConfigMap(kubeClient kubernetes.Interface, namespace string) (*v1.ConfigMap, error)

nolint:wrapcheck // No need to wrap here

func NewBrokerAdminRole

func NewBrokerAdminRole() *rbacv1.Role

Create a role to bind to Broker SA.

func NewBrokerClusterRole

func NewBrokerClusterRole() *rbacv1.Role

Create a role for each Cluster SAs to bind to.

func NewBrokerRoleBinding

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

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

func NewBrokerSA

func NewBrokerSA(submarinerBrokerSA string) *v1.ServiceAccount

func NewGlobalnetConfigMap

func NewGlobalnetConfigMap(globalnetEnabled bool, defaultGlobalCidrRange string,
	defaultGlobalClusterSize uint, namespace string) (*v1.ConfigMap, error)

func UpdateGlobalnetConfigMap

func UpdateGlobalnetConfigMap(k8sClientset kubernetes.Interface, namespace string,
	configMap *v1.ConfigMap, newCluster ClusterInfo) error

func WaitForClientToken

func WaitForClientToken(kubeClient kubernetes.Interface, submarinerBrokerSA, inNamespace string) (*v1.Secret, error)

func WriteInfoToFile

func WriteInfoToFile(restConfig *rest.Config, brokerNamespace, ipsecFile string, components stringset.Interface,
	customDomains []string, status reporter.Interface) error

Types

type ClusterInfo

type ClusterInfo struct {
	ClusterID  string   `json:"cluster_id"`
	GlobalCidr []string `json:"global_cidr"`
}

type Info

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

func ReadInfoFromFile

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

func (*Info) GetBrokerAdministratorConfig

func (d *Info) GetBrokerAdministratorConfig() (*rest.Config, error)

func (*Info) GetComponents

func (d *Info) GetComponents() stringset.Interface

func (*Info) IsConnectivityEnabled

func (d *Info) IsConnectivityEnabled() bool

func (*Info) IsServiceDiscoveryEnabled

func (d *Info) IsServiceDiscoveryEnabled() bool