docs: rework development guide #1126
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mythi
requested review from
bart0sh,
hj-johannes-lee,
ozhuraki,
tkatila,
uniemimu and
kad
as code owners
bart0sh
reviewed
Aug 31, 2022
bart0sh
reviewed
Aug 31, 2022
eero-t
reviewed
Aug 31, 2022
Codecov Report
@@ Coverage Diff @@
## main #1126 +/- ##
=======================================
Coverage 52.99% 52.99%
=======================================
Files 40 40
Lines 4357 4357
=======================================
Hits 2309 2309
Misses 1921 1921
Partials 127 127 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Currently, each individual plugin README documents roughly the same
daily development steps to git clone, build, and deploy. Re-purpose
the plugin READMEs more towards cluster admin type of documentation
and start moving all development related documentation to DEVEL.md.
The same is true for e2e testing documentation which is scattered
in places where they don't belong to. Having all day-to-day
development Howtos is good to have in a centralized place.
Finally, the cleanup includes some harmonization to plugins'
table of contents which now follows the pattern:
* [Introduction](#introduction)
(* [Modes and Configuration Options](#modes-and-configuration-options))
* [Installation](#installation)
(* [Prerequisites](#prerequisites))
* [Pre-built Images](#pre-built-images)
* [Verify Plugin Registration](#verify-plugin-registration)
* [Testing and Demos](#testing-and-demos)
* ...
Signed-off-by: Mikko Ylinen <[email protected]>
Merged
|
/lgtm |
|
Summary of items discussed above which were scoped out to further PRs:
|
|
@mythi github doesn't allow me to merge this PR. Feel free to merge it. |
hj-johannes-lee
approved these changes
Sep 2, 2022
| @@ -37,7 +30,7 @@ The components together implement the following features: | |||
| - orchestration of FPGA programming | |||
| - access control for FPGA hardware | |||
|
|
|||
| ## Component overview | |||
| ### Component overview | |||
There was a problem hiding this comment.
Do we capitalize all of these?
There was a problem hiding this comment.
Let me fix these in a separate PR
| @@ -70,7 +63,7 @@ Kubernetes: | |||
| The repository also contains an [FPGA helper tool](../fpga_tool/README.md) that may be useful during | |||
| development, initial deployment and debugging. | |||
|
|
|||
| ## FPGA modes | |||
| ### Modes and Configuration options | |||
There was a problem hiding this comment.
Do we capitalize all of these?
|
|
||
| The below sections cover `DPDK` and `OpenSSL` demos, both of which utilise the | ||
| QAT device plugin under Kubernetes. | ||
|
|
||
| #### DPDK QAT demos | ||
| ### DPDK QAT demos |
There was a problem hiding this comment.
Do we capitalize all of these?
| @@ -289,7 +169,7 @@ $ kubectl get pods | |||
| > **Note**: If the `igb_uio` VF driver is used with the QAT device plugin, | |||
| > the workload be deployed with `SYS_ADMIN` capabilities added. | |||
|
|
|||
| ##### Manual test run | |||
| #### Manual test run | |||
There was a problem hiding this comment.
Do we capitalize all of these?
| $ kubectl logs qat-dpdk-test-crypto-perf-tc1 | ||
| $ kubectl logs qat-dpdk-test-compress-perf-tc1 | ||
| ``` | ||
|
|
||
| > **Note**: for `test-crypto1` and `test-compress1` to work, the cluster must enable | ||
| [Kubernetes CPU manager's](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/) `static` policy. | ||
|
|
||
| #### OpenSSL QAT demo | ||
| ### OpenSSL QAT demo |
There was a problem hiding this comment.
Do we capitalize all of these?
| @@ -306,22 +186,22 @@ $ dpdk-test-crypto-perf -l 6-7 -w $QAT1 \ | |||
|
|
|||
| > **Note**: Adapt the `.so` versions to what the DPDK version in the container provides. | |||
|
|
|||
| ##### Automated test run | |||
| #### Automated test run | |||
There was a problem hiding this comment.
Do we capitalize all of these?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, each individual plugin README documents roughly the same
daily development steps to git clone, build, and deploy. Re-purpose
the plugin READMEs more towards cluster admin type of documentation
and start moving all development related documentation to DEVEL.md.
The same is true for e2e testing documentation which is scattered
in places where they don't belong to. Having all day-to-day
development Howtos is good to have in a centralized place.
Finally, the cleanup includes some harmonization to plugins'
table of contents which now follows the pattern:
(* Modes and Configuration Options)
(* Prerequisites)
Signed-off-by: Mikko Ylinen [email protected]