Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MGMT-12662: Add API document for discovery kernel arguments #4669

Merged
merged 1 commit into from Dec 6, 2022

Conversation

ori-amizur
Copy link
Contributor

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

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

@openshift-ci openshift-ci bot requested a review from filanov November 24, 2022 15:01
@ori-amizur ori-amizur marked this pull request as draft November 24, 2022 15:01
@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Nov 24, 2022
@ori-amizur
Copy link
Contributor Author

/approve

@filanov
Copy link
Contributor

filanov commented Nov 28, 2022

/assign @avishayt
cc: @romfreiman

Copy link
Contributor

@avishayt avishayt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes, otherwise looks great

Comment on lines 1 to 3
# Discovery Kernel Arguments API

The way to update discovery kernel arguments is by updating InfraEnv. Currently, only **append** (additional argument) operation is supported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Discovery Kernel Arguments API
The way to update discovery kernel arguments is by updating InfraEnv. Currently, only **append** (additional argument) operation is supported.
# Modifying Kernel Arguments for the Live ISO
Update the InfraEnv resource to modify the kernel arguments used in the live ISO (during the host discovery phase) . Currently, only the **append** (additional argument) operation is supported.

I suggest also modifying the name of the file, people probably won't guess what "discovery kernel arguments" means.

Comment on lines 61 to 63
## Kube API

With Kube API, the kernel arguments are set in the InfraEnv spec section:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Kube API
With Kube API, the kernel arguments are set in the InfraEnv spec section:
## Kubernetes API
When using the Kubernetes API, the kernel arguments are set in the InfraEnv spec section:

@romfreiman
Copy link
Contributor

@avishayt
Copy link
Contributor

wont it make more sense to add it here: https://github.com/openshift/assisted-service/blob/master/docs/user-guide/install-customization.md ?

Yes, great point

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 6, 2022
@openshift-ci
Copy link

openshift-ci bot commented Dec 6, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: avishayt, ori-amizur

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 [avishayt,ori-amizur]

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

@ori-amizur ori-amizur marked this pull request as ready for review December 6, 2022 13:18
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 6, 2022
@openshift-ci
Copy link

openshift-ci bot commented Dec 6, 2022

@ori-amizur: 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-merge-robot openshift-merge-robot merged commit e6b4ec0 into openshift:master Dec 6, 2022
danielerez pushed a commit to danielerez/assisted-service that referenced this pull request Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants