Documentation
¶
Index ¶
- Constants
- Variables
- func NewCmdPrune(name, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdSync(name, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func ValidateSource(source GroupSyncSource) bool
- type ADBuilder
- func (b *ADBuilder) GetGroupDetector() (interfaces.LDAPGroupDetector, error)
- func (b *ADBuilder) GetGroupLister() (interfaces.LDAPGroupLister, error)
- func (b *ADBuilder) GetGroupMemberExtractor() (interfaces.LDAPMemberExtractor, error)
- func (b *ADBuilder) GetGroupNameMapper() (interfaces.LDAPGroupNameMapper, error)
- func (b *ADBuilder) GetUserNameMapper() (interfaces.LDAPUserNameMapper, error)
- type AugmentedADBuilder
- func (b *AugmentedADBuilder) GetGroupDetector() (interfaces.LDAPGroupDetector, error)
- func (b *AugmentedADBuilder) GetGroupLister() (interfaces.LDAPGroupLister, error)
- func (b *AugmentedADBuilder) GetGroupMemberExtractor() (interfaces.LDAPMemberExtractor, error)
- func (b *AugmentedADBuilder) GetGroupNameMapper() (interfaces.LDAPGroupNameMapper, error)
- func (b *AugmentedADBuilder) GetUserNameMapper() (interfaces.LDAPUserNameMapper, error)
- type GroupNameRestrictions
- type GroupSyncSource
- type MappedNameRestrictions
- type OpenShiftGroupNameRestrictions
- type PruneBuilder
- type PruneOptions
- func (o *PruneOptions) Complete(whitelistFile, blacklistFile, configFile string, args []string, ...) error
- func (o *PruneOptions) GetBlacklist() []string
- func (o *PruneOptions) GetClient() osclient.GroupInterface
- func (o *PruneOptions) GetGroupNameMappings() map[string]string
- func (o *PruneOptions) GetWhitelist() []string
- func (o *PruneOptions) Run(cmd *cobra.Command, f *clientcmd.Factory) error
- func (o *PruneOptions) Validate() error
- type RFC2307Builder
- func (b *RFC2307Builder) GetGroupDetector() (interfaces.LDAPGroupDetector, error)
- func (b *RFC2307Builder) GetGroupLister() (interfaces.LDAPGroupLister, error)
- func (b *RFC2307Builder) GetGroupMemberExtractor() (interfaces.LDAPMemberExtractor, error)
- func (b *RFC2307Builder) GetGroupNameMapper() (interfaces.LDAPGroupNameMapper, error)
- func (b *RFC2307Builder) GetUserNameMapper() (interfaces.LDAPUserNameMapper, error)
- type SyncBuilder
- type SyncOptions
- func (o *SyncOptions) Complete(typeArg, whitelistFile, blacklistFile, configFile string, args []string, ...) error
- func (o *SyncOptions) CreateErrorHandler() syncerror.Handler
- func (o *SyncOptions) GetBlacklist() []string
- func (o *SyncOptions) GetClient() osclient.GroupInterface
- func (o *SyncOptions) GetGroupNameMappings() map[string]string
- func (o *SyncOptions) GetWhitelist() []string
- func (o *SyncOptions) Run(cmd *cobra.Command, f *clientcmd.Factory) error
- func (o *SyncOptions) Validate() error
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 *api.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 *api.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() client.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 *api.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
// GroupsInterface is the interface used to interact with OpenShift Group objects
GroupInterface osclient.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) GetGroupNameMappings ¶
func (o *PruneOptions) GetGroupNameMappings() map[string]string
func (*PruneOptions) GetWhitelist ¶
func (o *PruneOptions) GetWhitelist() []string
type RFC2307Builder ¶
type RFC2307Builder struct {
ClientConfig ldapclient.Config
Config *api.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 *api.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
// GroupsInterface is the interface used to interact with OpenShift Group objects
GroupInterface osclient.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 ¶ added in v1.1.3
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) GetGroupNameMappings ¶
func (o *SyncOptions) GetGroupNameMappings() map[string]string
func (*SyncOptions) GetWhitelist ¶
func (o *SyncOptions) GetWhitelist() []string
Source Files
¶
Click to show internal directories.
Click to hide internal directories.