Improve CDH docs #518
Merged
Improve CDH docs #518
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
Xynnn007
reviewed
Mar 24, 2024
fitzthum
approved these changes
Mar 25, 2024
|
|
||
| ## Example: offline_fs_kbc | ||
|
|
||
| In this example we will use the `offline_fs_kbc` KBC to get resouces from the local filesystem. |
There was a problem hiding this comment.
Maybe mention here that this example is not running with k8s or a VM or anything. Also minor typo resouces -> resources.
confidential-data-hub/README.md
Outdated
| * **agent.aa_kbc_params** parameter from the Kernel command-line (`/proc/cmdline`) | ||
|
|
||
| There is a special case which is when running from [peer pods](http://github.com/confidential-containers/cloud-api-adaptor). It | ||
| will try to read from the kata-agent file (**/etc/agent-config.toml** or **KATA_AGENT_CONFIG_PATH** environment variable) pior |
There was a problem hiding this comment.
curiosity: PT_BR("pior") == EN_US("worst")
wainersm
force-pushed
the
cdh_docs
branch
2 times, most recently
from
894cb23 to
77f147f
Compare
|
addressed @fitzthum 's comments |
Created docs/RESOURCES_SERVICES.md to document the resources API and services. Added an example of how to run locally with `offline_fs_kbc`. Signed-off-by: Wainer dos Santos Moschetta <[email protected]>
Complement the CDH's README.md with information about the logic it uses to get configured on the absence of an explicity configuration file passed. Signed-off-by: Wainer dos Santos Moschetta <[email protected]>
It is missing CDH from the list of components on the main README. Signed-off-by: Wainer dos Santos Moschetta <[email protected]>
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.
Sending a few improvements to the CDH docs:
Cc @fitzthum @Xynnn007