MGMT-16501: Add request headers to api_vip_connectivity check request

[CrystalChun]

MGMT-16501
API change to include additional request headers when making a call to the ignition endpoint. Allows for more flexibility to pass headers to different ignition servers.

List all the issues related to this PR

• New Feature
• Enhancement
• Bug fix
• Tests
• Documentation
• CI/CD

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

Pre-steps:

1. Installed dev-scripts environment with API changes and extra worker
2. Installed hypershift

Backwards compatibility test:

1. Created hypershift cluster & bmh with extra worker
2. Verify that the worker gets added to the cluster

Using new header test:

1. Modify assisted installer agent to use the new header

	if len(connectivityReq.RequestHeaders) > 0 {
		for _, requestHeader := range connectivityReq.RequestHeaders {
			req.Header.Set(requestHeader.Key, requestHeader.Value)
		}
	}
/*	if connectivityReq.IgnitionEndpointToken != nil {
		bearerToken := fmt.Sprintf("Bearer %s", *connectivityReq.IgnitionEndpointToken)
		req.Header.Set("Authorization", bearerToken)
	}
*/

2. Modify assisted-service to send ignition token as request header

	var requestHeaders []*models.APIVipConnectivityAdditionalRequestHeader
	if commonHost.IgnitionEndpointToken != "" {
		requestHeaders = append(requestHeaders, &models.APIVipConnectivityAdditionalRequestHeader{Key: "Authorization", Value: fmt.Sprintf("Bearer %s", commonHost.IgnitionEndpointToken)})
		//request.IgnitionEndpointToken = &commonHost.IgnitionEndpointToken
	}
	request.RequestHeaders = requestHeaders

2. Update CSV in cluster to use assisted server and assisted installer agent image with new header changes
3. Created hypershift cluster & bmh with extra worker
4. Verify that the worker gets added to the cluster

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 @avishayt

[openshift-ci-robot]

@CrystalChun: This pull request references MGMT-16501 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

MGMT-16501
API change to include additional request headers when making a call to the ignition endpoint. Allows for more flexibility to pass headers to different ignition servers.

List all the issues related to this PR

• New Feature
• Enhancement
• Bug fix
• Tests
• Documentation
• CI/CD

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

Pre-steps:

1. Installed dev-scripts environment with API changes and extra worker
2. Installed hypershift

Backwards compatibility test:

1. Created hypershift cluster & bmh with extra worker
2. Verify that the worker gets added to the cluster

Using new header test:

1. Modify assisted installer agent to use the new header

  if len(connectivityReq.RequestHeaders) > 0 {
  	for _, requestHeader := range connectivityReq.RequestHeaders {
  		req.Header.Set(requestHeader.Key, requestHeader.Value)
  	}
  }
/*	if connectivityReq.IgnitionEndpointToken != nil {
  	bearerToken := fmt.Sprintf("Bearer %s", *connectivityReq.IgnitionEndpointToken)
  	req.Header.Set("Authorization", bearerToken)
  }
*/

2. Update CSV in cluster to use assisted installer agent image with new header changes
3. Created hypershift cluster & bmh with extra worker
4. Verify that the worker gets added to the cluster

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 @avishayt

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[openshift-ci-robot]

@CrystalChun: This pull request references MGMT-16501 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

MGMT-16501
API change to include additional request headers when making a call to the ignition endpoint. Allows for more flexibility to pass headers to different ignition servers.

List all the issues related to this PR

• New Feature
• Enhancement
• Bug fix
• Tests
• Documentation
• CI/CD

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

Pre-steps:

1. Installed dev-scripts environment with API changes and extra worker
2. Installed hypershift

Backwards compatibility test:

1. Created hypershift cluster & bmh with extra worker
2. Verify that the worker gets added to the cluster

Using new header test:

1. Modify assisted installer agent to use the new header

  if len(connectivityReq.RequestHeaders) > 0 {
  	for _, requestHeader := range connectivityReq.RequestHeaders {
  		req.Header.Set(requestHeader.Key, requestHeader.Value)
  	}
  }
/*	if connectivityReq.IgnitionEndpointToken != nil {
  	bearerToken := fmt.Sprintf("Bearer %s", *connectivityReq.IgnitionEndpointToken)
  	req.Header.Set("Authorization", bearerToken)
  }
*/

2. Modify assisted-service to send ignition token as request header

  var requestHeaders []*models.APIVipConnectivityAdditionalRequestHeader
  if commonHost.IgnitionEndpointToken != "" {
  	requestHeaders = append(requestHeaders, &models.APIVipConnectivityAdditionalRequestHeader{Key: "Authorization", Value: fmt.Sprintf("Bearer %s", commonHost.IgnitionEndpointToken)})
  	//request.IgnitionEndpointToken = &commonHost.IgnitionEndpointToken
  }
  request.RequestHeaders = requestHeaders

2. Update CSV in cluster to use assisted installer agent image with new header changes
3. Created hypershift cluster & bmh with extra worker
4. Verify that the worker gets added to the cluster

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 @avishayt

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@CrystalChun: This pull request references MGMT-16501 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

MGMT-16501
API change to include additional request headers when making a call to the ignition endpoint. Allows for more flexibility to pass headers to different ignition servers.

List all the issues related to this PR

• New Feature
• Enhancement
• Bug fix
• Tests
• Documentation
• CI/CD

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

Pre-steps:

1. Installed dev-scripts environment with API changes and extra worker
2. Installed hypershift

Backwards compatibility test:

1. Created hypershift cluster & bmh with extra worker
2. Verify that the worker gets added to the cluster

Using new header test:

1. Modify assisted installer agent to use the new header

  if len(connectivityReq.RequestHeaders) > 0 {
  	for _, requestHeader := range connectivityReq.RequestHeaders {
  		req.Header.Set(requestHeader.Key, requestHeader.Value)
  	}
  }
/*	if connectivityReq.IgnitionEndpointToken != nil {
  	bearerToken := fmt.Sprintf("Bearer %s", *connectivityReq.IgnitionEndpointToken)
  	req.Header.Set("Authorization", bearerToken)
  }
*/

2. Modify assisted-service to send ignition token as request header

  var requestHeaders []*models.APIVipConnectivityAdditionalRequestHeader
  if commonHost.IgnitionEndpointToken != "" {
  	requestHeaders = append(requestHeaders, &models.APIVipConnectivityAdditionalRequestHeader{Key: "Authorization", Value: fmt.Sprintf("Bearer %s", commonHost.IgnitionEndpointToken)})
  	//request.IgnitionEndpointToken = &commonHost.IgnitionEndpointToken
  }
  request.RequestHeaders = requestHeaders

2. Update CSV in cluster to use assisted server and assisted installer agent image with new header changes
3. Created hypershift cluster & bmh with extra worker
4. Verify that the worker gets added to the cluster

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 @avishayt

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 openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: avishayt, 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,avishayt]

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (77bd860) 68.03% compared to head (c28b45a) 68.10%.
Report is 12 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5870      +/-   ##
==========================================
+ Coverage   68.03%   68.10%   +0.06%     
==========================================
  Files         235      235              
  Lines       34574    34640      +66     
==========================================
+ Hits        23523    23592      +69     
+ Misses       8988     8985       -3     
  Partials     2063     2063              

Files	Coverage Δ
...ost/hostcommands/api_vip_connectivity_check_cmd.go	75.67% <100.00%> (+2.14%)	⬆️

... and 13 files with indirect coverage changes

[openshift-ci-robot]

/retest-required

Remaining retests: 0 against base HEAD ede4113 and 2 for PR HEAD 08cf018 in total

[avishayt]

/lgtm

[openshift-ci-robot]

/retest-required

Remaining retests: 0 against base HEAD 2db51d7 and 2 for PR HEAD c28b45a in total

[openshift-ci]

@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.

[openshift-bot]

[ART PR BUILD NOTIFIER]

This PR has been included in build ose-agent-installer-api-server-container-v4.16.0-202401180211.p0.ga75c684.assembly.stream for distgit ose-agent-installer-api-server.
All builds following this will include this PR.