List of labels to filter all applications this piped will handle. Currently, it is only be used to filter the applications suggested for adding from the control plane.
No
Git
Field
Type
Description
Required
username
string
The username that will be configured for git user. Default is piped.
No
email
string
The email that will be configured for git user. Default is pipecd.dev@gmail.com.
No
sshConfigFilePath
string
Where to write ssh config file. Default is $HOME/.ssh/config.
No
host
string
The host name. Default is github.com.
No
hostName
string
The hostname or IP address of the remote git server. Default is the same value with Host.
No
sshKeyFile
string
The path to the private ssh key file. This will be used to clone the source code of the specified git repositories.
No
sshKeyData
string
Base64 encoded string of SSH key.
No
password
string
The base64 encoded password for git used while cloning above Git repository.
No
GitRepository
Field
Type
Description
Required
repoID
string
Unique identifier to the repository. This must be unique in the piped scope.
Yes
remote
string
Remote address of the repository used to clone the source code. e.g. git@github.com:org/repo.git
Yes
branch
string
The branch will be handled.
Yes
ChartRepository
Field
Type
Description
Required
type
string
The repository type. Currently, HTTP and GIT are supported. Default is HTTP.
No
name
string
The name of the Helm chart repository. Note that is not a Git repository but a Helm chart repository.
Yes if type is HTTP
address
string
The address to the Helm chart repository.
Yes if type is HTTP
username
string
Username used for the repository backed by HTTP basic authentication.
No
password
string
Password used for the repository backed by HTTP basic authentication.
No
insecure
bool
Whether to skip TLS certificate checks for the repository or not.
No
gitRemote
string
Remote address of the Git repository used to clone Helm charts.
Yes if type is GIT
sshKeyFile
string
The path to the private ssh key file used while cloning Helm charts from above Git repository.
No
ChartRegistry
Field
Type
Description
Required
type
string
The registry type. Currently, only OCI is supported. Default is OCI.
List of variables that will be set directly on terraform commands with -var flag. The variable must be formatted by key=value.
No
driftDetectionEnabled
bool
Enable drift detection. This is a temporary option and will be possibly removed in the future release. Default is true
No
PlatformProviderCloudRunConfig
Field
Type
Description
Required
project
string
The GCP project hosting the Cloud Run service.
Yes
region
string
The region of running Cloud Run service.
Yes
credentialsFile
string
The path to the service account file for accessing Cloud Run service.
No
PlatformProviderLambdaConfig
Field
Type
Description
Required
region
string
The region of running Lambda service.
Yes
credentialsFile
string
The path to the credential file for logging into AWS cluster. If this value is not provided, piped will read credential info from environment variables. It expects the format ~/.aws/credentials.
No
roleARN
string
The IAM role arn to use when assuming an role. Required if you want to use the AWS SecurityTokenService.
No
tokenFile
string
The path to the WebIdentity token the SDK should use to assume a role with. Required if you want to use the AWS SecurityTokenService.
No
profile
string
The profile to use for logging into AWS cluster. The default value is default.
No
PlatformProviderECSConfig
Field
Type
Description
Required
region
string
The region of running ECS cluster.
Yes
credentialsFile
string
The path to the credential file for logging into AWS cluster. If this value is not provided, piped will read credential info from environment variables. It expects the format ~/.aws/credentials
No
roleARN
string
The IAM role arn to use when assuming an role. Required if you want to use the AWS SecurityTokenService.
No
tokenFile
string
The path to the WebIdentity token the SDK should use to assume a role with. Required if you want to use the AWS SecurityTokenService.
No
profile
string
The profile to use for logging into AWS cluster. The default value is default.
No
KubernetesAppStateInformer
Field
Type
Description
Required
namespace
string
Only watches the specified namespace. Empty means watching all namespaces.
Specific configuration for the specified type of analysis provider.
Yes
AnalysisProviderConfig
Must be one of the following structs:
AnalysisProviderPrometheusConfig
Field
Type
Description
Required
address
string
The Prometheus server address.
Yes
usernameFile
string
The path to the username file.
No
passwordFile
string
The path to the password file.
No
AnalysisProviderDatadogConfig
Field
Type
Description
Required
address
string
The address of Datadog API server. Only “datadoghq.com”, “us3.datadoghq.com”, “datadoghq.eu”, “ddog-gov.com” are available. Defaults to “datadoghq.com”
No
apiKeyFile
string
The path to the api key file.
Yes
applicationKeyFile
string
The path to the application key file.
Yes
apiKeyData
string
Base64 API Key for Datadog API server. Either apiKeyData or apiKeyFile must be set
No
applicationKeyData
string
Base64 Application Key for Datadog API server. Either applicationKeyFile or applicationKeyData must be set
No
EventWatcher
Field
Type
Description
Required
checkInterval
duration
Interval to fetch the latest event and compare it with one defined in EventWatcher config files. Defaults to 1m.
Copyright The PipeCD Authors.
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks,
see Trademark Usage.