feat(self-hosted): convert experimental env vars to config options #29154
Conversation
RahulGautamSingh
requested review from
HonkingGoose,
rarkins and
viceice
and removed request for
HonkingGoose and
rarkins
|
Verified each migration locally, by either logging the values of each option at runtime or confirming that they are working as expected |
| ## s3PathStyle | ||
|
|
||
| If set, Renovate will enable `forcePathStyle` when creating the AWS S3 client instance. | ||
|
|
||
| > Whether to force path-style URLs for S3 objects (e.g., `https://s3.amazonaws.com//` instead of `https://.s3.amazonaws.com/`) | ||
|
|
||
| Source: [AWS S3 documentation - Interface BucketEndpointInputConfig](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/bucketendpointinputconfig.html) | ||
|
|
There was a problem hiding this comment.
@Gabriel-Ladzaretti why is this necessary? Isn't it the same administrator who's configuring the S3?
There was a problem hiding this comment.
This is mainly used for s3 compatible solutions that dont support or are not configured to use virtual-hosted–style requests. It essentially alters the way the aws client constructs and resolves urls.
path-style-access
e.g, https://s3.amazonaws.com/mybucket/myfile
vs
virtual-hosted-style-access
e,g, https://mybucket.s3.amazonaws.com/myfile
i dont think there is another way to support these s3 instances.
| ## s3PathStyle | ||
|
|
||
| If set, Renovate will enable `forcePathStyle` when creating the AWS S3 client instance. | ||
|
|
||
| > Whether to force path-style URLs for S3 objects (e.g., `https://s3.amazonaws.com//` instead of `https://.s3.amazonaws.com/`) | ||
|
|
||
| Source: [AWS S3 documentation - Interface BucketEndpointInputConfig](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/bucketendpointinputconfig.html) | ||
|
|
| @@ -89,7 +89,7 @@ export async function exportStats(config: RenovateConfig): Promise<void> { | |||
| ContentType: 'application/json', | |||
| }; | |||
|
|
|||
| const client = getS3Client(); | |||
| const client = getS3Client(config.s3Endpoint, config.s3PathStyle); | |||
There was a problem hiding this comment.
Is this required because we didn't initialized the global config at that time?
There was a problem hiding this comment.
Yes, we do not have global config class initialized.
Changes
RENOVATE_X_DELETE_CONFIG_FILEdeleteConfigFileRENOVATE_X_S3_ENDPOINTs3EndpointRENOVATE_X_S3_PATH_STYLEs3PathStyleThere are some boolean types here. They could not be converted to
experimentalFlagsbecauseGlobalConfighasn't been initialized yet, when they are used, hence converting them to self-hosted config options instead.Context
Last of: #27879 (comment)
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: