internal

Documentation

Index

• Variables
• func AllowedNamespace(rmq topology.RabbitmqClusterReference, requestNamespace string, ...) bool
• func GenerateBindingInfo(binding *topology.Binding) (*rabbithole.BindingInfo, error)
• func GenerateExchangeSettings(e *topology.Exchange) (*rabbithole.ExchangeSettings, error)
• func GenerateFederationDefinition(f *topology.Federation, uri string) rabbithole.FederationDefinition
• func GeneratePermissions(p *topology.Permission) rabbithole.Permissions
• func GeneratePolicy(p *topology.Policy) (*rabbithole.Policy, error)
• func GeneratePropertiesKey(binding *topology.Binding) string
• func GenerateQueueSettings(q *topology.Queue) (*rabbithole.QueueSettings, error)
• func GenerateShovelDefinition(s *topology.Shovel, srcUri, destUri string) rabbithole.ShovelDefinition
• func GenerateUserSettings(credentials *corev1.Secret, tags []topology.UserTag) (rabbithole.UserSettings, error)
• func GenerateVhostSettings(v *topology.Vhost) *rabbithole.VhostSettings
• func InitializeClient() func()
• func LoginToVault(vaultClient *vault.Client, authPath string, params map[string]interface{}) (*vault.Secret, error)
• func RandomEncodedString(dataLen int) (string, error)
• func ReadServiceAccountToken() ([]byte, error)
• func ReadVaultClientSecret(vaultClient *vault.Client, jwtToken string, vaultRole string, authPath string) (*vault.Secret, error)
• type ClusterCredentials
  • func (c ClusterCredentials) Data(key string) ([]byte, bool)
• type ConnectionCredentials
  • func ParseRabbitmqClusterReference(ctx context.Context, c client.Client, rmq topology.RabbitmqClusterReference, ...) (ConnectionCredentials, bool, error)
• type RabbitMQClient
• type RabbitMQClientFactory
• type SecretReader
• type SecretStoreClient
  • func GetSecretStoreClient() (SecretStoreClient, error)
• type UpstreamEndpoints
  • func GenerateSchemaReplicationParameters(secret *corev1.Secret, endpoints string) (UpstreamEndpoints, error)
• type VaultClient
  • func (vc VaultClient) ReadCredentials(path string) (string, string, error)
• type VaultSecretReader
  • func (s VaultSecretReader) ReadSecret(path string) (*vault.Secret, error)

Variables

var (
	NoSuchRabbitmqClusterError = errors.New("RabbitmqCluster object does not exist")
	ResourceNotAllowedError    = errors.New("resource is not allowed to reference defined cluster reference. Check the namespace of the resource is allowed as part of the cluster's `rabbitmq.com/topology-allowed-namespaces` annotation")
	NoServiceReferenceSetError = errors.New("RabbitmqCluster has no ServiceReference set in status.defaultUser")
)

var (
	ReadServiceAccountTokenFunc = ReadServiceAccountToken
	ReadVaultClientSecretFunc   = ReadVaultClientSecret
	LoginToVaultFunc            = LoginToVault
	FirstLoginAttemptResultCh   = make(chan error, 1)
)

Created - and exported from package - for testing purposes

var (
	SecretClient              SecretStoreClient
	SecretClientCreationError error
)

var SecretStoreClientProvider = GetSecretStoreClient

Functions

func AllowedNamespace

func AllowedNamespace(rmq topology.RabbitmqClusterReference, requestNamespace string, cluster *rabbitmqv1beta1.RabbitmqCluster) bool

func GenerateBindingInfo

func GenerateBindingInfo(binding *topology.Binding) (*rabbithole.BindingInfo, error)

func GenerateExchangeSettings

func GenerateExchangeSettings(e *topology.Exchange) (*rabbithole.ExchangeSettings, error)

func GenerateFederationDefinition

func GenerateFederationDefinition(f *topology.Federation, uri string) rabbithole.FederationDefinition

func GeneratePermissions

func GeneratePermissions(p *topology.Permission) rabbithole.Permissions

func GeneratePolicy

func GeneratePolicy(p *topology.Policy) (*rabbithole.Policy, error)

func GeneratePropertiesKey

func GeneratePropertiesKey(binding *topology.Binding) string

func GenerateQueueSettings

func GenerateQueueSettings(q *topology.Queue) (*rabbithole.QueueSettings, error)

generates rabbithole.QueueSettings for a given Queue queue.Spec.Arguments (type k8s runtime.RawExtensions) is unmarshalled Unmarshall stores float64, for JSON numbers See: https://golang.org/pkg/encoding/json/#Unmarshal

func GenerateShovelDefinition

func GenerateShovelDefinition(s *topology.Shovel, srcUri, destUri string) rabbithole.ShovelDefinition

func GenerateUserSettings

func GenerateUserSettings(credentials *corev1.Secret, tags []topology.UserTag) (rabbithole.UserSettings, error)

func GenerateVhostSettings

func GenerateVhostSettings(v *topology.Vhost) *rabbithole.VhostSettings

func InitializeClient

func InitializeClient() func()

func LoginToVault

func LoginToVault(vaultClient *vault.Client, authPath string, params map[string]interface{}) (*vault.Secret, error)

func RandomEncodedString

func RandomEncodedString(dataLen int) (string, error)

func ReadServiceAccountToken

func ReadServiceAccountToken() ([]byte, error)

func ReadVaultClientSecret

func ReadVaultClientSecret(vaultClient *vault.Client, jwtToken string, vaultRole string, authPath string) (*vault.Secret, error)

Types

type ClusterCredentials

type ClusterCredentials struct {
	// contains filtered or unexported fields
}

func (ClusterCredentials) Data

func (c ClusterCredentials) Data(key string) ([]byte, bool)

type ConnectionCredentials

type ConnectionCredentials interface {
	Data(key string) ([]byte, bool)
}

func ParseRabbitmqClusterReference

func ParseRabbitmqClusterReference(ctx context.Context, c client.Client, rmq topology.RabbitmqClusterReference, requestNamespace string, clusterDomain string) (ConnectionCredentials, bool, error)

type RabbitMQClient

type RabbitMQClient interface {
	PutUser(string, rabbithole.UserSettings) (*http.Response, error)
	DeleteUser(string) (*http.Response, error)
	DeclareBinding(string, rabbithole.BindingInfo) (*http.Response, error)
	DeleteBinding(string, rabbithole.BindingInfo) (*http.Response, error)
	ListQueueBindingsBetween(string, string, string) ([]rabbithole.BindingInfo, error)
	ListExchangeBindingsBetween(string, string, string) ([]rabbithole.BindingInfo, error)
	UpdatePermissionsIn(string, string, rabbithole.Permissions) (*http.Response, error)
	ClearPermissionsIn(string, string) (*http.Response, error)
	PutPolicy(string, string, rabbithole.Policy) (*http.Response, error)
	DeletePolicy(string, string) (*http.Response, error)
	DeclareQueue(string, string, rabbithole.QueueSettings) (*http.Response, error)
	DeleteQueue(string, string, ...rabbithole.QueueDeleteOptions) (*http.Response, error)
	DeclareExchange(string, string, rabbithole.ExchangeSettings) (*http.Response, error)
	DeleteExchange(string, string) (*http.Response, error)
	PutVhost(string, rabbithole.VhostSettings) (*http.Response, error)
	DeleteVhost(string) (*http.Response, error)
	PutGlobalParameter(name string, value interface{}) (*http.Response, error)
	DeleteGlobalParameter(name string) (*http.Response, error)
	PutFederationUpstream(vhost, name string, def rabbithole.FederationDefinition) (res *http.Response, err error)
	DeleteFederationUpstream(vhost, name string) (res *http.Response, err error)
	DeclareShovel(vhost, shovel string, info rabbithole.ShovelDefinition) (res *http.Response, err error)
	DeleteShovel(vhost, shovel string) (res *http.Response, err error)
}

type RabbitMQClientFactory

type RabbitMQClientFactory func(connectionCreds ConnectionCredentials, tlsEnabled bool, certPool *x509.CertPool) (RabbitMQClient, error)

var RabbitholeClientFactory RabbitMQClientFactory = func(connectionCreds ConnectionCredentials, tlsEnabled bool, certPool *x509.CertPool) (RabbitMQClient, error) {
	return generateRabbitholeClient(connectionCreds, tlsEnabled, certPool)
}

type SecretReader

type SecretReader interface {
	ReadSecret(path string) (*vault.Secret, error)
}

type SecretStoreClient

type SecretStoreClient interface {
	ReadCredentials(path string) (string, string, error)
}

func GetSecretStoreClient

func GetSecretStoreClient() (SecretStoreClient, error)

type UpstreamEndpoints

type UpstreamEndpoints struct {
	Username  string   `json:"username"`
	Password  string   `json:"password"`
	Endpoints []string `json:"endpoints"`
}

func GenerateSchemaReplicationParameters

func GenerateSchemaReplicationParameters(secret *corev1.Secret, endpoints string) (UpstreamEndpoints, error)

type VaultClient

type VaultClient struct {
	Reader SecretReader
}

func (VaultClient) ReadCredentials

func (vc VaultClient) ReadCredentials(path string) (string, string, error)

type VaultSecretReader

type VaultSecretReader struct {
	// contains filtered or unexported fields
}

func (VaultSecretReader) ReadSecret

func (s VaultSecretReader) ReadSecret(path string) (*vault.Secret, error)