[W.I.P] Dev docs for Inspec::Backend #6831
Open
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
✅ Deploy Preview for chef-inspec canceled.
|
Vasu1105
changed the title
Vasu1105
changed the title
Vasu1105
changed the title
Signed-off-by: Vasu1105 <[email protected]>
Vasu1105
force-pushed
the
vj/dev-docs-for-backend
branch
from
e06672b
to
b30726c
Compare
| * identify the target operating system via os | ||
| * authenticate to API-based services and treat them like a platform | ||
|
|
||
| When inspec exec command is run with --target option it establishes the connection to that target using speficifed transport like ssh, winrm etc. By default it uses local transport if the --target is not provided. Backend class is responsible for creating this transprot and establish connection using train. |
There was a problem hiding this comment.
You should probably mention that tran transports are plugins - gems that can be externally loaded and maintained outside of InSpec and Train.
| ## Mock backend | ||
|
|
||
| Mock is used primarily for testing and debugging. This is used to create a dummy connection. | ||
| InSpec use Mock backend in unit testing environment and some places in code base where backend object is required but it does not require for any real time connection or execution of commands. For example inspec export, check, archive are some of the cli commands uses mock bockend as it required by profile object( https://github.com/inspec/inspec/blob/main/lib/inspec/config.rb#L187) else if not provided it creates the backend with local(https://github.com/inspec/inspec/blob/main/lib/inspec/config.rb#L187) transport which is not required for export, check and archive. |
There was a problem hiding this comment.
When writing devdocs, use permalink URLs - line 187 may change over time.
Comment on lines
+29
to
+30
| It call unpack_train_credentials of config.rb which returns the hash containing backend, logger and few more details | ||
| example |
There was a problem hiding this comment.
Try to explain at the level of intent. "Why" is it doing that. Why is important that it does what it is doing. Highlight the important parts and omit the routine parts. Thanks!
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
Dev docs to understand
Related Issue
Types of changes
Checklist: