Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-23 05:03:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #181 from chef/update-docs

Browse source 
Merged change e2cba636-a73f-406a-b609-ea044778b6d4

From review branch update-docs into master

Signed-off-by: drichter <drichter@chef.io>
This commit is contained in:
chef-delivery 2015-11-01 17:09:39 -08:00
commit ca214bfb34
4 changed files with 224 additions and 341 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
bin/inspec
View file

@ -25,7 +25,7 @@ class InspecCLI < Thor
option :key_files, type: :array, default: nil, option :key_files, type: :array, default: nil,
desc: 'Login key or certificate file for a remote scan.' desc: 'Login key or certificate file for a remote scan.'
option :path, type: :string, default: nil, option :path, type: :string, default: nil,
desc: 'Login path to use when connecting to the target.' desc: 'Login path to use when connecting to the target (WinRM).'
option :sudo, type: :boolean, default: false, option :sudo, type: :boolean, default: false,
desc: 'Run scans with sudo. Only activates on Unix and non-root user.' desc: 'Run scans with sudo. Only activates on Unix and non-root user.'
option :sudo_password, type: :string, default: nil, option :sudo_password, type: :string, default: nil,

5
docs/ctl_inspec.rst
View file

@ -17,14 +17,14 @@ The following options may be used with any of the InSpec CLI subcommands:
``--host`` ``--host``
The remote host to be tested. The remote host to be tested.
``--key`` ``--key-files``
The login key or certificate file required for remote scanning. The login key or certificate file required for remote scanning.
``--password`` ``--password``
The login password for remote scanning. The login password for remote scanning.
``--path`` ``--path``
The login path used to connect to the target. The login path used to connect to the target for |winrm|.
``--port`` ``--port``
The port over which remote scanning will occur. The port over which remote scanning will occur.
@ -192,3 +192,4 @@ Use ``inspec version`` to print the version of the InSpec CLI.
.. _winrm: https://msdn.microsoft.com/en-us/library/aa384426(v=vs.85).aspx .. _winrm: https://msdn.microsoft.com/en-us/library/aa384426(v=vs.85).aspx
.. |docker| replace:: Docker .. |docker| replace:: Docker
.. _docker: https://www.docker.com/ .. _docker: https://www.docker.com/
.. |json| replace:: JSON

2
docs/readme.rst
View file

@ -90,7 +90,7 @@ bundle exec bin/inspec exec demo/test/example_spec.rb
Stability Index Stability Index
----------------------------------------------------- -----------------------------------------------------
Every available InSpec resource will indiate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such. Every available InSpec resource will indicate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such.
The stability indices are as follows: The stability indices are as follows:

556
docs/resources.rst
View file

File diff suppressed because it is too large Load diff