Support directly designating a gitSSHKey instead of File for launcher #5258

t-kikuc · 2024-10-07T05:52:48Z

What this PR does / why we need it:

Add --git-ssh-key-data for launcher. This flag enables passing a sshKey without preparing a file.

Usecase:

You can use the same launcher command for AWS and GCP (+ etc.)
If you use AWS Secrets Manager to store the sshKey, Secrets Manager will write it to an env (e.g. YOUR_ENV) and you can read it by /bin/sh -c \"launcher launcher (...) --git-ssh-key-data=$YOUR_ENV \"
- cf. https://pipecd.dev/docs-v0.49.x/installation/install-piped/installing-on-fargate/#installation

Which issue(s) this PR fixes:

N/A

Does this PR introduce a user-facing change?: N/A

How are users affected by this change:
Is this breaking change:
How to migrate (if breaking change):

Signed-off-by: t-kikuc <[email protected]>

codecov · 2024-10-07T05:57:16Z

Codecov Report

Attention: Patch coverage is 0% with 20 lines in your changes missing coverage. Please review.

Project coverage is 24.02%. Comparing base (2ef9ad3) to head (1c6e430).
Report is 6 commits behind head on master.

Files with missing lines	Patch %	Lines
pkg/app/launcher/cmd/launcher/launcher.go	0.00%	20 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #5258   +/-   ##
=======================================
  Coverage   24.02%   24.02%           
=======================================
  Files         439      439           
  Lines       47017    47040   +23     
=======================================
+ Hits        11295    11301    +6     
- Misses      34819    34835   +16     
- Partials      903      904    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Warashi

👍🏻

Signed-off-by: t-kikuc <[email protected]>

t-kikuc · 2024-10-07T06:24:21Z

@Warashi
Sorry, would you please review it again?

I changed from --git-ssh-key-env to --git-ssh-key-data since it's easier to use.

Warashi

Thanks

I commented on a nitpick, but you can merge this, leaving it as-is.

Warashi · 2024-10-07T06:24:50Z

pkg/app/launcher/cmd/launcher/launcher.go

+			if err != nil {
+				return fmt.Errorf("failed to create a temp file for SSH key data (%w)", err)
+			}
+			if _, err = tmpKeyFile.WriteString(string(decodedKey)); err != nil {


nits.
We can use Write method as belows

Suggested change

if _, err = tmpKeyFile.WriteString(string(decodedKey)); err != nil {

if _, err = tmpKeyFile.Write(decodedKey); err != nil {

@Warashi

thank you, I fixed it here 1c6e430.

It's a legacy code and I missed.

Signed-off-by: t-kikuc <[email protected]>

Warashi

Thanks

khanhtc1202

LGTM :+

…#5258) * Generate v0.49.x docs Signed-off-by: t-kikuc <[email protected]> * add --git-ssh-key-env Signed-off-by: t-kikuc <[email protected]> * update docs: add '--git-ssh-key-env' Signed-off-by: t-kikuc <[email protected]> * add '\n' at the end of ssh key Signed-off-by: t-kikuc <[email protected]> * Directly use data instead of env Signed-off-by: t-kikuc <[email protected]> * Clarify the flag description Signed-off-by: t-kikuc <[email protected]> * fix error message: 'and' -> 'or' Signed-off-by: t-kikuc <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]> Signed-off-by: pipecd-bot <[email protected]>

#5263 (#5265) * Fix panic in ECS driftdetection when a taskdef in livestates does not exist (#5240) * Generate v0.49.x docs Signed-off-by: t-kikuc <[email protected]> * fix: avoid panic when live taskdef does not exist Signed-off-by: t-kikuc <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Upgrade aws-sdk-go-v2 (#5241) * Generate v0.49.x docs Signed-off-by: t-kikuc <[email protected]> * upgrade aws-sdk-go-v2 Signed-off-by: t-kikuc <[email protected]> * upgrade aws-sdk-go-v2/**/* Signed-off-by: t-kikuc <[email protected]> * fix compile errors caused by the breaking change Signed-off-by: t-kikuc <[email protected]> * fix a test due to added RestartPolicy Signed-off-by: t-kikuc <[email protected]> * fix: avoid panic when live taskdef does not exist Signed-off-by: t-kikuc <[email protected]> * fix go.sum by `make update/go-deps` Signed-off-by: t-kikuc <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Remove an unused field 'configFilePathInGitRepo' (#5248) * Generate v0.49.x docs Signed-off-by: t-kikuc <[email protected]> * remove unused field 'configFilePathInGitRepo' Signed-off-by: t-kikuc <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Support fetching a piped config from AWS SSM Parameter Store (#5249) * Generate v0.49.x docs Signed-off-by: t-kikuc <[email protected]> * add --aws-ssm-parameter Signed-off-by: t-kikuc <[email protected]> * add config-aws-ssm-parameter to piped Signed-off-by: t-kikuc <[email protected]> * update docs of runtime options Signed-off-by: t-kikuc <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Remove subnet ordering in head manifest (#5254) Signed-off-by: HoangNguyen689 <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Update quickstart header note (#5255) Signed-off-by: khanhtc1202 <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Update feature status (#5256) Signed-off-by: khanhtc1202 <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Support directly designating a gitSSHKey instead of File for launcher (#5258) * Generate v0.49.x docs Signed-off-by: t-kikuc <[email protected]> * add --git-ssh-key-env Signed-off-by: t-kikuc <[email protected]> * update docs: add '--git-ssh-key-env' Signed-off-by: t-kikuc <[email protected]> * add '\n' at the end of ssh key Signed-off-by: t-kikuc <[email protected]> * Directly use data instead of env Signed-off-by: t-kikuc <[email protected]> * Clarify the flag description Signed-off-by: t-kikuc <[email protected]> * fix error message: 'and' -> 'or' Signed-off-by: t-kikuc <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Add workflow steps to build and publish quickstart manifests (#5260) Signed-off-by: pipecd-bot <[email protected]> * Update workflow not to run by matrix (#5262) Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]> Signed-off-by: pipecd-bot <[email protected]> * Update RELEASE to v0.49.1 and update v0.49.x docs (#5263) * update RELEASE to v0.49.1 Signed-off-by: t-kikuc <[email protected]> * update docs of v0.49.x by `make release version=v0.49.1` Signed-off-by: t-kikuc <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]> Signed-off-by: pipecd-bot <[email protected]> --------- Signed-off-by: t-kikuc <[email protected]> Signed-off-by: pipecd-bot <[email protected]> Signed-off-by: HoangNguyen689 <[email protected]> Signed-off-by: khanhtc1202 <[email protected]> Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]> Co-authored-by: Tetsuya Kikuchi <[email protected]> Co-authored-by: HoangNguyen689 <[email protected]> Co-authored-by: Khanh Tran <[email protected]> Co-authored-by: Shinnosuke Sawada-Dazai <[email protected]>

t-kikuc added 13 commits September 24, 2024 10:50

Generate v0.49.x docs

13f608c

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

129e5e9

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

b6653fa

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

2fa58f0

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

0dbd3df

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

372e8e6

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

361f46d

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

2e18db6

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

47281d5

Signed-off-by: t-kikuc <[email protected]>

Merge branch 'master' of https://github.com/pipe-cd/pipecd

b08b2c3

Signed-off-by: t-kikuc <[email protected]>

add --git-ssh-key-env

7065f74

Signed-off-by: t-kikuc <[email protected]>

update docs: add '--git-ssh-key-env'

fe51b90

Signed-off-by: t-kikuc <[email protected]>

add '\n' at the end of ssh key

baf1939

Signed-off-by: t-kikuc <[email protected]>

t-kikuc added kind/enhancement New feature or request cherry-pick v0.49.1 labels Oct 7, 2024

t-kikuc requested review from nghialv, khanhtc1202, kentakozuka, ffjlabo and Warashi as code owners October 7, 2024 05:52

github-actions bot added the area/go label Oct 7, 2024

t-kikuc enabled auto-merge (squash) October 7, 2024 05:53

t-kikuc marked this pull request as draft October 7, 2024 05:56

auto-merge was automatically disabled October 7, 2024 05:56
Pull request was converted to draft

Warashi previously approved these changes Oct 7, 2024

View reviewed changes

Directly use data instead of env

d410b58

Signed-off-by: t-kikuc <[email protected]>

t-kikuc dismissed Warashi’s stale review via d410b58 October 7, 2024 06:16

Clarify the flag description

c3f5712

Signed-off-by: t-kikuc <[email protected]>

fix error message: 'and' -> 'or'

0c523fb

Signed-off-by: t-kikuc <[email protected]>

t-kikuc changed the title ~~Support reading a gitSSHKey from an env variable for launcher~~ Support directly designating a gitSSHKey instead of File for launcher Oct 7, 2024

t-kikuc marked this pull request as ready for review October 7, 2024 06:21

t-kikuc enabled auto-merge (squash) October 7, 2024 06:24

Warashi previously approved these changes Oct 7, 2024

View reviewed changes

fix: use Write()

1c6e430

Signed-off-by: t-kikuc <[email protected]>

t-kikuc dismissed Warashi’s stale review via 1c6e430 October 7, 2024 06:28

Warashi approved these changes Oct 7, 2024

View reviewed changes

khanhtc1202 approved these changes Oct 7, 2024

View reviewed changes

t-kikuc merged commit f017312 into master Oct 7, 2024
15 checks passed

t-kikuc deleted the git-ssh-key-env branch October 7, 2024 06:38

github-actions bot mentioned this pull request Oct 8, 2024

Update RELEASE to v0.49.1 and update v0.49.x docs #5263

Merged

github-actions bot mentioned this pull request Oct 8, 2024

Cherry-pick #5240 #5241 #5248 #5249 #5254 #5255 #5256 #5258 #5260 #5262 #5263 #5265

Merged

github-actions bot mentioned this pull request Oct 9, 2024

Update RELEASE to v0.49.2 and sync docs of v0.49.x #5272

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support directly designating a gitSSHKey instead of File for launcher #5258

Support directly designating a gitSSHKey instead of File for launcher #5258

t-kikuc commented Oct 7, 2024 •

edited

Loading

codecov bot commented Oct 7, 2024 •

edited

Loading

Warashi left a comment

t-kikuc commented Oct 7, 2024

Warashi left a comment

Warashi Oct 7, 2024

t-kikuc Oct 7, 2024

Warashi left a comment

khanhtc1202 left a comment

	if _, err = tmpKeyFile.WriteString(string(decodedKey)); err != nil {
	if _, err = tmpKeyFile.Write(decodedKey); err != nil {

Support directly designating a gitSSHKey instead of File for launcher #5258

Support directly designating a gitSSHKey instead of File for launcher #5258

Conversation

t-kikuc commented Oct 7, 2024 • edited Loading

codecov bot commented Oct 7, 2024 • edited Loading

Codecov Report

Warashi left a comment

Choose a reason for hiding this comment

t-kikuc commented Oct 7, 2024

Warashi left a comment

Choose a reason for hiding this comment

Warashi Oct 7, 2024

Choose a reason for hiding this comment

t-kikuc Oct 7, 2024

Choose a reason for hiding this comment

Warashi left a comment

Choose a reason for hiding this comment

khanhtc1202 left a comment

Choose a reason for hiding this comment

t-kikuc commented Oct 7, 2024 •

edited

Loading

codecov bot commented Oct 7, 2024 •

edited

Loading