Copyright	(c) Red Hat 2022
License	Apache-2.0
Maintainer	tdecacqu@redhat.com, fboucher@redhat.com
Stability	provisional
Portability	portable
Safe Haskell	Safe-Inferred
Language	GHC2021

Zuul.Tenant

Description

The Zuul Tenants configuration (main.yaml)

Synopsis

newtype TenantsConfig = TenantsConfig {
- tenants :: Map TenantName TenantConfig
}
data TenantConfig = TenantConfig {
- defaultParent :: JobName
- connections :: Map ConnectionName TenantConnectionConfig
}
data TenantConnectionConfig = TenantConnectionConfig {
- configProjects :: [TenantProject]
- untrustedProjects :: [TenantProject]
}
data TenantProject = TenantProject {
- name :: ProjectName
- includedConfigElements :: Set ZuulConfigType
- configPaths :: [FilePathT]
}
decodeTenantsConfig :: ZKTenantsConfig -> Either Text TenantsConfig
data TenantResolver = TenantResolver {
- resolveTenants :: ConfigLoc -> ZuulConfigType -> Set TenantName
- resolveProject :: ConfigLoc -> ProjectName -> Maybe CanonicalProjectName
}
mkResolver :: ServiceConfig -> TenantsConfig -> TenantResolver

Documentation

newtype TenantsConfig Source #

All the tenants configuration.

Constructors

TenantsConfig
Fields tenants :: Map TenantName TenantConfig

Instances

Instances details

Generic TenantsConfig Source #
Instance details Defined in Zuul.Tenant Associated Types type Rep TenantsConfig :: Type -> Type # Methods from :: TenantsConfig -> Rep TenantsConfig x # to :: Rep TenantsConfig x -> TenantsConfig #
Show TenantsConfig Source #
Instance details Defined in Zuul.Tenant Methods showsPrec :: Int -> TenantsConfig -> ShowS # show :: TenantsConfig -> String # showList :: [TenantsConfig] -> ShowS #
Eq TenantsConfig Source #
Instance details Defined in Zuul.Tenant Methods (==) :: TenantsConfig -> TenantsConfig -> Bool # (/=) :: TenantsConfig -> TenantsConfig -> Bool #
Ord TenantsConfig Source #
Instance details Defined in Zuul.Tenant Methods compare :: TenantsConfig -> TenantsConfig -> Ordering # (<) :: TenantsConfig -> TenantsConfig -> Bool # (<=) :: TenantsConfig -> TenantsConfig -> Bool # (>) :: TenantsConfig -> TenantsConfig -> Bool # (>=) :: TenantsConfig -> TenantsConfig -> Bool # max :: TenantsConfig -> TenantsConfig -> TenantsConfig # min :: TenantsConfig -> TenantsConfig -> TenantsConfig #
type Rep TenantsConfig Source #
Instance details Defined in Zuul.Tenant type Rep TenantsConfig = D1 ('MetaData "TenantsConfig" "Zuul.Tenant" "zuul-weeder-0.1.0.0-inplace" 'True) (C1 ('MetaCons "TenantsConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "tenants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TenantName TenantConfig))))

data TenantConfig Source #

Single tenant configuration.

Constructors

TenantConfig
Fields defaultParent :: JobName The default base job name, default to "base". connections :: Map ConnectionName TenantConnectionConfig The list of project grouped per source connection.

Instances

Instances details

Generic TenantConfig Source #
Instance details Defined in Zuul.Tenant Associated Types type Rep TenantConfig :: Type -> Type # Methods from :: TenantConfig -> Rep TenantConfig x # to :: Rep TenantConfig x -> TenantConfig #
Show TenantConfig Source #
Instance details Defined in Zuul.Tenant Methods showsPrec :: Int -> TenantConfig -> ShowS # show :: TenantConfig -> String # showList :: [TenantConfig] -> ShowS #
Eq TenantConfig Source #
Instance details Defined in Zuul.Tenant Methods (==) :: TenantConfig -> TenantConfig -> Bool # (/=) :: TenantConfig -> TenantConfig -> Bool #
Ord TenantConfig Source #
Instance details Defined in Zuul.Tenant Methods compare :: TenantConfig -> TenantConfig -> Ordering # (<) :: TenantConfig -> TenantConfig -> Bool # (<=) :: TenantConfig -> TenantConfig -> Bool # (>) :: TenantConfig -> TenantConfig -> Bool # (>=) :: TenantConfig -> TenantConfig -> Bool # max :: TenantConfig -> TenantConfig -> TenantConfig # min :: TenantConfig -> TenantConfig -> TenantConfig #
type Rep TenantConfig Source #
Instance details Defined in Zuul.Tenant type Rep TenantConfig = D1 ('MetaData "TenantConfig" "Zuul.Tenant" "zuul-weeder-0.1.0.0-inplace" 'False) (C1 ('MetaCons "TenantConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "defaultParent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobName) :*: S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ConnectionName TenantConnectionConfig))))

data TenantConnectionConfig Source #

The tenant connection source configuration.

Constructors

TenantConnectionConfig
Fields configProjects :: [TenantProject] The config projects untrustedProjects :: [TenantProject] The untrusted projects

Instances

Instances details

Generic TenantConnectionConfig Source #
Instance details Defined in Zuul.Tenant Associated Types type Rep TenantConnectionConfig :: Type -> Type # Methods from :: TenantConnectionConfig -> Rep TenantConnectionConfig x # to :: Rep TenantConnectionConfig x -> TenantConnectionConfig #
Show TenantConnectionConfig Source #
Instance details Defined in Zuul.Tenant Methods showsPrec :: Int -> TenantConnectionConfig -> ShowS # show :: TenantConnectionConfig -> String # showList :: [TenantConnectionConfig] -> ShowS #
Eq TenantConnectionConfig Source #
Instance details Defined in Zuul.Tenant Methods (==) :: TenantConnectionConfig -> TenantConnectionConfig -> Bool # (/=) :: TenantConnectionConfig -> TenantConnectionConfig -> Bool #
Ord TenantConnectionConfig Source #
Instance details Defined in Zuul.Tenant Methods compare :: TenantConnectionConfig -> TenantConnectionConfig -> Ordering # (<) :: TenantConnectionConfig -> TenantConnectionConfig -> Bool # (<=) :: TenantConnectionConfig -> TenantConnectionConfig -> Bool # (>) :: TenantConnectionConfig -> TenantConnectionConfig -> Bool # (>=) :: TenantConnectionConfig -> TenantConnectionConfig -> Bool # max :: TenantConnectionConfig -> TenantConnectionConfig -> TenantConnectionConfig # min :: TenantConnectionConfig -> TenantConnectionConfig -> TenantConnectionConfig #
type Rep TenantConnectionConfig Source #
Instance details Defined in Zuul.Tenant type Rep TenantConnectionConfig = D1 ('MetaData "TenantConnectionConfig" "Zuul.Tenant" "zuul-weeder-0.1.0.0-inplace" 'False) (C1 ('MetaCons "TenantConnectionConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "configProjects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TenantProject]) :*: S1 ('MetaSel ('Just "untrustedProjects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TenantProject])))

data TenantProject Source #

The project configuration for a tenant.

Constructors

TenantProject
Fields name :: ProjectName The project name. includedConfigElements :: Set ZuulConfigType The list of included elements. configPaths :: [FilePathT] The list of config location prefix, default to: [".zuul.yaml", "zuul.yaml", "zuul.d", ".zuul.d"]

Instances

Instances details

Generic TenantProject Source #
Instance details Defined in Zuul.Tenant Associated Types type Rep TenantProject :: Type -> Type # Methods from :: TenantProject -> Rep TenantProject x # to :: Rep TenantProject x -> TenantProject #
Show TenantProject Source #
Instance details Defined in Zuul.Tenant Methods showsPrec :: Int -> TenantProject -> ShowS # show :: TenantProject -> String # showList :: [TenantProject] -> ShowS #
Eq TenantProject Source #
Instance details Defined in Zuul.Tenant Methods (==) :: TenantProject -> TenantProject -> Bool # (/=) :: TenantProject -> TenantProject -> Bool #
Ord TenantProject Source #
Instance details Defined in Zuul.Tenant Methods compare :: TenantProject -> TenantProject -> Ordering # (<) :: TenantProject -> TenantProject -> Bool # (<=) :: TenantProject -> TenantProject -> Bool # (>) :: TenantProject -> TenantProject -> Bool # (>=) :: TenantProject -> TenantProject -> Bool # max :: TenantProject -> TenantProject -> TenantProject # min :: TenantProject -> TenantProject -> TenantProject #
type Rep TenantProject Source #
Instance details Defined in Zuul.Tenant type Rep TenantProject = D1 ('MetaData "TenantProject" "Zuul.Tenant" "zuul-weeder-0.1.0.0-inplace" 'False) (C1 ('MetaCons "TenantProject" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectName) :: (S1 ('MetaSel ('Just "includedConfigElements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set ZuulConfigType)) :: S1 ('MetaSel ('Just "configPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePathT]))))

decodeTenantsConfig :: ZKTenantsConfig -> Either Text TenantsConfig Source #

Decode the TenantsConfig from a ZK data file.

data TenantResolver Source #

Tenant information to resolve project location

Constructors

TenantResolver
Fields resolveTenants :: ConfigLoc -> ZuulConfigType -> Set TenantName resolveProject :: ConfigLoc -> ProjectName -> Maybe CanonicalProjectName

mkResolver Source #

Arguments

:: ServiceConfig	The zuul.conf for the list of connection names
-> TenantsConfig	The main.yaml tenants config
-> TenantResolver