feat: add --description flag to astro deploy command #1713

Simpcyclassy · 2024-09-04T23:48:34Z

Description

This PR introduces functionality to support custom deployment revision descriptions during the astro deploy CLI command. It adds a mechanism to capture and assign meaningful descriptions for deployment revisions, enhancing traceability and clarity in the deployment process.

Changes Implemented:

Description Flag Handling:
- Added a --description flag to the astro deploy command, allowing users to specify a custom description for the deployment revision.
- If no custom description is provided, the command defaults to a generic description using the GetDefaultDeployDescription method, which dynamically assigns a description based on the deploy command used (e.g., DAGs-only - astro deploy --dags OR full image deploy - astro deploy).
Label Integration:
- The custom or default description is appended as a label (io.astronomer.deploy.revision.description) to the deployLabels slice, allowing the deployment system to track the description as part of the Docker image metadata.

Benefits:

Improved Traceability:
- By allowing custom deploy revision descriptions, users can now provide meaningful context for each deployment (e.g., "Fix issue with triggerer pods").
- This ensures that deployment logs and UI reflect the purpose behind each deployment, making it easier for teams to audit and understand deployment histories.
Default Descriptions:
- If no description is provided by the user, the system will automatically assign a default description based on the deployment type. This ensures that every deployment has some form of description, even if it’s not user-defined, improving consistency and traceability.

Example Usage:

Custom Description:

astro deploy --description="Fix issue with triggerer pods"

Result: Fix issue with triggerer pods

DAGs-Only Deploy (Default Description):
```
astro deploy --dags
```
Result: Deployed via <astro deploy --dags>

Why This Change?

This update allows developers and deployment teams to provide additional context for each deployment revision, helping them better manage, track, and audit their deployment histories. By introducing both custom and default descriptions, it provides a flexible and structured way to document the purpose of each deployment.

🎟 Issue(s)

Related astronomer/issues#6437

🧪 Functional Testing

List the functional testing steps to confirm this feature or fix.

📸 Screenshots

📋 Checklist

Rebased from the main (or release if patching) branch (before testing)
Ran make test before taking out of draft
Ran make lint before taking out of draft
Added/updated applicable tests
Tested against Astro-API (if necessary).
Tested against Houston-API and Astronomer (if necessary).
Communicated to/tagged owners of respective clients potentially impacted by these changes.
Updated any related documentation

for more information, see https://pre-commit.ci

neel-astro

left minor suggestion and question

cmd/software/deploy.go

.gitignore

neel-astro · 2024-09-11T06:19:35Z

software/deploy/deploy.go

@@ -170,6 +170,10 @@ func buildPushDockerImage(houstonClient houston.ClientInterface, c *config.Conte

 	imageHandler := imageHandlerInit(imageName)

+	if description != "" {
+		deployLabels = append(deployLabels, "io.astronomer.deploy.revision.description="+description)


nit: silly question, how does this description pop up in the UI when it's a DAG-only deploy because CLI is only setting it on the image, and I am not sure we do an image deploy when the --dags flag is passed.

Yeah, should we extend this flag to --dag-only command too? @Simpcyclassy

Not a silly question at all. That is what this PR #1716 is for. It would send the description to dag server which creates a revision on houston

are we looking to release both the changes together?

why are we setting io.astronomer.deploy.revision.description

Because we are setting the description through the api request in the image

cmd/software/deploy.go

rujhan-arora-astronomer · 2024-09-11T07:13:18Z

software/deploy/deploy.go

@@ -170,6 +170,10 @@ func buildPushDockerImage(houstonClient houston.ClientInterface, c *config.Conte

 	imageHandler := imageHandlerInit(imageName)

+	if description != "" {
+		deployLabels = append(deployLabels, "io.astronomer.deploy.revision.description="+description)


Yeah, should we extend this flag to --dag-only command too? @Simpcyclassy

Simpcyclassy · 2024-09-11T19:33:30Z

Changes addressed @neel-astro @rujhan-arora-astronomer

neel-astro

Had a second pass, left some minor comments to squash, LGTM otherwise :)

neel-astro · 2024-09-12T10:43:44Z

cmd/software/deploy.go

@@ -104,8 +106,12 @@ func deployAirflow(cmd *cobra.Command, args []string) error {
 	if isDagOnlyDeploy {
 		return DagsOnlyDeploy(houstonClient, appConfig, ws, deploymentID, config.WorkingPath, nil, true)
 	}
+
+	if description == "" {
+		description = utils.GetDefaultDeployDescription(cmd, args)


Suggested change

description = utils.GetDefaultDeployDescription(cmd, args)

description = utils.GetDefaultDeployDescription(isDagOnlyDeploy)

nit: we could simply send the isDagOnlyDeploy instead of re-parsing/reading the value for the dags flag. Then in the GetDefaultDeployDescription function check if isDagOnlyDeploy != nil && *isDagOnlyDeploy == true

I could also simply do if isDagOnlyDeploy right?

neel-astro · 2024-09-12T10:44:39Z

software/deploy/deploy.go

@@ -170,6 +170,10 @@ func buildPushDockerImage(houstonClient houston.ClientInterface, c *config.Conte

 	imageHandler := imageHandlerInit(imageName)

+	if description != "" {
+		deployLabels = append(deployLabels, "io.astronomer.deploy.revision.description="+description)


are we looking to release both the changes together?

software/deploy/deploy_test.go

for more information, see https://pre-commit.ci

Simpcyclassy and others added 10 commits September 4, 2024 18:47

feat: add --description flag to astro deploy command

da3219d

[pre-commit.ci] auto fixes from pre-commit.com hooks

d2abeb6

for more information, see https://pre-commit.ci

Merge branch 'main' into feature/add-description-flag

9c49221

description is a general flag

e270acf

[pre-commit.ci] auto fixes from pre-commit.com hooks

7336cc0

for more information, see https://pre-commit.ci

deploy to registry

67b6c7a

remove unneccesary new line

cf4071c

description is only used on registry

2a555ab

update deploy description

ae15dc3

add deploy command test

21dc27c

Simpcyclassy self-assigned this Sep 10, 2024

Simpcyclassy marked this pull request as ready for review September 10, 2024 22:01

Simpcyclassy requested review from neel-astro, jeremybeard, kushalmalani and sunkickr as code owners September 10, 2024 22:01

neel-astro reviewed Sep 11, 2024

View reviewed changes

kushalmalani reviewed Sep 11, 2024

View reviewed changes

cmd/software/deploy.go Outdated Show resolved Hide resolved

rujhan-arora-astronomer reviewed Sep 11, 2024

View reviewed changes

remove redundant code

be0a190

Simpcyclassy requested review from danielhoherd, kushalmalani, rujhan-arora-astronomer and neel-astro September 11, 2024 19:33

updated Deployed via description

396ce99

rujhan-arora-astronomer approved these changes Sep 12, 2024

View reviewed changes

neel-astro reviewed Sep 12, 2024

View reviewed changes

Simpcyclassy and others added 2 commits September 13, 2024 12:21

GetDefaultDeployDescription check

262a40a

[pre-commit.ci] auto fixes from pre-commit.com hooks

8ef8596

for more information, see https://pre-commit.ci

Simpcyclassy and others added 2 commits September 13, 2024 12:49

fix dup vars

0ae4876

[pre-commit.ci] auto fixes from pre-commit.com hooks

3745e0b

for more information, see https://pre-commit.ci

Simpcyclassy requested review from rujhan-arora-astronomer and neel-astro September 13, 2024 23:13

Simpcyclassy mentioned this pull request Sep 13, 2024

update description on dag server #1716

Merged

8 tasks

neel-astro approved these changes Sep 17, 2024

View reviewed changes

update description on dag server (#1716)

1479b45

danielhoherd merged commit 0a98b4f into main Sep 17, 2024
3 checks passed

danielhoherd deleted the feature/add-description-flag branch September 17, 2024 21:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add --description flag to astro deploy command #1713

feat: add --description flag to astro deploy command #1713

Simpcyclassy commented Sep 4, 2024 •

edited

Loading

neel-astro left a comment

neel-astro Sep 11, 2024

rujhan-arora-astronomer Sep 11, 2024

Simpcyclassy Sep 11, 2024

neel-astro Sep 12, 2024

Simpcyclassy Sep 13, 2024

pgvishnuram Sep 17, 2024

Simpcyclassy Sep 17, 2024

rujhan-arora-astronomer Sep 11, 2024

Simpcyclassy commented Sep 11, 2024

neel-astro left a comment

neel-astro Sep 12, 2024

Simpcyclassy Sep 13, 2024 •

edited

Loading

neel-astro Sep 12, 2024

	description = utils.GetDefaultDeployDescription(cmd, args)
	description = utils.GetDefaultDeployDescription(isDagOnlyDeploy)

feat: add --description flag to astro deploy command #1713

feat: add --description flag to astro deploy command #1713

Conversation

Simpcyclassy commented Sep 4, 2024 • edited Loading

Description

Changes Implemented:

Benefits:

Example Usage:

Why This Change?

🎟 Issue(s)

🧪 Functional Testing

📸 Screenshots

📋 Checklist

neel-astro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simpcyclassy commented Sep 11, 2024

neel-astro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simpcyclassy Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simpcyclassy commented Sep 4, 2024 •

edited

Loading

Simpcyclassy Sep 13, 2024 •

edited

Loading