mirror of
https://github.com/inspec/inspec
synced 2024-09-20 06:21:56 +00:00
29242deb7c
* Remove unused telemetry v1 code Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Sketch out basics of telemetry, with start/stop of invocation telemetry Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Data structure for run telemetry - job capture Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * Add per-control and per-run feature detection Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> * CHEF-4017 Telemetry job api updations (#6965) * Added initial changes to jobs api Signed-off-by: Nik08 <nikita.mathur@progress.com> * Feature flag changes for telemetry Signed-off-by: Nik08 <nikita.mathur@progress.com> * move base, debug and null to its own file structure Signed-off-by: Sathish <sbabu@progress.com> * make HTTP client post requests Signed-off-by: Sathish <sbabu@progress.com> * remove old logic Signed-off-by: Sathish <sbabu@progress.com> * make backend class as `HTTP` Signed-off-by: Sathish <sbabu@progress.com> * CHEF-7258 Fetch and use licensing information for telemetry (#6964) * Added method to fetch license ids for inspec Signed-off-by: Nik08 <nikita.mathur@progress.com> * Added free license check for performing telemetry api call Signed-off-by: Nik08 <nikita.mathur@progress.com> * move base, debug and null to its own file structure Signed-off-by: Sathish <sbabu@progress.com> * make HTTP client post requests Signed-off-by: Sathish <sbabu@progress.com> * remove old logic Signed-off-by: Sathish <sbabu@progress.com> * make backend class as `HTTP` Signed-off-by: Sathish <sbabu@progress.com> --------- Signed-off-by: Nik08 <nikita.mathur@progress.com> Signed-off-by: Sathish <sbabu@progress.com> Co-authored-by: Sathish <sbabu@progress.com> * Updated control tags and desc value to be used in jobs api Signed-off-by: Nik08 <nikita.mathur@progress.com> * Added checks for automate run context and free license check Signed-off-by: Nik08 <nikita.mathur@progress.com> * capture target mode and id Signed-off-by: Sathish <sbabu@progress.com> * profile doesn't need ID Signed-off-by: Sathish <sbabu@progress.com> * use run context to set environment data Signed-off-by: Sathish <sbabu@progress.com> * refactor `create_wrapper` to be localized Signed-off-by: Sathish <sbabu@progress.com> * change all timestamps to be UTC Signed-off-by: Sathish <sbabu@progress.com> * Null checks for response and corrected job api endpoint Signed-off-by: Nik08 <nikita.mathur@progress.com> * Fixed tag values to be sent as string in api call Signed-off-by: Nik08 <nikita.mathur@progress.com> * make version as float Signed-off-by: Sathish <sbabu@progress.com> * add platform name Signed-off-by: Sathish <sbabu@progress.com> * Added control result data in jobs api payload Signed-off-by: Nik08 <nikita.mathur@progress.com> * Debug logs added for telemetry call Signed-off-by: Nik08 <nikita.mathur@progress.com> * Removed unwanted telemetry debug class Signed-off-by: Nik08 <nikita.mathur@progress.com> * Payload fix to pass features data only on per control basis Signed-off-by: Nik08 <nikita.mathur@progress.com> * Added class function to list all invoked features by feature sub system Signed-off-by: Nik08 <nikita.mathur@progress.com> * Using feature system to get all invoked features list to be used in jobs api Signed-off-by: Nik08 <nikita.mathur@progress.com> * Unit tests cases updated and fixed Signed-off-by: Nik08 <nikita.mathur@progress.com> * License type check downcased Signed-off-by: Nik08 <nikita.mathur@progress.com> * Lint fix Signed-off-by: Nik08 <nikita.mathur@progress.com> * CHEF-7265 Telemetry opt-in for CINC users (#6966) * Enabled telemtry opt-in Signed-off-by: Nik08 <nikita.mathur@progress.com> * Removed old comments Signed-off-by: Nik08 <nikita.mathur@progress.com> * Unit test case added to validate the disabling telemetry behaviour for inspec user Signed-off-by: Nik08 <nikita.mathur@progress.com> --------- Signed-off-by: Nik08 <nikita.mathur@progress.com> --------- Signed-off-by: Nik08 <nikita.mathur@progress.com> Signed-off-by: Sathish <sbabu@progress.com> Co-authored-by: Sathish <sbabu@progress.com> * Product team review changes - only disable telemetry for commercial license users Signed-off-by: Nik08 <nikita.mathur@progress.com> * Connection failure handling for telemetry http call Signed-off-by: Nik08 <nikita.mathur@progress.com> * Testing fix - Remove usage of deleted library Signed-off-by: Nik08 <nikita.mathur@progress.com> * Telemetry test case fix - Issue caused because unit test are run without feature flag env set Signed-off-by: Nik08 <nikita.mathur@progress.com> * Fixed and replaced tightly coupled semver versioning regex matching test for telemetry data Signed-off-by: Nik08 <nikita.mathur@progress.com> * Telemery test fix to use license key from env or a dummy value if not set in env Signed-off-by: Nik08 <nikita.mathur@progress.com> * Added error logs in case the http call is not successful for telemetry Signed-off-by: Nik08 <nikita.mathur@progress.com> * Error handling for telemetry start and run calls Signed-off-by: Nik08 <nikita.mathur@progress.com> * Telemetry opt-in changes (#7055) * Removed usage of feature system to enable telemetry - making it opt-in by default Signed-off-by: Nik08 <nikita.mathur@progress.com> * Telemetry disable check fix when no option is passed in args Signed-off-by: Nik08 <nikita.mathur@progress.com> * Fix in test to use license specs defined for testing Signed-off-by: Nik08 <nikita.mathur@progress.com> --------- Signed-off-by: Nik08 <nikita.mathur@progress.com> * (Restoring) CHEF-10392 load default telemetry url conditionally (#7059) * load default telemetry url conditionally Signed-off-by: Sathish <sbabu@progress.com> * remove version base path version base path is defined in jobs path already Signed-off-by: Sathish <sbabu@progress.com> * use `CHEF_` prefix for the ENV Signed-off-by: Sathish <sbabu@progress.com> --------- Signed-off-by: Sathish <sbabu@progress.com> Co-authored-by: Sathish <sbabu@progress.com> * Typo fix in features list Signed-off-by: Nik08 <nikita.mathur@progress.com> * Stub added for CI license key Signed-off-by: Nik08 <nikita.mathur@progress.com> * License usage telemetry correction - not track control results (#7060) Signed-off-by: Nik08 <nikita.mathur@progress.com> * Changes to disable telemetry for other InSpec distros (#7065) Signed-off-by: Nik08 <nikita.mathur@progress.com> * Lint issue fix Signed-off-by: Nik08 <nikita.mathur@progress.com> * Removing disable telemetry test - breaks on CI because of commercial license usage Signed-off-by: Nik08 <nikita.mathur@progress.com> * CHEF-13228 Chef licensing telemetry documentation (#7056) * WIP chef telemetry env variable usage updated Signed-off-by: Nik08 <nikita.mathur@progress.com> * WIP intro added for chef telemetry - requires edit Signed-off-by: Nik08 <nikita.mathur@progress.com> * Correction in opt in behaviour of telemetry Signed-off-by: Nik08 <nikita.mathur@progress.com> * Doc update after default opt in changes Signed-off-by: Nik08 <nikita.mathur@progress.com> * Doc edit from product Signed-off-by: Nik08 <nikita.mathur@progress.com> * Doc edit Signed-off-by: Nik08 <nikita.mathur@progress.com> * Edits Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> --------- Signed-off-by: Nik08 <nikita.mathur@progress.com> Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: Ian Maddaus <ian.maddaus@progress.com> * Updated version pinning of chef licensing to version 1 for chef telemetry Signed-off-by: Nik08 <nikita.mathur@progress.com> --------- Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com> Signed-off-by: Nik08 <nikita.mathur@progress.com> Signed-off-by: Sathish <sbabu@progress.com> Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: Nikita Mathur <Nik08@users.noreply.github.com> Co-authored-by: Sathish <sbabu@progress.com> Co-authored-by: Nik08 <nikita.mathur@progress.com> Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
97 lines
4 KiB
YAML
97 lines
4 KiB
YAML
---
|
|
features:
|
|
inspec-cli-exec:
|
|
description: Run InSpec profile code at the command line.
|
|
inspec-cli-shell:
|
|
description: Experiment with InSpec Language interactively.
|
|
inspec-cli-check:
|
|
description: Examine a profile for problems.
|
|
inspec-cli-json:
|
|
description: Generate JSON summary for inspec profile/s.
|
|
inspec-cli-export:
|
|
description: Generate summary in specified formats for profile/s.
|
|
inspec-cli-vendor:
|
|
description: Download all profile dependencies and generate a lockfile in vendor directory.
|
|
inspec-cli-archive:
|
|
description: Archive a profile to tar.gz (default) or zip.
|
|
inspec-cli-detect:
|
|
description: Detect the target OS.
|
|
inspec-cli-env:
|
|
description: Output shell-appropriate completion configuration.
|
|
inspec-cli-schema:
|
|
description: Print the JSON schema.
|
|
inspec-cli-run-context:
|
|
description: Test run-context detection.
|
|
inspec-cli-version:
|
|
description: Print the version of InSpec.
|
|
inspec-cli-clear-cache:
|
|
description: Clear InSpec cache stored in ~/.inspec/cache or specific vendor cache path.
|
|
inspec-cli-compliance-login:
|
|
description: Login to Automate Server using InSpec.
|
|
inspec-cli-compliance-profiles:
|
|
description: Lists all uploaded profiles from automate server.
|
|
inspec-cli-compliance-exec:
|
|
description: Run InSpec profile from a list of profiles in automate server.
|
|
inspec-cli-compliance-download:
|
|
description: Download the InSpec profile from automate server.
|
|
inspec-cli-compliance-upload:
|
|
description: Upload InSpec profile to automate server.
|
|
inspec-cli-compliance-version:
|
|
description: Print the version of Automate Server.
|
|
inspec-cli-compliance-logout:
|
|
description: Logout from Automate Server.
|
|
inspec-cli-habitat-profile-create:
|
|
description: Create Habitat Artifact for the InSpec profile.
|
|
inspec-cli-habitat-profile-setup:
|
|
description: Configure Habitat Artifact.
|
|
inspec-cli-habitat-profile-upload:
|
|
description: Upload Habitat Artifact for the InSpec profile to Habitat Builder Depot.
|
|
inspec-cli-init-profile:
|
|
description: Generate a new InSpec profile.
|
|
inspec-cli-init-plugin:
|
|
description: Generate a new InSpec plugin.
|
|
inspec-cli-init-resource:
|
|
description: Generate a new InSpec resource.
|
|
inspec-cli-parallel-exec:
|
|
description: Run list of InSpec exec operations parallely.
|
|
inspec-cli-sign-generate-keys:
|
|
description: Generate a RSA key pair for signing and verification.
|
|
inspec-cli-sign-profile:
|
|
description: Sign InSpec profile and generate .iaf artifact.
|
|
inspec-cli-sign-verify:
|
|
description: Verify a signed profile .iaf artifact.
|
|
inspec-enhanced-outcomes:
|
|
description: Use enhanced outcomes in reporters
|
|
inspec-waivers:
|
|
description: Use waivers mechanism with one or more waiver files.
|
|
inspec-reporter-cli:
|
|
description: Use CLI reporter.
|
|
inspec-reporter-json:
|
|
description: Use JSON reporter.
|
|
inspec-reporter-json-automate:
|
|
description: Use JSON automate reporter.
|
|
inspec-reporter-automate:
|
|
description: Use automate reporter.
|
|
inspec-reporter-yaml:
|
|
description: Use YAML reporter.
|
|
inspec-reporter-json-min:
|
|
description: Use JSON min reporter for minimal JSON output.
|
|
inspec-reporter-junit:
|
|
description: Use JUnit reporter.
|
|
inspec-reporter-junit2:
|
|
description: Use JUnit2 reporter.
|
|
inspec-reporter-html2:
|
|
description: Use HTML reporter.
|
|
inspec-reporter-progress-bar:
|
|
description: Use progress bar streaming reporter
|
|
inspec-reporter-child-status:
|
|
description: Child status reporter used in inspec parallel reporting.
|
|
inspec-mandatory-profile-signing:
|
|
description: Required to use a signed Inspec profile by default with inspec commands
|
|
env_preview: true
|
|
inspec-audit-logging:
|
|
description: Use audit logging.
|
|
env_preview: true
|
|
inspec-telemetry-client:
|
|
description: Perform license usage telemetry.
|
|
env_preview: true
|