cli

package
v3.10.0-0.17.0+incompa... Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 10, 2018 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Index

Constants

View Source 
const PruneRecommendedName = "prune"
View Source 
const SyncRecommendedName = "sync"

Variables

View Source 
var AllowedSourceTypes = []string{string(GroupSyncSourceLDAP), string(GroupSyncSourceOpenShift)}

Functions

func NewCmdPrune 

func NewCmdPrune(name, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command

func NewCmdSync 

func NewCmdSync(name, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command

func ValidateSource 

func ValidateSource(source GroupSyncSource) bool

Types

type ADBuilder 

type ADBuilder struct {
	ClientConfig ldapclient.Config
	Config       *config.ActiveDirectoryConfig
	// contains filtered or unexported fields
}

func (*ADBuilder) GetGroupDetector 

func (b *ADBuilder) GetGroupDetector() (interfaces.LDAPGroupDetector, error)

func (*ADBuilder) GetGroupLister 

func (b *ADBuilder) GetGroupLister() (interfaces.LDAPGroupLister, error)

func (*ADBuilder) GetGroupMemberExtractor 

func (b *ADBuilder) GetGroupMemberExtractor() (interfaces.LDAPMemberExtractor, error)

func (*ADBuilder) GetGroupNameMapper 

func (b *ADBuilder) GetGroupNameMapper() (interfaces.LDAPGroupNameMapper, error)

func (*ADBuilder) GetUserNameMapper 

func (b *ADBuilder) GetUserNameMapper() (interfaces.LDAPUserNameMapper, error)

type AugmentedADBuilder 

type AugmentedADBuilder struct {
	ClientConfig ldapclient.Config
	Config       *config.AugmentedActiveDirectoryConfig
	// contains filtered or unexported fields
}

func (*AugmentedADBuilder) GetGroupDetector 

func (b *AugmentedADBuilder) GetGroupDetector() (interfaces.LDAPGroupDetector, error)

func (*AugmentedADBuilder) GetGroupLister 

func (b *AugmentedADBuilder) GetGroupLister() (interfaces.LDAPGroupLister, error)

func (*AugmentedADBuilder) GetGroupMemberExtractor 

func (b *AugmentedADBuilder) GetGroupMemberExtractor() (interfaces.LDAPMemberExtractor, error)

func (*AugmentedADBuilder) GetGroupNameMapper 

func (b *AugmentedADBuilder) GetGroupNameMapper() (interfaces.LDAPGroupNameMapper, error)

func (*AugmentedADBuilder) GetUserNameMapper 

func (b *AugmentedADBuilder) GetUserNameMapper() (interfaces.LDAPUserNameMapper, error)

type GroupNameRestrictions 

type GroupNameRestrictions interface {
	GetWhitelist() []string
	GetBlacklist() []string
}

GroupNameRestrictions desribes an object that holds blacklists and whitelists

type GroupSyncSource 

type GroupSyncSource string

GroupSyncSource determines the source of the groups to be synced 

const (
	// GroupSyncSourceLDAP determines that the groups to be synced are determined from an LDAP record
	GroupSyncSourceLDAP GroupSyncSource = "ldap"
	// GroupSyncSourceOpenShift determines that the groups to be synced are determined from OpenShift records
	GroupSyncSourceOpenShift GroupSyncSource = "openshift"
)

type MappedNameRestrictions 

type MappedNameRestrictions interface {
	GetGroupNameMappings() map[string]string
}

MappedNameRestrictions describes an object that holds user name mappings for a group sync job

type OpenShiftGroupNameRestrictions 

type OpenShiftGroupNameRestrictions interface {
	GroupNameRestrictions
	GetClient() usertypedclient.GroupInterface
}

OpenShiftGroupNameRestrictions describes an object that holds blacklists and whitelists as well as a client that can retrieve OpenShift groups to satisfy those lists

type PruneBuilder 

type PruneBuilder interface {
	GetGroupLister() (interfaces.LDAPGroupLister, error)
	GetGroupNameMapper() (interfaces.LDAPGroupNameMapper, error)
	GetGroupDetector() (interfaces.LDAPGroupDetector, error)
}

PruneBuilder describes an object that can build all the schema-specific parts of an LDAPGroupPruner

type PruneOptions 

type PruneOptions struct {
	// Config is the LDAP sync config read from file
	Config *config.LDAPSyncConfig

	// Whitelist are the names of OpenShift group or LDAP group UIDs to use for syncing
	Whitelist []string

	// Blacklist are the names of OpenShift group or LDAP group UIDs to exclude
	Blacklist []string

	// Confirm determines whether or not to write to OpenShift
	Confirm bool

	// GroupInterface is the interface used to interact with OpenShift Group objects
	GroupInterface usertypedclient.GroupInterface

	// Stderr is the writer to write warnings and errors to
	Stderr io.Writer

	// Out is the writer to write output to
	Out io.Writer
}

func NewPruneOptions 

func NewPruneOptions() *PruneOptions

func (*PruneOptions) Complete 

func (o *PruneOptions) Complete(whitelistFile, blacklistFile, configFile string, args []string, f *clientcmd.Factory) error

func (*PruneOptions) GetBlacklist 

func (o *PruneOptions) GetBlacklist() []string

func (*PruneOptions) GetClient 

func (o *PruneOptions) GetClient() usertypedclient.GroupInterface

func (*PruneOptions) GetGroupNameMappings 

func (o *PruneOptions) GetGroupNameMappings() map[string]string

func (*PruneOptions) GetWhitelist 

func (o *PruneOptions) GetWhitelist() []string

func (*PruneOptions) Run 

func (o *PruneOptions) Run(cmd *cobra.Command, f *clientcmd.Factory) error

Run creates the GroupSyncer specified and runs it to sync groups the arguments are only here because its the only way to get the printer we need

func (*PruneOptions) Validate 

func (o *PruneOptions) Validate() error

type RFC2307Builder 

type RFC2307Builder struct {
	ClientConfig ldapclient.Config
	Config       *config.RFC2307Config

	ErrorHandler syncerror.Handler
	// contains filtered or unexported fields
}

func (*RFC2307Builder) GetGroupDetector 

func (b *RFC2307Builder) GetGroupDetector() (interfaces.LDAPGroupDetector, error)

func (*RFC2307Builder) GetGroupLister 

func (b *RFC2307Builder) GetGroupLister() (interfaces.LDAPGroupLister, error)

func (*RFC2307Builder) GetGroupMemberExtractor 

func (b *RFC2307Builder) GetGroupMemberExtractor() (interfaces.LDAPMemberExtractor, error)

func (*RFC2307Builder) GetGroupNameMapper 

func (b *RFC2307Builder) GetGroupNameMapper() (interfaces.LDAPGroupNameMapper, error)

func (*RFC2307Builder) GetUserNameMapper 

func (b *RFC2307Builder) GetUserNameMapper() (interfaces.LDAPUserNameMapper, error)

type SyncBuilder 

type SyncBuilder interface {
	GetGroupLister() (interfaces.LDAPGroupLister, error)
	GetGroupNameMapper() (interfaces.LDAPGroupNameMapper, error)
	GetUserNameMapper() (interfaces.LDAPUserNameMapper, error)
	GetGroupMemberExtractor() (interfaces.LDAPMemberExtractor, error)
}

SyncBuilder describes an object that can build all the schema-specific parts of an LDAPGroupSyncer

type SyncOptions 

type SyncOptions struct {
	// Source determines the source of the list of groups to sync
	Source GroupSyncSource

	// Config is the LDAP sync config read from file
	Config *config.LDAPSyncConfig

	// Whitelist are the names of OpenShift group or LDAP group UIDs to use for syncing
	Whitelist []string

	// Blacklist are the names of OpenShift group or LDAP group UIDs to exclude
	Blacklist []string

	// Confirm determines whether or not to write to OpenShift
	Confirm bool

	// GroupInterface is the interface used to interact with OpenShift Group objects
	GroupInterface usertypedclient.GroupInterface

	// Stderr is the writer to write warnings and errors to
	Stderr io.Writer

	// Out is the writer to write output to
	Out io.Writer
}

func NewSyncOptions 

func NewSyncOptions() *SyncOptions

func (*SyncOptions) Complete 

func (o *SyncOptions) Complete(typeArg, whitelistFile, blacklistFile, configFile string, args []string, f *clientcmd.Factory) error

func (*SyncOptions) CreateErrorHandler 

func (o *SyncOptions) CreateErrorHandler() syncerror.Handler

CreateErrorHandler creates an error handler for the LDAP sync job

func (*SyncOptions) GetBlacklist 

func (o *SyncOptions) GetBlacklist() []string

func (*SyncOptions) GetClient 

func (o *SyncOptions) GetClient() usertypedclient.GroupInterface

func (*SyncOptions) GetGroupNameMappings 

func (o *SyncOptions) GetGroupNameMappings() map[string]string

func (*SyncOptions) GetWhitelist 

func (o *SyncOptions) GetWhitelist() []string

func (*SyncOptions) Run 

func (o *SyncOptions) Run(cmd *cobra.Command, f *clientcmd.Factory) error

Run creates the GroupSyncer specified and runs it to sync groups the arguments are only here because its the only way to get the printer we need

func (*SyncOptions) Validate 

func (o *SyncOptions) Validate() error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.