Specific configuration for the datastore type. This must be one of these DataStoreConfig.
Yes
DataStoreConfig
Must be one of the following objects:
DataStoreFireStoreConfig
Field
Type
Description
Required
namespace
string
The root path element considered as a logical namespace, e.g. pipecd.
Yes
environment
string
The second path element considered as a logical environment, e.g. dev. All pipecd collections will have path formatted according to {namespace}/{environment}/{collection-name}.
Yes
collectionNamePrefix
string
The prefix for collection name. This can be used to avoid conflicts with existing collections in your Firestore database.
No
project
string
The name of GCP project hosting the Firestore.
Yes
credentialsFile
string
The path to the service account file for accessing Firestores.
No
DataStoreMySQLConfig
Field
Type
Description
Required
url
string
The address to MySQL server. Should attach with the database port info as 127.0.0.1:3307 in case you want to use another port than the default value.
Yes
database
string
The name of database.
No (If you set it via URL)
usernameFile
string
Path to the file containing the username.
No
passwordFile
string
Path to the file containing the password.
No
FileStore
Field
Type
Description
Required
type
string
Which type of file store should be used. Can be one of the following values GCS, S3, MINIO
Specific configuration for the filestore type. This must be one of these FileStoreConfig.
Yes
FileStoreConfig
Must be one of the following objects:
FileStoreGCSConfig
Field
Type
Description
Required
bucket
string
The bucket name.
Yes
credentialsFile
string
The path to the service account file for accessing GCS.
No
FileStoreS3Config
Field
Type
Description
Required
bucket
string
The AWS S3 bucket name.
Yes
region
string
The AWS region name.
Yes
profile
string
The AWS profile name. Default value is default.
No
credentialsFile
string
The path to AWS credential file. Requires only if you want to auth by specified credential file, by default PipeCD will use $HOME/.aws/credentials file.
No
roleARN
string
The IAM role arn to use when assuming an role. Requires only if you want to auth by WebIdentity pattern.
No
tokenFile
string
The path to the WebIdentity token PipeCD should use to assume a role with. Requires only if you want to auth by WebIdentity pattern.
No
FileStoreMinioConfig
Field
Type
Description
Required
endpoint
string
The address of Minio.
Yes
bucket
string
The bucket name.
Yes
accessKeyFile
string
The path to the access key file.
No
secretKeyFile
string
The path to the secret key file.
No
autoCreateBucket
bool
Whether the given bucket should be made automatically if not exists.
No
Cache
Field
Type
Description
Required
ttl
duration
The time that in-memory cache items are stored before they are considered as stale.
The address of GitHub service. Required if enterprise.
No
uploadUrl
string
The upload url of GitHub service.
No
proxyUrl
string
The address of the proxy used while communicating with the GitHub service.
No
SSOConfigOIDC
Field
Type
Description
Required
clientId
string
The client id string of OpenID Connect oauth app.
Yes
clientSecret
string
The client secret string of OpenID Connect oauth app.
Yes
issuer
string
The address of OpenID Connect service.
Yes
redirectUri
string
The address of the redirect URI.
Yes
authorizationEndpoint
string
The address of the authorization endpoint. Only set if you want to use custom authorization endpoint (still need issuer discovery).
No
tokenEndpoint
string
The address of the token endpoint. Only set if you want to use custom token endpoint (still need issuer discovery).
No
userInfoEndpoint
string
The address of the user info endpoint. Only set if you want to use custom user info endpoint (still need issuer discovery).
No
proxyUrl
string
The address of the proxy used while communicating with the OpenID Connect service.
No
scopes
[]string
Scopes to request from the OpenID Connect service. Default is openid. Some providers may require other scopes.
No
usernameClaimKey
string
The key name of the claim that contains the username. If not set, the default value will be chosen in the following order: username, preferred_username, name, cognito:username.
No
rolesClaimKey
string
The key name of the claim that contains the roles. If not set, the default value will be chosen in the following order: groups, roles, custom:roles, custom:groups.
No
avatarUrlClaimKey
string
The key name of the claim that contains the avatar url. If not set, the default value will be chosen in the following order: picture, avatar_url.
Copyright The PipeCD Authors.
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks,
see Trademark Usage.