Chef InSpec Inputs

Working of input precedence

A priority value is given to the operation each time an input provider puts a value on an input. Multiple assignments with various priority levels may take place throughout the input's lifetime. The input is analyzed, and the setting event with the highest priority is used to determine the current value.

When you set the value using some input providers, you can also define a priority. As an illustration, use these words to set a metadata file's priority to 50:

inputs:
- name: very_important_input
  value: 12
  priority: 50

Simple precedence 

Simple precedence allows you to override inline values from the parent profile in child profiles as well as input values on the command line. This explanation makes some edge cases easier to understand while accurately describing the general behavior of InSpec v3.

Working with Inputs in Control Code

The scope is input everywhere. All areas of the InSpec profile DSL accept inputs. They can be utilized in any place. 

For setting inputs in the control DSL, You can set an input value in the DSL by writing input('some_name', value: 'some_value'). A new value will be set as a result of the value: option being present.

For reading inputs in control DSL, with or without additional arguments, the value of the input will be resolved and returned when you call to input("some name"). It should be noted that this process might entail getting the value from a different source, using the value configured in DSL, or overriding the value supplied in the same request.

Configuring Inputs in Profile Metadata

A metadata file called inspec.yml is located at the root of each Chef InSpec profile. You may include an inputs section in that file. There, you can define inputs by stating explicitly the values, type checking, and whether the input is necessary. 

The definition of inputs in profile metadata has two main benefits:

1. A user of your profile does not need to go through the control code to find the inputs because they are listed explicitly in one place in simple YAML.
2. By leveraging profile inheritance, you can modify inputs in other profiles on which you rely.

By naming the dependant profile and including the profile option, you can change the value of the input when your profile depends on another profile using the depends key in the metadata file.

Setting Input values using --input-file

On the command line, you may also supply inputs and values via YAML files. The format is displayed below:

an_input: a_value
another_input: another_value

The priority for CLI-input-file-set inputs is 40.

Setting Input values using --input

On the command line, you can also directly enter values and inputs:

inspec exec my_profile --input input_name=input_value

Try this to set multiple inputs:

inspec exec my_profile --input input_name1=input_value1 name2=value2

Repeating the --input flag will override the previous setting; avoid doing so. The priority of inputs set by the CLI is 50.

Input Options Reference

Name 

Required String. This option identifies the input.

Description 

Optional String. Human-meaningful explanation of the input.

Value 

Optional, any Ruby or YAML type.

Type 

Optional, String. This value must be one of String, Numeric, Regexp, Array, Hash, Boolean, or Any. 

Required 

Optional, true or false. If true, control using the input will be failed if it reads the value when none has been set.

Priority 

Optional, Integer, 0-100. Higher values make this assignment have higher precedence. This is an advanced feature.

Profile 

Optional, String. Allows you to set input in another profile from your profile.

Sensitive 

Optional, true or false. If this is the case, the value of the input will be utilized normally during the exec run, but it won't be seen in the "inputs" or "attributes" part of any Reporter that specifically displays inputs. Instead, the value will be hidden as "***." 

Frequently Asked Questions

What Takes Place Throughout The Bootstrap Procedure?

The node downloads and installs chef-client registers with the Chef server, and performs the first check-in during the bootstrap procedure. The node applies any cookbooks that are on its run list at this time.

When your cookbook is prepared for use in production, what version would you set it to?

In accordance with Semantic Versioning, once your cookbook is prepared for usage in production, you should set its version number to 1.0.0.

Describe Chef Desktop.

It enables remote management of IT resources from a central location, including laptops, desktops, and kiosk workstations. It automates the management, deployment, and security of IT resources. It automates time-consuming manual procedures and removes them, such as adopting policy-driven configuration.

Conclusion

To conclude this blog, we discussed the basics of Chef InSpec and Chef InSpec inputs. We saw working of input precedence. We also discussed Working with Inputs in Control Code, Configuring Inputs in Profile Metadata, setting Input values using --input-file, and setting Input values using --input. In the end, we saw input options reference. 

For more content, Refer to our guided paths on Coding Ninjas Studio to upskill yourself.

Do upvote our blogs if you find them helpful and engaging!

Happy Learning!