MGMT-16517: Add Env Var for On-Prem Data Deployment Type #5874

CrystalChun · 2024-01-09T22:27:53Z

MGMT-16517
Adds the environment variables DEPLOYMENT_TYPE
and DEPLOYMENT_VERSION to determine how assisted was deployed. Expected values for deployment type
include ACM, MCE, ABI, podman, standalone operator.

Also changes the versions file to metadata file to encompass the new data.

List all the issues related to this PR

What environments does this code impact?

Automation (CI, tools, etc)
Cloud
Operator Managed Deployments
None

How was this code tested?

assisted-test-infra environment
dev-scripts environment
Reviewer's test appreciated
Waiting for CI to do a full test run
Manual (Elaborate on how it was tested)
No tests needed

Checklist

Title and description added to both, commit and PR.
Relevant issues have been associated (see CONTRIBUTING guide)
This change does not require a documentation update (docstring, docs, README, etc)
Does this change include unit-tests (note that code changes require unit-tests)

Reviewers Checklist

Are the title and description (in both PR and commit) meaningful and clear?
Is there a bug required (and linked) for this change?
Should this PR be backported?

/cc @rccrdpccl

openshift-ci-robot · 2024-01-09T22:27:57Z

openshift-ci · 2024-01-09T22:28:48Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CrystalChun

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [CrystalChun]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

codecov · 2024-01-09T22:44:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7825b85) 68.11% compared to head (6c5a61f) 68.54%.
Report is 23 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5874      +/-   ##
==========================================
+ Coverage   68.11%   68.54%   +0.43%     
==========================================
  Files         235      236       +1     
  Lines       34637    35305     +668     
==========================================
+ Hits        23592    24200     +608     
- Misses       8984     9014      +30     
- Partials     2061     2091      +30

Files	Coverage Δ
internal/uploader/events_uploader.go	`68.94% <100.00%> (+1.62%)`	⬆️
internal/uploader/uploader.go	`0.00% <ø> (ø)`

... and 13 files with indirect coverage changes

rccrdpccl · 2024-01-11T16:04:51Z

/retest

rccrdpccl · 2024-01-11T16:45:44Z

internal/uploader/events_uploader.go

+	metadata["deployment-version"] = config.DeploymentVersion
+
+	if metadataJson, err := json.Marshal(metadata); err == nil {
+		addFile(tw, metadataJson, fmt.Sprintf("%s/metadata.json", *clusterID)) //nolint:errcheck // errors adding this file shouldn't prevent the data from being sent


I know that we briefly discussed this, but I now realize that this would break the consumer. If necessary we can change the consumer first to handle both cases, but I think it'd be best to keep compatibility and just add metadata.json and versions.json separately. WDYT?

Oh gotcha, sure a separate file will work! I'll modify this to reflect it momentarily

I kept the version in the metadata file too so that when the versions.json file is removed, it'll already be part of the metadata.json file.

rccrdpccl · 2024-01-11T16:47:24Z

Can we add in the same PR manifest change for the default saas template and the podman/tests template?

CrystalChun · 2024-01-12T01:03:12Z

Can we add in the same PR manifest change for the default saas template and the podman/tests template?

Added! Did I add it to the correct places?

https://issues.redhat.com/browse/MGMT-16517 Adds the environment variables `DEPLOYMENT_TYPE` and `DEPLOYMENT_VERSION` to determine how assisted was deployed. Expected values for deployment type include ACM, MCE, ABI, podman, standalone operator.

gamli75 · 2024-01-24T12:25:54Z

/test e2e-agent-compact-ipv4

rccrdpccl

I think we cover most use cases:

saas/rest mode
kube api (infrastructure operator, MCE, ACM)
There are a few other deployment types that seems that are not covered

deploy/assisted-service.yaml

openshift/template.yaml

https://issues.redhat.com/browse/MGMT-16517

rccrdpccl · 2024-01-30T16:09:36Z

/lgtm

openshift-ci-robot · 2024-01-30T21:32:38Z

/retest-required

Remaining retests: 0 against base HEAD 268d4ed and 2 for PR HEAD 6c5a61f in total

openshift-ci · 2024-01-30T23:57:37Z

@CrystalChun: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

CrystalChun · 2024-02-13T15:42:06Z

/cherry-pick release-ocm-2.9

openshift-cherrypick-robot · 2024-02-13T15:42:59Z

@CrystalChun: new pull request created: #5979

In response to this:

/cherry-pick release-ocm-2.9

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

CrystalChun · 2024-02-13T19:41:03Z

/cherry-pick release-4.14

openshift-cherrypick-robot · 2024-02-13T19:41:44Z

@CrystalChun: #5874 failed to apply on top of branch "release-4.14":

Applying: MGMT-16517: Add Env Var for On-Prem Data Deployment Type
Using index info to reconstruct a base tree...
M	internal/uploader/events_uploader.go
M	internal/uploader/events_uploader_test.go
M	internal/uploader/uploader.go
Falling back to patching base and 3-way merge...
Auto-merging internal/uploader/uploader.go
Auto-merging internal/uploader/events_uploader_test.go
CONFLICT (content): Merge conflict in internal/uploader/events_uploader_test.go
Auto-merging internal/uploader/events_uploader.go
CONFLICT (content): Merge conflict in internal/uploader/events_uploader.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 MGMT-16517: Add Env Var for On-Prem Data Deployment Type
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

CrystalChun · 2024-02-13T21:01:03Z

/cherry-pick release-4.15

openshift-cherrypick-robot · 2024-02-13T21:01:45Z

@CrystalChun: new pull request created: #5982

In response to this:

/cherry-pick release-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

) * MGMT-16517: Add Env Var for On-Prem Data Deployment Type https://issues.redhat.com/browse/MGMT-16517 Adds the environment variables `DEPLOYMENT_TYPE` and `DEPLOYMENT_VERSION` to determine how assisted was deployed. Expected values for deployment type include ACM, MCE, ABI, podman, standalone operator. * MGMT-16517: Add Env Var to podman and SaaS templates https://issues.redhat.com/browse/MGMT-16517

* NO-ISSUE: Add versions file to onprem event upload (#5514) * MGMT-16517: Add Env Var for On-Prem Data Deployment Type (#5874) * MGMT-16517: Add Env Var for On-Prem Data Deployment Type https://issues.redhat.com/browse/MGMT-16517 Adds the environment variables `DEPLOYMENT_TYPE` and `DEPLOYMENT_VERSION` to determine how assisted was deployed. Expected values for deployment type include ACM, MCE, ABI, podman, standalone operator. * MGMT-16517: Add Env Var to podman and SaaS templates https://issues.redhat.com/browse/MGMT-16517 * MGMT-16523: Set ABI deployment type for on-prem data collection (#5967) https://issues.redhat.com/browse/MGMT-16523 The agent team sets the env var INSTALL_INVOKER to "agent-installer" during their deployment. This can be used to determine that it's an ABI deployment in our on-prem data collection.

) * MGMT-16517: Add Env Var for On-Prem Data Deployment Type https://issues.redhat.com/browse/MGMT-16517 Adds the environment variables `DEPLOYMENT_TYPE` and `DEPLOYMENT_VERSION` to determine how assisted was deployed. Expected values for deployment type include ACM, MCE, ABI, podman, standalone operator. * MGMT-16517: Add Env Var to podman and SaaS templates https://issues.redhat.com/browse/MGMT-16517

* MGMT-16517: Add Env Var for On-Prem Data Deployment Type (#5874) * MGMT-16517: Add Env Var for On-Prem Data Deployment Type https://issues.redhat.com/browse/MGMT-16517 Adds the environment variables `DEPLOYMENT_TYPE` and `DEPLOYMENT_VERSION` to determine how assisted was deployed. Expected values for deployment type include ACM, MCE, ABI, podman, standalone operator. * MGMT-16517: Add Env Var to podman and SaaS templates https://issues.redhat.com/browse/MGMT-16517 * MGMT-16523: Set ABI deployment type for on-prem data collection (#5967) https://issues.redhat.com/browse/MGMT-16523 The agent team sets the env var INSTALL_INVOKER to "agent-installer" during their deployment. This can be used to determine that it's an ABI deployment in our on-prem data collection.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jan 9, 2024

openshift-ci bot requested a review from rccrdpccl January 9, 2024 22:27

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 9, 2024

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 9, 2024

rccrdpccl reviewed Jan 11, 2024

View reviewed changes

CrystalChun force-pushed the onprem-type branch 2 times, most recently from 7d8dfa6 to d62d856 Compare January 12, 2024 01:00

CrystalChun force-pushed the onprem-type branch 2 times, most recently from 1d909aa to 6f9f5b1 Compare January 25, 2024 21:53

rccrdpccl reviewed Jan 29, 2024

View reviewed changes

deploy/assisted-service.yaml Show resolved Hide resolved

CrystalChun force-pushed the onprem-type branch from 6f9f5b1 to b65f382 Compare January 29, 2024 19:30

rccrdpccl mentioned this pull request Jan 30, 2024

MGMT-16521: Identify Operator-based Deployment Data #5906

Merged

20 tasks

rccrdpccl reviewed Jan 30, 2024

View reviewed changes

openshift/template.yaml Show resolved Hide resolved

MGMT-16517: Add Env Var to podman and SaaS templates

6c5a61f

https://issues.redhat.com/browse/MGMT-16517

CrystalChun force-pushed the onprem-type branch from b65f382 to 6c5a61f Compare January 30, 2024 15:38

openshift-ci bot assigned rccrdpccl Jan 30, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 30, 2024

openshift-merge-bot bot merged commit 05daf90 into openshift:master Jan 31, 2024
14 checks passed

openshift-cherrypick-robot mentioned this pull request Feb 13, 2024

MGMT-16918: Add Env Var for On-Prem Data Deployment Type #5979

Merged

openshift-cherrypick-robot mentioned this pull request Feb 13, 2024

[release-4.15] MGMT-16517: Add Env Var for On-Prem Data Deployment Type #5982

Closed

CrystalChun mentioned this pull request Feb 14, 2024

[release-4.14] MGMT-16517: Add Env Var Deployment Type & Set ABI #5987

Merged

20 tasks

CrystalChun mentioned this pull request Feb 22, 2024

[release-4.15] MGMT-16517: Add Env Var Deployment Type & Set ABI #6016

Merged

20 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MGMT-16517: Add Env Var for On-Prem Data Deployment Type #5874

MGMT-16517: Add Env Var for On-Prem Data Deployment Type #5874

CrystalChun commented Jan 9, 2024

openshift-ci-robot commented Jan 9, 2024 •

edited by openshift-ci bot

List all the issues related to this PR

What environments does this code impact?

How was this code tested?

Checklist

Reviewers Checklist

openshift-ci bot commented Jan 9, 2024

codecov bot commented Jan 9, 2024 •

edited

rccrdpccl commented Jan 11, 2024

rccrdpccl Jan 11, 2024

CrystalChun Jan 11, 2024

CrystalChun Jan 12, 2024

rccrdpccl commented Jan 11, 2024

CrystalChun commented Jan 12, 2024

gamli75 commented Jan 24, 2024

rccrdpccl left a comment

rccrdpccl commented Jan 30, 2024

openshift-ci-robot commented Jan 30, 2024

openshift-ci bot commented Jan 30, 2024

CrystalChun commented Feb 13, 2024

openshift-cherrypick-robot commented Feb 13, 2024

CrystalChun commented Feb 13, 2024

openshift-cherrypick-robot commented Feb 13, 2024

CrystalChun commented Feb 13, 2024

openshift-cherrypick-robot commented Feb 13, 2024

MGMT-16517: Add Env Var for On-Prem Data Deployment Type #5874

MGMT-16517: Add Env Var for On-Prem Data Deployment Type #5874

Conversation

CrystalChun commented Jan 9, 2024

List all the issues related to this PR

What environments does this code impact?

How was this code tested?

Checklist

Reviewers Checklist

openshift-ci-robot commented Jan 9, 2024 • edited by openshift-ci bot

List all the issues related to this PR

What environments does this code impact?

How was this code tested?

Checklist

Reviewers Checklist

openshift-ci bot commented Jan 9, 2024

codecov bot commented Jan 9, 2024 • edited

Codecov Report

rccrdpccl commented Jan 11, 2024

rccrdpccl Jan 11, 2024

Choose a reason for hiding this comment

CrystalChun Jan 11, 2024

Choose a reason for hiding this comment

CrystalChun Jan 12, 2024

Choose a reason for hiding this comment

rccrdpccl commented Jan 11, 2024

CrystalChun commented Jan 12, 2024

gamli75 commented Jan 24, 2024

rccrdpccl left a comment

Choose a reason for hiding this comment

rccrdpccl commented Jan 30, 2024

openshift-ci-robot commented Jan 30, 2024

openshift-ci bot commented Jan 30, 2024

CrystalChun commented Feb 13, 2024

openshift-cherrypick-robot commented Feb 13, 2024

CrystalChun commented Feb 13, 2024

openshift-cherrypick-robot commented Feb 13, 2024

CrystalChun commented Feb 13, 2024

openshift-cherrypick-robot commented Feb 13, 2024

openshift-ci-robot commented Jan 9, 2024 •

edited by openshift-ci bot

codecov bot commented Jan 9, 2024 •

edited