config

Documentation

Index

• Constants
• Variables
• func GetCABundleFileMountPath() string
• func GetConfigRequiredFields() []string
• func GetDurationConfigWithDefault(configName string, value time.Duration) time.Duration
• func GetStringConfigWithDefault(configName, value string) string
• func Manifest(cl client.Client, templatePath string, context interface{}) (mf.Manifest, error)
• func PathTemplateSource(path string, context interface{}) mf.Source

Constants

const (
	DefaultImageValue = "MustSetInConfig"

	CustomCABundleRootMountPath = "/dsp-custom-certs"

	// GlobalODHCaBundleConfigMapName key and label values  are a contract with
	// ODH Platform https://github.com/opendatahub-io/architecture-decision-records/pull/28
	GlobalODHCaBundleConfigMapName = "odh-trusted-ca-bundle"

	CustomDSPTrustedCAConfigMapNamePrefix = "dsp-trusted-ca"
	CustomDSPTrustedCAConfigMapKey        = "dsp-ca.crt"

	MLPipelineUIConfigMapPrefix       = "ds-pipeline-ui-configmap-"
	ArtifactScriptConfigMapNamePrefix = "ds-pipeline-artifact-script-"
	ArtifactScriptConfigMapKey        = "artifact_script"
	DSPServicePrefix                  = "ds-pipeline"

	DBSecretNamePrefix   = "ds-pipeline-db-"
	DBSecretKey          = "password"
	DBDefaultExtraParams = "{\"tls\":\"%t\"}"

	MariaDBName        = "mlpipeline"
	MariaDBHostPrefix  = "mariadb"
	MariaDBHostPort    = "3306"
	MariaDBUser        = "mlpipeline"
	MariaDBNamePVCSize = "10Gi"

	MinioHostPrefix    = "minio"
	MinioPort          = "9000"
	MinioScheme        = "http"
	MinioDefaultBucket = "mlpipeline"
	MinioPVCSize       = "10Gi"

	ObjectStorageSecretName = "mlpipeline-minio-artifact" // hardcoded in kfp-tekton
	ObjectStorageAccessKey  = "accesskey"
	ObjectStorageSecretKey  = "secretkey"

	MlmdGrpcPort          = "8080"
	RequeueTimeConfigName = "DSPO.RequeueTime"
)

const (
	APIServerImagePath            = "Images.ApiServer"
	APIServerArtifactImagePath    = "Images.Artifact"
	PersistenceAgentImagePath     = "Images.PersistentAgent"
	ScheduledWorkflowImagePath    = "Images.ScheduledWorkflow"
	APIServerCacheImagePath       = "Images.Cache"
	APIServerMoveResultsImagePath = "Images.MoveResultsImage"
	MariaDBImagePath              = "Images.MariaDB"
	OAuthProxyImagePath           = "Images.OAuthProxy"
	MlmdEnvoyImagePath            = "Images.MlmdEnvoy"
	MlmdGRPCImagePath             = "Images.MlmdGRPC"
	MlmdWriterImagePath           = "Images.MlmdWriter"
)

DSPO Config File Paths

const (
	DatabaseAvailable      = "DatabaseAvailable"
	ObjectStoreAvailable   = "ObjectStoreAvailable"
	APIServerReady         = "APIServerReady"
	PersistenceAgentReady  = "PersistenceAgentReady"
	ScheduledWorkflowReady = "ScheduledWorkflowReady"
	CrReady                = "Ready"
)

DSPA Status Condition Types

const (
	MinimumReplicasAvailable    = "MinimumReplicasAvailable"
	FailingToDeploy             = "FailingToDeploy"
	Deploying                   = "Deploying"
	ComponentDeploymentNotFound = "ComponentDeploymentNotFound"
)

DSPA Ready Status Condition Reasons As per k8s api convention: Reason is intended to be used in concise output, such as one-line kubectl get output, and in summarizing occurrences of causes

const DefaultDBConnectionTimeout = time.Second * 15

DefaultDBConnectionTimeout is the default DB storage healthcheck timeout

const DefaultMaxConcurrentReconciles = 10

const DefaultObjStoreConnectionTimeout = time.Second * 15

DefaultObjStoreConnectionTimeout is the default Object storage healthcheck timeout

const DefaultRequeueTime = time.Second * 20

Variables

var (
	APIServerResourceRequirements         = createResourceRequirement(resource.MustParse("250m"), resource.MustParse("500Mi"), resource.MustParse("500m"), resource.MustParse("1Gi"))
	PersistenceAgentResourceRequirements  = createResourceRequirement(resource.MustParse("120m"), resource.MustParse("500Mi"), resource.MustParse("250m"), resource.MustParse("1Gi"))
	ScheduledWorkflowResourceRequirements = createResourceRequirement(resource.MustParse("120m"), resource.MustParse("100Mi"), resource.MustParse("250m"), resource.MustParse("250Mi"))
	MariaDBResourceRequirements           = createResourceRequirement(resource.MustParse("300m"), resource.MustParse("800Mi"), resource.MustParse("1"), resource.MustParse("1Gi"))
	MinioResourceRequirements             = createResourceRequirement(resource.MustParse("200m"), resource.MustParse("100Mi"), resource.MustParse("250m"), resource.MustParse("1Gi"))
	MlPipelineUIResourceRequirements      = createResourceRequirement(resource.MustParse("100m"), resource.MustParse("256Mi"), resource.MustParse("100m"), resource.MustParse("256Mi"))
	MlmdEnvoyResourceRequirements         = createResourceRequirement(resource.MustParse("100m"), resource.MustParse("256Mi"), resource.MustParse("100m"), resource.MustParse("256Mi"))
	MlmdGRPCResourceRequirements          = createResourceRequirement(resource.MustParse("100m"), resource.MustParse("256Mi"), resource.MustParse("100m"), resource.MustParse("256Mi"))
	MlmdWriterResourceRequirements        = createResourceRequirement(resource.MustParse("100m"), resource.MustParse("256Mi"), resource.MustParse("100m"), resource.MustParse("256Mi"))
)

Default ResourceRequirements

var PathPrefix string

PathPrefix is the file system path which template paths will be prefixed with. Default is no prefix, which causes paths to be read relative to process working dir

Functions

func GetCABundleFileMountPath

func GetCABundleFileMountPath() string

GetCABundleFileMountPath provides the location in pipeline step-copy-artifact step where the ca bundle is mounted for aws cli to connect to s3 store. Since pipeline step-copy-artifact step uses aws cli, and there are issues surrounding passing a path to aws cli (see: https://github.com/aws/aws-cli/issues/3425#issuecomment-402289636) as such for pipelines, we concatenate the certs into a single cert bundle and use a separate configmap for this

func GetConfigRequiredFields

func GetConfigRequiredFields() []string

func GetDurationConfigWithDefault

func GetDurationConfigWithDefault(configName string, value time.Duration) time.Duration

func GetStringConfigWithDefault

func GetStringConfigWithDefault(configName, value string) string

func Manifest

func Manifest(cl client.Client, templatePath string, context interface{}) (mf.Manifest, error)

func PathTemplateSource

func PathTemplateSource(path string, context interface{}) mf.Source

PathTemplateSource A templating source read from a file