Adding docs readme and getting started guide #66
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
Signed-off-by: Aravind Ramalingam <ramaliar@amazon.com>
Signed-off-by: Aravind Ramalingam <ramaliar@amazon.com>
Codecov Report
@@ Coverage Diff @@
## main #66 +/- ##
=======================================
Coverage 59.50% 59.50%
=======================================
Files 4 4
Lines 321 321
=======================================
Hits 191 191
Misses 97 97
Partials 33 33 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
This is great, thanks for putting this together @pokearu! I left a few comments.
Signed-off-by: Aravind Ramalingam <ramaliar@amazon.com>
jacobweinstock
approved these changes
Sep 8, 2022
|  | ||
| Rufio controller consists of three main API types, [Machine](https://github.com/tinkerbell/rufio/blob/main/api/v1alpha1/machine.go), [Job](https://github.com/tinkerbell/rufio/blob/main/api/v1alpha1/job.go) and [Task](https://github.com/tinkerbell/rufio/blob/main/api/v1alpha1/task.go). An operator or an automated client like [CAPT](https://github.com/tinkerbell/cluster-api-provider-tinkerbell) can interact with Rufio using these APIs to manage the state of their physical machines. | ||
| ### Machine API | ||
| The Machine type contains the information required for communicating with the BMC of the physical hardware. |
There was a problem hiding this comment.
Suggested change
| The Machine type contains the information required for communicating with the BMC of the physical hardware. | |
| The Machine type contains the information required for communicating with a BMC. |
| namespace: sample | ||
| insecureTLS: false | ||
| ``` | ||
| The `connection` object contains the required fields for establising a BMC connection. Fields `host`, `port` represent the BMC IP for the physical machine and `insecureTLS` instructs weather to use insecure TLS connectivity for performing BMC API calls. Field `authSecretRef` is a `SecretReference` which points to a kubernetes secret that contains the username/password for authenticating BMC API calls. |
There was a problem hiding this comment.
I think this level of docs would be better placed on the API types themselves. We can link to that as needed.
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.
Description
Adding documentation to elaborate on rufio API and a getting started guide.