Skip to content

NIAD-3110: mhs resource assignment recommendation#158

Merged
adrianclay merged 2 commits intomainfrom
NIAD-3110-docs
Jun 7, 2024
Merged

NIAD-3110: mhs resource assignment recommendation#158
adrianclay merged 2 commits intomainfrom
NIAD-3110-docs

Conversation

@ORybak5
Copy link
Copy Markdown
Contributor

@ORybak5 ORybak5 commented Jun 3, 2024

What

MHS Adaptor resource assignment recommendation

Why

It is good to provide some guidance in terms of resource expectation

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Internal change (non-breaking change with no effect on the functionality affecting end users)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the Changelog with details of my change in the UNRELEASED section if this change will affect end users

Comment thread README.md Outdated
a step-by-step guide on how to set this up.

## MHS Adaptor resource allocation
The recommended heap space for the PS Adaptor Translator is 4 GB. Also, it should be run on (at least) two CPUs for better performance.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would this not live better under the mhs/operating-mhs-adaptor.md file which is linked below under the title "Operational Considerations"?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Also "heap space" is a Java term, I don't think we're expecting our users to be Java experts or knowledgeable about this at all. I think our guidance should be in terms of Docker (which we do expect our users to be familiar with).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

ok, I will adjust the terminology to remove Java specific names.

@adrianclay adrianclay merged commit c7fd7ab into main Jun 7, 2024
@adrianclay adrianclay deleted the NIAD-3110-docs branch June 7, 2024 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants