Documentation
¶
Index ¶
- Constants
- func EnableAlphaAPIFields(ctx context.Context) context.Context
- func GetArtifactBucketConfigName() string
- func GetArtifactPVCConfigName() string
- func GetDefaultsConfigName() string
- func GetFeatureFlagsConfigName() string
- func GetMetricsConfigName() string
- func IsSubstituted(ctx context.Context) bool
- func SkipValidationDueToPropagatedParametersAndWorkspaces(ctx context.Context, skip bool) context.Context
- func ToContext(ctx context.Context, c *Config) context.Context
- func ValidateParameterVariablesAndWorkspaces(ctx context.Context) bool
- func WithinSubstituted(ctx context.Context) context.Context
- type ArtifactBucket
- type ArtifactPVC
- type Config
- type Defaults
- type FeatureFlags
- type Metrics
- type Store
Constants ¶
const ( // BucketLocationKey is the name of the configmap entry that specifies // loction of the bucket. BucketLocationKey = "location" // BucketServiceAccountSecretNameKey is the name of the configmap entry that specifies // the name of the secret that will provide the servie account with bucket access. // This secret must have a key called serviceaccount that will have a value with // the service account with access to the bucket BucketServiceAccountSecretNameKey = "bucket.service.account.secret.name" // BucketServiceAccountSecretKeyKey is the name of the configmap entry that specifies // the secret key that will have a value with the service account json with access // to the bucket BucketServiceAccountSecretKeyKey = "bucket.service.account.secret.key" // DefaultBucketServiceFieldName defaults to a gcs bucket DefaultBucketServiceFieldName = "GOOGLE_APPLICATION_CREDENTIALS" // BucketServiceAccountFieldNameKey is the name of the configmap entry that specifies // the field name that should be used for the service account. // Valid values: GOOGLE_APPLICATION_CREDENTIALS, BOTO_CONFIG. BucketServiceAccountFieldNameKey = "bucket.service.account.field.name" )
const ( // DefaultPVCSize is the default size of the PVC to create DefaultPVCSize = "5Gi" // PVCSizeKey is the name of the configmap entry that specifies the size of the PVC to create PVCSizeKey = "size" // PVCStorageClassNameKey is the name of the configmap entry that specifies the storage class of the PVC to create PVCStorageClassNameKey = "storageClassName" )
const ( // DefaultTimeoutMinutes is used when no timeout is specified. DefaultTimeoutMinutes = 60 // NoTimeoutDuration is used when a pipeline or task should never time out. NoTimeoutDuration = 0 * time.Minute // DefaultServiceAccountValue is the SA used when one is not specified. DefaultServiceAccountValue = "default" // DefaultManagedByLabelValue is the value for the managed-by label that is used by default. DefaultManagedByLabelValue = "tekton-pipelines" // DefaultCloudEventSinkValue is the default value for cloud event sinks. DefaultCloudEventSinkValue = "" // DefaultMaxMatrixCombinationsCount is used when no max matrix combinations count is specified. DefaultMaxMatrixCombinationsCount = 256 )
const ( // StableAPIFields is the value used for "enable-api-fields" when only stable APIs should be usable. StableAPIFields = "stable" // AlphaAPIFields is the value used for "enable-api-fields" when alpha APIs should be usable as well. AlphaAPIFields = "alpha" // FullEmbeddedStatus is the value used for "embedded-status" when the full statuses of TaskRuns and Runs should be // embedded in PipelineRunStatusFields, but ChildReferences should not be used. FullEmbeddedStatus = "full" // BothEmbeddedStatus is the value used for "embedded-status" when full embedded statuses of TaskRuns and Runs as // well as ChildReferences should be used in PipelineRunStatusFields. BothEmbeddedStatus = "both" // MinimalEmbeddedStatus is the value used for "embedded-status" when only ChildReferences should be used in // PipelineRunStatusFields. MinimalEmbeddedStatus = "minimal" // DefaultDisableAffinityAssistant is the default value for "disable-affinity-assistant". DefaultDisableAffinityAssistant = false // DefaultDisableCredsInit is the default value for "disable-creds-init". DefaultDisableCredsInit = false // DefaultRunningInEnvWithInjectedSidecars is the default value for "running-in-environment-with-injected-sidecars". DefaultRunningInEnvWithInjectedSidecars = true // DefaultAwaitSidecarReadiness is the default value for "await-sidecar-readiness". DefaultAwaitSidecarReadiness = true // DefaultRequireGitSSHSecretKnownHosts is the default value for "require-git-ssh-secret-known-hosts". DefaultRequireGitSSHSecretKnownHosts = false // DefaultEnableTektonOciBundles is the default value for "enable-tekton-oci-bundles". DefaultEnableTektonOciBundles = false // DefaultEnableCustomTasks is the default value for "enable-custom-tasks". DefaultEnableCustomTasks = false // DefaultEnableAPIFields is the default value for "enable-api-fields". DefaultEnableAPIFields = StableAPIFields // DefaultSendCloudEventsForRuns is the default value for "send-cloudevents-for-runs". DefaultSendCloudEventsForRuns = false // DefaultEmbeddedStatus is the default value for "embedded-status". DefaultEmbeddedStatus = FullEmbeddedStatus )
const ( // DefaultTaskrunLevel determines to what level to aggregate metrics // when it isn't specified in configmap DefaultTaskrunLevel = TaskrunLevelAtTask // TaskrunLevelAtTaskrun specify that aggregation will be done at // taskrun level TaskrunLevelAtTaskrun = "taskrun" // TaskrunLevelAtTask specify that aggregation will be done at task level TaskrunLevelAtTask = "task" // TaskrunLevelAtNS specify that aggregation will be done at namespace level TaskrunLevelAtNS = "namespace" // DefaultPipelinerunLevel determines to what level to aggregate metrics // when it isn't specified in configmap DefaultPipelinerunLevel = PipelinerunLevelAtPipeline // PipelinerunLevelAtPipelinerun specify that aggregation will be done at // pipelinerun level PipelinerunLevelAtPipelinerun = "pipelinerun" // PipelinerunLevelAtPipeline specify that aggregation will be done at // pipeline level PipelinerunLevelAtPipeline = "pipeline" // PipelinerunLevelAtNS specify that aggregation will be done at // namespace level PipelinerunLevelAtNS = "namespace" // DefaultDurationTaskrunType determines what type // of metrics to use when we don't specify one in // configmap DefaultDurationTaskrunType = "histogram" // DurationTaskrunTypeHistogram specify that histogram // type metrics need to be use for Duration of Taskrun DurationTaskrunTypeHistogram = "histogram" // DurationTaskrunTypeLastValue specify that lastValue or // gauge type metrics need to be use for Duration of Taskrun DurationTaskrunTypeLastValue = "lastvalue" // DefaultDurationPipelinerunType determines what type // of metrics to use when we don't specify one in // configmap DefaultDurationPipelinerunType = "histogram" // DurationPipelinerunTypeHistogram specify that histogram // type metrics need to be use for Duration of Pipelinerun DurationPipelinerunTypeHistogram = "histogram" // DurationPipelinerunTypeLastValue specify that lastValue or // gauge type metrics need to be use for Duration of Pipelinerun DurationPipelinerunTypeLastValue = "lastvalue" )
Variables ¶
This section is empty.
Functions ¶
func EnableAlphaAPIFields ¶ added in v0.38.0
EnableAlphaAPIFields enables alpha feature in an existing context (for use in testing)
func GetArtifactBucketConfigName ¶ added in v0.15.0
func GetArtifactBucketConfigName() string
GetArtifactBucketConfigName returns the name of the configmap containing all customizations for the storage bucket.
func GetArtifactPVCConfigName ¶ added in v0.15.0
func GetArtifactPVCConfigName() string
GetArtifactPVCConfigName returns the name of the configmap containing all customizations for the storage PVC.
func GetDefaultsConfigName ¶ added in v0.12.0
func GetDefaultsConfigName() string
GetDefaultsConfigName returns the name of the configmap containing all defined defaults.
func GetFeatureFlagsConfigName ¶ added in v0.14.0
func GetFeatureFlagsConfigName() string
GetFeatureFlagsConfigName returns the name of the configmap containing all feature flags.
func GetMetricsConfigName ¶ added in v0.28.0
func GetMetricsConfigName() string
GetMetricsConfigName returns the name of the configmap containing all customizations for the storage bucket.
func IsSubstituted ¶ added in v0.36.0
IsSubstituted indicates that the variables have been substituted.
func SkipValidationDueToPropagatedParametersAndWorkspaces ¶ added in v0.39.0
func SkipValidationDueToPropagatedParametersAndWorkspaces(ctx context.Context, skip bool) context.Context
SkipValidationDueToPropagatedParametersAndWorkspaces sets the context to skip validation of parameters when embedded vs referenced to true or false.
func ToContext ¶
ToContext attaches the provided Config to the provided context, returning the new context with the Config attached.
func ValidateParameterVariablesAndWorkspaces ¶ added in v0.39.0
ValidateParameterVariablesAndWorkspaces indicates if validation of paramater variables and workspaces should be conducted.
Types ¶
type ArtifactBucket ¶ added in v0.15.0
type ArtifactBucket struct { Location string ServiceAccountSecretName string ServiceAccountSecretKey string ServiceAccountFieldName string }
ArtifactBucket holds the configurations for the artifacts PVC +k8s:deepcopy-gen=true
func NewArtifactBucketFromConfigMap ¶ added in v0.15.0
func NewArtifactBucketFromConfigMap(config *corev1.ConfigMap) (*ArtifactBucket, error)
NewArtifactBucketFromConfigMap returns a Config for the given configmap
func NewArtifactBucketFromMap ¶ added in v0.15.0
func NewArtifactBucketFromMap(cfgMap map[string]string) (*ArtifactBucket, error)
NewArtifactBucketFromMap returns a Config given a map corresponding to a ConfigMap
func (*ArtifactBucket) DeepCopy ¶ added in v0.15.0
func (in *ArtifactBucket) DeepCopy() *ArtifactBucket
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ArtifactBucket.
func (*ArtifactBucket) DeepCopyInto ¶ added in v0.15.0
func (in *ArtifactBucket) DeepCopyInto(out *ArtifactBucket)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ArtifactBucket) Equals ¶ added in v0.15.0
func (cfg *ArtifactBucket) Equals(other *ArtifactBucket) bool
Equals returns true if two Configs are identical
type ArtifactPVC ¶ added in v0.15.0
ArtifactPVC holds the configurations for the artifacts PVC +k8s:deepcopy-gen=true
func NewArtifactPVCFromConfigMap ¶ added in v0.15.0
func NewArtifactPVCFromConfigMap(config *corev1.ConfigMap) (*ArtifactPVC, error)
NewArtifactPVCFromConfigMap returns a Config for the given configmap
func NewArtifactPVCFromMap ¶ added in v0.15.0
func NewArtifactPVCFromMap(cfgMap map[string]string) (*ArtifactPVC, error)
NewArtifactPVCFromMap returns a Config given a map corresponding to a ConfigMap
func (*ArtifactPVC) DeepCopy ¶ added in v0.15.0
func (in *ArtifactPVC) DeepCopy() *ArtifactPVC
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ArtifactPVC.
func (*ArtifactPVC) DeepCopyInto ¶ added in v0.15.0
func (in *ArtifactPVC) DeepCopyInto(out *ArtifactPVC)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ArtifactPVC) Equals ¶ added in v0.15.0
func (cfg *ArtifactPVC) Equals(other *ArtifactPVC) bool
Equals returns true if two Configs are identical
type Config ¶
type Config struct { Defaults *Defaults FeatureFlags *FeatureFlags ArtifactBucket *ArtifactBucket ArtifactPVC *ArtifactPVC Metrics *Metrics }
Config holds the collection of configurations that we attach to contexts. +k8s:deepcopy-gen=false
func FromContext ¶
FromContext extracts a Config from the provided context.
func FromContextOrDefaults ¶
FromContextOrDefaults is like FromContext, but when no Config is attached it returns a Config populated with the defaults for each of the Config fields.
type Defaults ¶
type Defaults struct { DefaultTimeoutMinutes int DefaultServiceAccount string DefaultManagedByLabelValue string DefaultPodTemplate *pod.Template DefaultAAPodTemplate *pod.AffinityAssistantTemplate DefaultCloudEventsSink string DefaultTaskRunWorkspaceBinding string DefaultMaxMatrixCombinationsCount int }
Defaults holds the default configurations +k8s:deepcopy-gen=true
func NewDefaultsFromConfigMap ¶
NewDefaultsFromConfigMap returns a Config for the given configmap
func NewDefaultsFromMap ¶
NewDefaultsFromMap returns a Config given a map corresponding to a ConfigMap
func (*Defaults) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Defaults.
func (*Defaults) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FeatureFlags ¶ added in v0.14.0
type FeatureFlags struct { DisableAffinityAssistant bool DisableCredsInit bool RunningInEnvWithInjectedSidecars bool RequireGitSSHSecretKnownHosts bool EnableTektonOCIBundles bool EnableCustomTasks bool ScopeWhenExpressionsToTask bool EnableAPIFields string SendCloudEventsForRuns bool AwaitSidecarReadiness bool EmbeddedStatus string }
FeatureFlags holds the features configurations +k8s:deepcopy-gen=true
func NewFeatureFlagsFromConfigMap ¶ added in v0.14.0
func NewFeatureFlagsFromConfigMap(config *corev1.ConfigMap) (*FeatureFlags, error)
NewFeatureFlagsFromConfigMap returns a Config for the given configmap
func NewFeatureFlagsFromMap ¶ added in v0.14.0
func NewFeatureFlagsFromMap(cfgMap map[string]string) (*FeatureFlags, error)
NewFeatureFlagsFromMap returns a Config given a map corresponding to a ConfigMap
func (*FeatureFlags) DeepCopy ¶ added in v0.14.0
func (in *FeatureFlags) DeepCopy() *FeatureFlags
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureFlags.
func (*FeatureFlags) DeepCopyInto ¶ added in v0.14.0
func (in *FeatureFlags) DeepCopyInto(out *FeatureFlags)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Metrics ¶ added in v0.28.0
type Metrics struct { TaskrunLevel string PipelinerunLevel string DurationTaskrunType string DurationPipelinerunType string }
Metrics holds the configurations for the metrics +k8s:deepcopy-gen=true
func NewMetricsFromConfigMap ¶ added in v0.28.0
NewMetricsFromConfigMap returns a Config for the given configmap
func (*Metrics) DeepCopy ¶ added in v0.28.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Metrics.
func (*Metrics) DeepCopyInto ¶ added in v0.28.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Store ¶
type Store struct {
*configmap.UntypedStore
}
Store is a typed wrapper around configmap.Untyped store to handle our configmaps. +k8s:deepcopy-gen=false
func NewStore ¶
NewStore creates a new store of Configs and optionally calls functions when ConfigMaps are updated.