k8sauthz

Documentation

Index

• Constants
• Variables
• type ClusterRoleMapping
• type Config
  • func NewConfigFromFile(data []byte) (*Config, error)
  • func NewConfigFromFilePath(name string) (*Config, error)
• type GitRepoReconciler
  • func NewGitRepoReconciler(config *Config, userRepo repositories.UserRepository, ...) *GitRepoReconciler
  • func (r *GitRepoReconciler) Reconcile(ctx context.Context) error
  • func (r *GitRepoReconciler) ReconcileUser(ctx context.Context, user *projections.User) error
• type Manager
  • func NewManager(userRepository repositories.UserRepository, ...) *Manager
  • func (m *Manager) Close() error
  • func (m *Manager) Notify(ctx context.Context, u *projections.User)
  • func (m *Manager) Run(ctx context.Context, conf *Config) error
• type TestEnv
  • func NewTestEnv() (*TestEnv, error)
  • func (env *TestEnv) Shutdown() error

Constants

const (
	DefaultTimeout        = 60 * time.Second
	DefaultInterval       = 10 * time.Minute
	DefaultUsernamePrefix = "oidc:"
)

Variables

var (
	ErrRepositoryIsRequired = errors.New("repository is required")
)

Types

type ClusterRoleMapping

type ClusterRoleMapping struct {
	Scope       string `yaml:"scope"`
	Role        string `yaml:"role"`
	ClusterRole string `yaml:"clusterRole"`
}

type Config

type Config struct {

	// Internal is a required field that specifies the interval at which the Git repository must be fetched.
	Interval *time.Duration `yaml:"interval"`
	// Repository is the git config to use
	Repository *git.GitConfig `yaml:"repository"`
	// Mappings define which k8s role in m8 leads to which cluster role within clusters
	Mappings []*ClusterRoleMapping `yaml:"mappings"`
	// UsernamePrefix is prepended to usernames to prevent clashes with existing names (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. Defaults to oidc:.
	UsernamePrefix string `yaml:"usernamePrefix"`
	// AllClusters is an optional field to specify if the RBAC for all clusters should be managed. Defaults to false.
	AllClusters bool `yaml:"allClusters"`
	// Clusters is an optional field to specify a list of clusters for which the RBAC should be managed.
	Clusters []string `yaml:"clusters"`
	// SubDir is the relative path within the repo where to reconcile yamls
	SubDir string `yaml:"subdir"`
	// contains filtered or unexported fields
}

Config is the configuration for the GitRepoReconciler.

func NewConfigFromFile

func NewConfigFromFile(data []byte) (*Config, error)

NewConfigFromFile creates a new GitRepoReconcilerConfig from a given yaml file

func NewConfigFromFilePath

func NewConfigFromFilePath(name string) (*Config, error)

NewConfigFromFile creates a new GitRepoReconcilerConfig from a given yaml file path

type GitRepoReconciler

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

GitRepoReconciler reconciles the resources within the target repo to match the expected state.

func NewGitRepoReconciler

func NewGitRepoReconciler(
	config *Config,
	userRepo repositories.UserRepository,
	clusterAccessRepo repositories.ClusterAccessRepository,
	gitClient *git.GitClient,
) *GitRepoReconciler

NewGitRepoReconciler creates a new GitRepoReconciler configured via the given config.

func (*GitRepoReconciler) Reconcile

func (r *GitRepoReconciler) Reconcile(ctx context.Context) error

func (*GitRepoReconciler) ReconcileUser

func (r *GitRepoReconciler) ReconcileUser(ctx context.Context, user *projections.User) error

type Manager

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

func NewManager

func NewManager(userRepository repositories.UserRepository, clusterAccessRepository repositories.ClusterAccessRepository) *Manager

func (*Manager) Close

func (m *Manager) Close() error

func (*Manager) Notify

func (m *Manager) Notify(ctx context.Context, u *projections.User)

func (*Manager) Run

func (m *Manager) Run(ctx context.Context, conf *Config) error

type TestEnv

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

func NewTestEnv

func NewTestEnv() (*TestEnv, error)

func (*TestEnv) Shutdown

func (env *TestEnv) Shutdown() error