Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-22 04:33:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore: update doc for automate upload with --legacy flag

Browse source 
Signed-off-by: Sonu Saha <ahasunos@gmail.com>
This commit is contained in:
Sonu Saha 2024-11-06 16:34:49 +05:30
parent c77c16a1fd
commit dccfdae9ea
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lib/plugins/inspec-compliance/README.md
View file

@ -14,8 +14,18 @@ To use the CLI, this InSpec add-on adds the following commands:
* `$ inspec automate profiles` - list all available Compliance profiles * `$ inspec automate profiles` - list all available Compliance profiles
* `$ inspec exec compliance://profile` - runs a Compliance profile * `$ inspec exec compliance://profile` - runs a Compliance profile
* `$ inspec automate upload path/to/local/profile` - uploads a local profile to Chef Automate/Chef Compliance * `$ inspec automate upload path/to/local/profile` - uploads a local profile to Chef Automate/Chef Compliance
* `$ inspec automate upload path/to/local/profile --legacy` - uploads a local profile to Chef Automate/Chef Compliance using legacy functionalities of inspec check and inspec export
*Options*:
```
[--overwrite], [--no-overwrite] # Overwrite existing profile on Server.
[--owner=OWNER] # Owner that should own the profile
[--legacy], [--no-legacy] # Enable legacy functionality, activating both legacy export and legacy check.
uploads a local profile to Chef Automate
```
* `$ inspec automate logout` - logout of Chef Automate/Chef Compliance * `$ inspec automate logout` - logout of Chef Automate/Chef Compliance
Similar to these CLI commands are: Similar to these CLI commands are:
* `$ inspec compliance login` - authentication of the API token against Chef Automate/Chef Compliance * `$ inspec compliance login` - authentication of the API token against Chef Automate/Chef Compliance