Skip to content

Added documentation for Data Movement Configuration - #43

Merged
bdevcich merged 2 commits into
mainfrom
dm-config
Apr 26, 2023
Merged

Added documentation for Data Movement Configuration#43
bdevcich merged 2 commits into
mainfrom
dm-config

Conversation

@bdevcich

Copy link
Copy Markdown
Contributor

No description provided.

Signed-off-by: Blake Devcich <blake.devcich@hpe.com>
Comment thread docs/guides/index.md
## Provisioning

* [Storage Profiles](storage-profiles/readme.md)
* [Data Movement Configuration](data-movement/readme.md)

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.

And update mkdocs.yml.

Comment thread docs/guides/data-movement/readme.md Outdated
Comment thread docs/guides/data-movement/readme.md Outdated

## Server Side ConfigMap

The server side configuration is done via the `nnf-dm-config` config map:

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.

Does the nnf-dm installation provide the initial version of this configmap? It's not clear.

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.

Comment thread docs/guides/data-movement/readme.md Outdated
options to allow a user to specify some options for that particular Data Movement. These settings
are on a per-request basis.

See the [CreateRequest API](https://github.com/NearNodeFlash/nnf-dm/blob/master/daemons/compute/Readme.md#create-request)

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.

This should jump within the rendered doc, rather than jumping back to the github repo.

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.

I'm working on replacing the API documentation with some HTML documentation, but that will still live in the nnf-dm repo for now. Is there a better way of doing that?

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.

oh. I thought that "createrequest api" doc was already in this doc. So scratch that comment.

I think you want that API doc here. So we can point to one place for everything.

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.

I agree with that. There's some other docs in the nnf-dm that really should be here too.

With the API docs, those are generated in the nnf-dm repo (along with the client API examples/libs). I'm going to play around with how we can pull that document into this, but I'll do that in another PR.

Signed-off-by: Blake Devcich <blake.devcich@hpe.com>
@bdevcich
bdevcich merged commit 1cd1707 into main Apr 26, 2023
@bdevcich
bdevcich deleted the dm-config branch April 26, 2023 20:39
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.

3 participants