configuration

Documentation

Index

• type ArmadaConfig
• type BasicAuthenticationConfig
• type EventRetentionPolicy
• type KafkaConfig
• type KerberosAuthenticationConfig
• type LeaseSettings
• type MetricsConfig
• type NatsConfig
• type OpenIdAuthenticationConfig
• type QueueManagementConfig
• type SchedulingConfig
  • func (c *SchedulingConfig) GetResourceScarcity(pool string) map[string]float64
• type UserInfo

Types

type ArmadaConfig

type ArmadaConfig struct {
	AnonymousAuth bool

	GrpcPort               uint16
	HttpPort               uint16
	MetricsPort            uint16
	CorsAllowedOrigins     []string
	PriorityHalfTime       time.Duration
	Redis                  redis.UniversalOptions
	EventsKafka            KafkaConfig
	EventsNats             NatsConfig
	EventsRedis            redis.UniversalOptions
	BasicAuth              BasicAuthenticationConfig
	OpenIdAuth             OpenIdAuthenticationConfig
	Kerberos               KerberosAuthenticationConfig
	PermissionGroupMapping map[permissions.Permission][]string
	PermissionScopeMapping map[permissions.Permission][]string
	PermissionClaimMapping map[permissions.Permission][]string

	Scheduling      SchedulingConfig
	QueueManagement QueueManagementConfig
	EventRetention  EventRetentionPolicy
	Metrics         MetricsConfig
}

type BasicAuthenticationConfig

type BasicAuthenticationConfig struct {
	Users map[string]UserInfo
}

type EventRetentionPolicy

type EventRetentionPolicy struct {
	ExpiryEnabled     bool
	RetentionDuration time.Duration
}

type KafkaConfig

type KafkaConfig struct {
	Brokers                  []string
	Topic                    string
	ConsumerGroupID          string
	JobStatusConsumerGroupID string
}

type KerberosAuthenticationConfig

type KerberosAuthenticationConfig struct {
	KeytabLocation string
	PrincipalName  string
	UserNameSuffix string
}

type LeaseSettings

type LeaseSettings struct {
	ExpireAfter        time.Duration
	ExpiryLoopInterval time.Duration
}

type MetricsConfig

type MetricsConfig struct {
	RefreshInterval time.Duration
}

type NatsConfig

type NatsConfig struct {
	Servers        []string
	ClusterID      string
	Subject        string
	QueueGroup     string
	JobStatusGroup string
}

type OpenIdAuthenticationConfig

type OpenIdAuthenticationConfig struct {
	ProviderUrl string
	GroupsClaim string

	// If your OIDC provider signs token with key intended solely for this application and audience claim does not
	// contain any clientId, you can disable client ID check.
	// Otherwise clientId is required
	SkipClientIDCheck bool
	ClientId          string
}

type QueueManagementConfig

type QueueManagementConfig struct {
	AutoCreateQueues      bool
	DefaultPriorityFactor float64
}

type SchedulingConfig

type SchedulingConfig struct {
	UseProbabilisticSchedulingForAllResources bool
	QueueLeaseBatchSize                       uint
	MinimumResourceToSchedule                 common.ComputeResourcesFloat
	MaximalClusterFractionToSchedule          map[string]float64
	MaximalResourceFractionToSchedulePerQueue map[string]float64
	MaximalResourceFractionPerQueue           map[string]float64
	Lease                                     LeaseSettings
	DefaultJobLimits                          common.ComputeResources
	MaxRetries                                uint // Maximum number of retries before a Job is failed
	ResourceScarcity                          map[string]float64
	PoolResourceScarcity                      map[string]map[string]float64
}

func (*SchedulingConfig) GetResourceScarcity

func (c *SchedulingConfig) GetResourceScarcity(pool string) map[string]float64

type UserInfo

type UserInfo struct {
	Password string
	Groups   []string
}