common

Documentation

Index

• Constants
• type APIVersion
  • func (v APIVersion) String() string
• type AuthAction
  • func ParseAuthAction(action string) (AuthAction, error)
  • func (a AuthAction) String() string
• type AuthPolicies
  • func NewAuthPolicies() *AuthPolicies
• type Config

Constants

const DefaultAPIVersion = "v2"

Types

type APIVersion

type APIVersion int

const (
	V1 APIVersion = iota
	V2
	V3
)

func (APIVersion) String

func (v APIVersion) String() string

type AuthAction

type AuthAction string

func ParseAuthAction

func ParseAuthAction(action string) (AuthAction, error)

func (AuthAction) String

func (a AuthAction) String() string

type AuthPolicies

type AuthPolicies struct {
	NamespaceAuth         map[string][]AuthAction            `json:"namespace_auth"`
	DestinationAuth       map[string]map[string][]AuthAction `json:"destination_auth"`
	SubscriptionAuthRoles map[string][]string                `json:"subscription_auth_roles"`
}

func NewAuthPolicies

func NewAuthPolicies() *AuthPolicies

type Config

type Config struct {
	// the web service url that pulsarctl connects to. Default is http://localhost:8080
	WebServiceURL string

	// the bookkeeper service url that pulsarctl connects to.
	BKWebServiceURL string
	// Set the path to the trusted TLS certificate file
	TLSTrustCertsFilePath string
	// Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false)
	TLSAllowInsecureConnection bool

	TLSEnableHostnameVerification bool

	AuthPlugin string

	AuthParams string

	// TLS Cert and Key Files for authentication
	TLSCertFile string
	TLSKeyFile  string

	// Token and TokenFile is used to config the pulsarctl using token to authentication
	Token            string
	TokenFile        string
	PulsarAPIVersion APIVersion

	// OAuth2 configuration
	IssuerEndpoint string
	ClientID       string
	Audience       string
	KeyFile        string
}