From 0abb107cd0af7267031ef843a6e797769ab66af1 Mon Sep 17 00:00:00 2001 From: IanMadd Date: Tue, 4 Aug 2020 10:59:04 -0700 Subject: [PATCH 1/7] Remove shortcodes Signed-off-by: IanMadd --- www/layouts/shortcodes/ws_bento.md | 5 - .../ws_chef_client_bootstrap_node.md | 9 -- .../ws_chef_repo_many_users_same_knife.md | 29 ---- .../ws_chef_shell_advanced_debug.md | 32 ---- .../shortcodes/ws_chef_shell_breakpoints.md | 3 - .../shortcodes/ws_chef_shell_config.md | 14 -- .../shortcodes/ws_chef_shell_config_rb.md | 16 -- .../ws_chef_shell_debug_existing_recipe.md | 39 ----- ...s_chef_shell_example_get_specific_nodes.md | 23 --- .../ws_chef_shell_example_hello_world.md | 122 --------------- .../shortcodes/ws_chef_shell_manage.md | 132 ---------------- www/layouts/shortcodes/ws_chef_shell_modes.md | 30 ---- .../ws_chef_shell_run_as_chef_client.md | 14 -- .../ws_chef_shell_step_through_run_list.md | 89 ----------- .../shortcodes/ws_chef_shell_summary.md | 4 - www/layouts/shortcodes/ws_chef_tags.md | 4 - www/layouts/shortcodes/ws_chef_workstation.md | 9 -- www/layouts/shortcodes/ws_chefspec_summary.md | 5 - .../ws_config_rb_client_dot_d_directories.md | 41 ----- .../shortcodes/ws_cookbooks_summary.md | 10 -- .../ws_ctl_kitchen_common_option_platforms.md | 15 -- .../shortcodes/ws_ctl_kitchen_summary.md | 23 --- .../ws_ctl_push_jobs_client_summary.md | 1 - www/layouts/shortcodes/ws_data_bag.md | 2 - .../shortcodes/ws_data_bag_encryption.md | 24 --- www/layouts/shortcodes/ws_environment.md | 10 -- .../shortcodes/ws_fips_intro_client.md | 32 ---- www/layouts/shortcodes/ws_knife_azure.md | 4 - .../ws_knife_bootstrap_no_validator.md | 42 ------ .../ws_knife_bootstrap_node_fips.md | 11 -- .../shortcodes/ws_knife_bootstrap_summary.md | 3 - .../shortcodes/ws_knife_client_summary.md | 4 - .../ws_knife_common_see_all_config_options.md | 3 - ...ws_knife_common_see_common_options_link.md | 2 - .../ws_knife_common_windows_quotes.md | 18 --- .../ws_knife_common_windows_quotes_module.md | 53 ------- .../shortcodes/ws_knife_configure_summary.md | 3 - .../shortcodes/ws_knife_cookbook_summary.md | 2 - .../shortcodes/ws_knife_data_bag_edit.md | 4 - .../shortcodes/ws_knife_data_bag_edit_item.md | 27 ---- ...g_from_file_create_encrypted_local_mode.md | 11 -- .../shortcodes/ws_knife_data_bag_summary.md | 2 - .../shortcodes/ws_knife_delete_summary.md | 5 - .../shortcodes/ws_knife_deps_summary.md | 2 - .../shortcodes/ws_knife_diff_summary.md | 8 - .../shortcodes/ws_knife_download_summary.md | 9 -- .../shortcodes/ws_knife_edit_admin_users.md | 9 -- .../shortcodes/ws_knife_edit_summary.md | 4 - .../ws_knife_environment_summary.md | 2 - .../shortcodes/ws_knife_exec_summary.md | 5 - .../shortcodes/ws_knife_list_summary.md | 4 - .../shortcodes/ws_knife_node_run_list_add.md | 2 - ..._knife_node_run_list_add_default_recipe.md | 5 - .../ws_knife_node_run_list_add_options.md | 9 -- ..._node_run_list_add_recipe_with_cookbook.md | 5 - ...nife_node_run_list_add_recipe_with_fqdn.md | 5 - .../ws_knife_node_run_list_add_role.md | 5 - ...ife_node_run_list_add_roles_and_recipes.md | 5 - .../ws_knife_node_run_list_add_syntax.md | 5 - .../ws_knife_node_run_list_remove.md | 7 - .../ws_knife_node_run_list_remove_role.md | 5 - .../ws_knife_node_run_list_remove_run_list.md | 6 - .../ws_knife_node_run_list_remove_syntax.md | 5 - .../shortcodes/ws_knife_node_run_list_set.md | 6 - .../ws_knife_node_run_list_set_syntax.md | 5 - .../shortcodes/ws_knife_node_summary.md | 2 - .../shortcodes/ws_knife_raw_summary.md | 2 - .../ws_knife_recipe_list_summary.md | 5 - .../shortcodes/ws_knife_role_summary.md | 2 - .../shortcodes/ws_knife_search_by_cookbook.md | 7 - .../ws_knife_search_by_nested_attribute.md | 5 - .../shortcodes/ws_knife_search_by_node.md | 5 - ...ws_knife_search_by_node_and_environment.md | 6 - .../ws_knife_search_by_platform_ids.md | 20 --- ..._knife_search_by_platform_instance_type.md | 24 --- ...ife_search_by_query_for_many_attributes.md | 7 - ...fe_search_by_query_for_nested_attribute.md | 5 - .../shortcodes/ws_knife_search_by_recipe.md | 12 -- .../shortcodes/ws_knife_search_summary.md | 2 - .../ws_knife_search_test_query_for_ssh.md | 8 - .../shortcodes/ws_knife_serve_summary.md | 8 - .../shortcodes/ws_knife_show_summary.md | 5 - .../shortcodes/ws_knife_ssh_summary.md | 3 - .../ws_knife_ssl_check_bad_ssl_certificate.md | 42 ------ .../shortcodes/ws_knife_ssl_check_summary.md | 30 ---- ...ws_knife_ssl_check_verify_server_config.md | 12 -- .../shortcodes/ws_knife_ssl_fetch_summary.md | 27 ---- .../ws_knife_ssl_fetch_verify_certificate.md | 30 ---- .../ws_knife_status_include_run_lists.md | 16 -- .../ws_knife_status_returned_by_query.md | 16 -- .../shortcodes/ws_knife_status_summary.md | 3 - .../shortcodes/ws_knife_tag_summary.md | 2 - .../shortcodes/ws_knife_upload_summary.md | 13 -- .../shortcodes/ws_knife_user_summary.md | 2 - .../shortcodes/ws_knife_windows_summary.md | 5 - .../ws_knife_windows_winrm_ports.md | 2 - .../shortcodes/ws_knife_xargs_summary.md | 3 - www/layouts/shortcodes/ws_node.md | 2 - .../shortcodes/ws_node_ctl_attribute.md | 35 ----- www/layouts/shortcodes/ws_node_run_list.md | 11 -- .../shortcodes/ws_node_run_list_format.md | 20 --- ...nife_cookbook_site_use_devkit_berkshelf.md | 3 - .../shortcodes/ws_push_jobs_summary.md | 11 -- www/layouts/shortcodes/ws_role.md | 9 -- .../ws_ruby_style_patterns_hyphens.md | 6 - www/layouts/shortcodes/ws_search.md | 10 -- .../shortcodes/ws_search_boolean_and.md | 54 ------- .../shortcodes/ws_search_boolean_not.md | 37 ----- .../shortcodes/ws_search_boolean_operators.md | 31 ---- .../ws_search_boolean_operators_andnot.md | 28 ---- .../shortcodes/ws_search_boolean_or.md | 26 ---- www/layouts/shortcodes/ws_search_key.md | 4 - www/layouts/shortcodes/ws_search_key_name.md | 9 -- .../shortcodes/ws_search_key_nested.md | 142 ------------------ .../shortcodes/ws_search_key_nested_range.md | 8 - .../ws_search_key_nested_starting_with.md | 9 -- .../ws_search_key_wildcard_asterisk.md | 6 - .../ws_search_key_wildcard_question_mark.md | 6 - www/layouts/shortcodes/ws_search_pattern.md | 4 - .../shortcodes/ws_search_pattern_exact.md | 8 - .../ws_search_pattern_exact_key_and_item.md | 21 --- ...earch_pattern_exact_key_and_item_string.md | 22 --- .../shortcodes/ws_search_pattern_fuzzy.md | 12 -- .../ws_search_pattern_fuzzy_summary.md | 25 --- .../shortcodes/ws_search_pattern_range.md | 12 -- .../ws_search_pattern_range_exclusive.md | 11 -- .../ws_search_pattern_range_in_between.md | 11 -- .../shortcodes/ws_search_pattern_wildcard.md | 10 -- .../ws_search_pattern_wildcard_any_node.md | 8 - ...s_search_pattern_wildcard_node_contains.md | 26 ---- .../shortcodes/ws_search_query_syntax.md | 15 -- .../ws_search_special_characters.md | 15 -- .../shortcodes/ws_supermarket_api_summary.md | 7 - www/layouts/shortcodes/ws_test_kitchen.md | 10 -- .../ws_test_kitchen_driver_vagrant.md | 4 - .../ws_test_kitchen_driver_vagrant_config.md | 24 --- ...ws_test_kitchen_driver_vagrant_settings.md | 81 ---------- .../shortcodes/ws_test_kitchen_drivers.md | 83 ---------- www/layouts/shortcodes/ws_test_kitchen_yml.md | 2 - .../shortcodes/ws_test_kitchen_yml_syntax.md | 116 -------------- .../ws_test_kitchen_yml_syntax_proxy.md | 43 ------ .../ws_windows_spaces_and_directories.md | 4 - .../ws_windows_top_level_directory_names.md | 6 - 143 files changed, 2427 deletions(-) delete mode 100644 www/layouts/shortcodes/ws_bento.md delete mode 100644 www/layouts/shortcodes/ws_chef_client_bootstrap_node.md delete mode 100644 www/layouts/shortcodes/ws_chef_repo_many_users_same_knife.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_advanced_debug.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_breakpoints.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_config.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_config_rb.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_debug_existing_recipe.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_example_get_specific_nodes.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_example_hello_world.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_manage.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_modes.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_run_as_chef_client.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_step_through_run_list.md delete mode 100644 www/layouts/shortcodes/ws_chef_shell_summary.md delete mode 100644 www/layouts/shortcodes/ws_chef_tags.md delete mode 100644 www/layouts/shortcodes/ws_chef_workstation.md delete mode 100644 www/layouts/shortcodes/ws_chefspec_summary.md delete mode 100644 www/layouts/shortcodes/ws_config_rb_client_dot_d_directories.md delete mode 100644 www/layouts/shortcodes/ws_cookbooks_summary.md delete mode 100644 www/layouts/shortcodes/ws_ctl_kitchen_common_option_platforms.md delete mode 100644 www/layouts/shortcodes/ws_ctl_kitchen_summary.md delete mode 100644 www/layouts/shortcodes/ws_ctl_push_jobs_client_summary.md delete mode 100644 www/layouts/shortcodes/ws_data_bag.md delete mode 100644 www/layouts/shortcodes/ws_data_bag_encryption.md delete mode 100644 www/layouts/shortcodes/ws_environment.md delete mode 100644 www/layouts/shortcodes/ws_fips_intro_client.md delete mode 100644 www/layouts/shortcodes/ws_knife_azure.md delete mode 100644 www/layouts/shortcodes/ws_knife_bootstrap_no_validator.md delete mode 100644 www/layouts/shortcodes/ws_knife_bootstrap_node_fips.md delete mode 100644 www/layouts/shortcodes/ws_knife_bootstrap_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_client_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_common_see_all_config_options.md delete mode 100644 www/layouts/shortcodes/ws_knife_common_see_common_options_link.md delete mode 100644 www/layouts/shortcodes/ws_knife_common_windows_quotes.md delete mode 100644 www/layouts/shortcodes/ws_knife_common_windows_quotes_module.md delete mode 100644 www/layouts/shortcodes/ws_knife_configure_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_cookbook_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_data_bag_edit.md delete mode 100644 www/layouts/shortcodes/ws_knife_data_bag_edit_item.md delete mode 100644 www/layouts/shortcodes/ws_knife_data_bag_from_file_create_encrypted_local_mode.md delete mode 100644 www/layouts/shortcodes/ws_knife_data_bag_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_delete_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_deps_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_diff_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_download_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_edit_admin_users.md delete mode 100644 www/layouts/shortcodes/ws_knife_edit_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_environment_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_exec_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_list_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_add.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_add_default_recipe.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_add_options.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_add_recipe_with_cookbook.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_add_recipe_with_fqdn.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_add_role.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_add_roles_and_recipes.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_add_syntax.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_remove.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_remove_role.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_remove_run_list.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_remove_syntax.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_set.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_run_list_set_syntax.md delete mode 100644 www/layouts/shortcodes/ws_knife_node_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_raw_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_recipe_list_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_role_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_cookbook.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_nested_attribute.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_node.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_node_and_environment.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_platform_ids.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_platform_instance_type.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_query_for_many_attributes.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_query_for_nested_attribute.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_by_recipe.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_search_test_query_for_ssh.md delete mode 100644 www/layouts/shortcodes/ws_knife_serve_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_show_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_ssh_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_ssl_check_bad_ssl_certificate.md delete mode 100644 www/layouts/shortcodes/ws_knife_ssl_check_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_ssl_check_verify_server_config.md delete mode 100644 www/layouts/shortcodes/ws_knife_ssl_fetch_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_ssl_fetch_verify_certificate.md delete mode 100644 www/layouts/shortcodes/ws_knife_status_include_run_lists.md delete mode 100644 www/layouts/shortcodes/ws_knife_status_returned_by_query.md delete mode 100644 www/layouts/shortcodes/ws_knife_status_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_tag_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_upload_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_user_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_windows_summary.md delete mode 100644 www/layouts/shortcodes/ws_knife_windows_winrm_ports.md delete mode 100644 www/layouts/shortcodes/ws_knife_xargs_summary.md delete mode 100644 www/layouts/shortcodes/ws_node.md delete mode 100644 www/layouts/shortcodes/ws_node_ctl_attribute.md delete mode 100644 www/layouts/shortcodes/ws_node_run_list.md delete mode 100644 www/layouts/shortcodes/ws_node_run_list_format.md delete mode 100644 www/layouts/shortcodes/ws_notes_knife_cookbook_site_use_devkit_berkshelf.md delete mode 100644 www/layouts/shortcodes/ws_push_jobs_summary.md delete mode 100644 www/layouts/shortcodes/ws_role.md delete mode 100644 www/layouts/shortcodes/ws_ruby_style_patterns_hyphens.md delete mode 100644 www/layouts/shortcodes/ws_search.md delete mode 100644 www/layouts/shortcodes/ws_search_boolean_and.md delete mode 100644 www/layouts/shortcodes/ws_search_boolean_not.md delete mode 100644 www/layouts/shortcodes/ws_search_boolean_operators.md delete mode 100644 www/layouts/shortcodes/ws_search_boolean_operators_andnot.md delete mode 100644 www/layouts/shortcodes/ws_search_boolean_or.md delete mode 100644 www/layouts/shortcodes/ws_search_key.md delete mode 100644 www/layouts/shortcodes/ws_search_key_name.md delete mode 100644 www/layouts/shortcodes/ws_search_key_nested.md delete mode 100644 www/layouts/shortcodes/ws_search_key_nested_range.md delete mode 100644 www/layouts/shortcodes/ws_search_key_nested_starting_with.md delete mode 100644 www/layouts/shortcodes/ws_search_key_wildcard_asterisk.md delete mode 100644 www/layouts/shortcodes/ws_search_key_wildcard_question_mark.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_exact.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_exact_key_and_item.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_exact_key_and_item_string.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_fuzzy.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_fuzzy_summary.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_range.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_range_exclusive.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_range_in_between.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_wildcard.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_wildcard_any_node.md delete mode 100644 www/layouts/shortcodes/ws_search_pattern_wildcard_node_contains.md delete mode 100644 www/layouts/shortcodes/ws_search_query_syntax.md delete mode 100644 www/layouts/shortcodes/ws_search_special_characters.md delete mode 100644 www/layouts/shortcodes/ws_supermarket_api_summary.md delete mode 100644 www/layouts/shortcodes/ws_test_kitchen.md delete mode 100644 www/layouts/shortcodes/ws_test_kitchen_driver_vagrant.md delete mode 100644 www/layouts/shortcodes/ws_test_kitchen_driver_vagrant_config.md delete mode 100644 www/layouts/shortcodes/ws_test_kitchen_driver_vagrant_settings.md delete mode 100644 www/layouts/shortcodes/ws_test_kitchen_drivers.md delete mode 100644 www/layouts/shortcodes/ws_test_kitchen_yml.md delete mode 100644 www/layouts/shortcodes/ws_test_kitchen_yml_syntax.md delete mode 100644 www/layouts/shortcodes/ws_test_kitchen_yml_syntax_proxy.md delete mode 100644 www/layouts/shortcodes/ws_windows_spaces_and_directories.md delete mode 100644 www/layouts/shortcodes/ws_windows_top_level_directory_names.md diff --git a/www/layouts/shortcodes/ws_bento.md b/www/layouts/shortcodes/ws_bento.md deleted file mode 100644 index 12906fdd4..000000000 --- a/www/layouts/shortcodes/ws_bento.md +++ /dev/null @@ -1,5 +0,0 @@ -[Bento](https://github.com/chef/bento) is a Chef Software project that -produces base testing VirtualBox, Parallels, and VMware boxes for -multiple operating systems for use with Test Kitchen. By default, Test -Kitchen uses the base images provided by Bento although custom images -may also be built using HashiCorp Packer. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_client_bootstrap_node.md b/www/layouts/shortcodes/ws_chef_client_bootstrap_node.md deleted file mode 100644 index 6e2108015..000000000 --- a/www/layouts/shortcodes/ws_chef_client_bootstrap_node.md +++ /dev/null @@ -1,9 +0,0 @@ -A node is any physical, virtual, or cloud device that is configured and -maintained by an instance of Chef Infra Client. Bootstrapping installs -Chef Infra Client on a target system so that it can run as a client and -sets the node up to communicate with a Chef Infra Server. There are two -ways to do this: - -- Run the `knife bootstrap` command from a workstation. -- Perform an unattended install to bootstrap from the node itself, - without requiring SSH or WinRM connectivity. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_repo_many_users_same_knife.md b/www/layouts/shortcodes/ws_chef_repo_many_users_same_knife.md deleted file mode 100644 index f300b6960..000000000 --- a/www/layouts/shortcodes/ws_chef_repo_many_users_same_knife.md +++ /dev/null @@ -1,29 +0,0 @@ -The config.rb configuration can include arbitrary Ruby code to extend -configuration beyond static values. This can be used to load -environmental variables from the workstation. This makes it possible to -write a single config.rb file that can be used by all users within your -organization. This single file can also be checked into your chef-repo, -allowing users to load different config.rb files based on which -chef-repo they execute the commands from. This can be especially useful -when each chef-repo points to a different chef server or organization. - -Example config.rb: - -``` none -current_dir = File.dirname(__FILE__) - user = ENV['CHEF_USER'] || ENV['USER'] - node_name user - client_key "#{ENV['HOME']}/chef-repo/.chef/#{user}.pem" - validation_client_name "#{ENV['ORGNAME']}-validator" - validation_key "#{ENV['HOME']}/chef-repo/.chef/#{ENV['ORGNAME']}-validator.pem" - chef_server_url "https://api.opscode.com/organizations/#{ENV['ORGNAME']}" - syntax_check_cache_path "#{ENV['HOME']}/chef-repo/.chef/syntax_check_cache" - cookbook_path ["#{current_dir}/../cookbooks"] - cookbook_copyright "Your Company, Inc." - cookbook_license "Apache-2.0" - cookbook_email "cookbooks@yourcompany.com" - - # Amazon AWS - knife[:aws_access_key_id] = ENV['AWS_ACCESS_KEY_ID'] - knife[:aws_secret_access_key] = ENV['AWS_SECRET_ACCESS_KEY'] -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_advanced_debug.md b/www/layouts/shortcodes/ws_chef_shell_advanced_debug.md deleted file mode 100644 index 378af37a5..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_advanced_debug.md +++ /dev/null @@ -1,32 +0,0 @@ -In chef-shell, it is possible to get verbose debugging using the tracing -feature in Interactive Ruby (IRb). chef-shell provides a shortcut for -turning tracing on and off. For example: - -``` bash -chef > tracing on -tracing is on -=> nil -chef > -``` - -and: - -``` bash -chef > tracing off -#0:(irb):2:Object:-: tracing off -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:109:Shell::Extensions::ObjectCoreExtensions:>: def off -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:110:Shell::Extensions::ObjectCoreExtensions:-: :off -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:111:Shell::Extensions::ObjectCoreExtensions:<: end -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:272:main:>: def tracing(on_or_off) -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:273:main:-: conf.use_tracer = on_or_off.on_off_to_bool -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:162:Shell::Extensions::Symbol:>: def on_off_to_bool -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:163:Shell::Extensions::Symbol:-: to_s.on_off_to_bool -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:149:Shell::Extensions::String:>: def on_off_to_bool -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:150:Shell::Extensions::String:-: case self -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:154:Shell::Extensions::String:-: false -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:158:Shell::Extensions::String:<: end -#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:164:Shell::Extensions::Symbol:<: end -tracing is off -=> nil -chef > -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_breakpoints.md b/www/layouts/shortcodes/ws_chef_shell_breakpoints.md deleted file mode 100644 index 4c40fb525..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_breakpoints.md +++ /dev/null @@ -1,3 +0,0 @@ -chef-shell allows the current position in a run-list to be manipulated -during a Chef Infra Client run. Add breakpoints to a recipe to take -advantage of this functionality. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_config.md b/www/layouts/shortcodes/ws_chef_shell_config.md deleted file mode 100644 index 50ce43e18..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_config.md +++ /dev/null @@ -1,14 +0,0 @@ -chef-shell determines which configuration file to load based on the -following: - -1. If a configuration file is specified using the `-c` option, - chef-shell will use the specified configuration file -2. If a NAMED_CONF is given, chef-shell will load - \~/.chef/NAMED_CONF/chef_shell.rb -3. If no NAMED_CONF is given chef-shell will load - \~/.chef/chef_shell.rb if it exists -4. If no chef_shell.rb can be found, chef-shell falls back to load: - - /etc/chef/client.rb if -z option is given. - - /etc/chef/solo.rb if --solo-legacy-mode option is given. - - .chef/config.rb if -s option is given. - - .chef/knife.rb if -s option is given. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_config_rb.md b/www/layouts/shortcodes/ws_chef_shell_config_rb.md deleted file mode 100644 index 4b422bcc3..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_config_rb.md +++ /dev/null @@ -1,16 +0,0 @@ -The chef-shell.rb file can be used to configure chef-shell in the same -way as the client.rb file is used to configure Chef Infra Client. For -example, to configure chef-shell to authenticate to the Chef Infra -Server, copy the `node_name`, `client_key`, and `chef_server_url` -settings from the config.rb file: - -``` ruby -node_name 'your-knife-clientname' -client_key File.expand_path('~/.chef/my-client.pem') -chef_server_url 'https://api.opscode.com/organizations/myorg' -``` - -and then add them to the chef-shell.rb file. Other configuration -possibilities include disabling Ohai plugins (which will speed up the -chef-shell boot process) or including arbitrary Ruby code in the -chef-shell.rb file. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_debug_existing_recipe.md b/www/layouts/shortcodes/ws_chef_shell_debug_existing_recipe.md deleted file mode 100644 index b1c01618d..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_debug_existing_recipe.md +++ /dev/null @@ -1,39 +0,0 @@ -chef-shell can be used to debug existing recipes. The recipe first needs -to be added to a run-list for the node, so that it is cached when -starting chef-shell and then used for debugging. chef-shell will report -which recipes are being cached when it is started: - -``` bash -loading configuration: none (standalone session) -Session type: standalone -Loading.............done. - -Welcome to the chef-shell 15.10.12 -For usage see https://docs.chef.io/chef_shell.html - -run `help' for help, `exit' or ^D to quit. - -chef (15.10.12 )> -``` - -To just load one recipe from the run-list, go into the recipe and use -the `include_recipe` command. For example: - -``` bash -chef > recipe_mode - chef:recipe > include_recipe "getting-started" - => [#< Chef::Recipe:0x10256f9e8 @cookbook_name="getting-started", - ... output truncated ... -``` - -To load all of the recipes from a run-list, use code similar to the -following: - -``` ruby -node.run_list.expand(node.chef_environment).recipes.each do |r| - include_recipe r -end -``` - -After the recipes that are to be debugged have been loaded, use the -`run_chef` command to run them. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_example_get_specific_nodes.md b/www/layouts/shortcodes/ws_chef_shell_example_get_specific_nodes.md deleted file mode 100644 index 701b33489..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_example_get_specific_nodes.md +++ /dev/null @@ -1,23 +0,0 @@ -To get a list of nodes using a recipe named `postfix` use -`search(:node,"recipe:postfix")`. To get a list of nodes using a -sub-recipe named `delivery`, use chef-shell. For example: - -``` ruby -search(:node, 'recipes:postfix\:\:delivery') -``` - -
- -

Note

- -
- -Single (' ') vs. double (" ") is important. This is because a backslash -() needs to be included in the string, instead of having Ruby interpret -it as an escape. - - - -
- -
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_example_hello_world.md b/www/layouts/shortcodes/ws_chef_shell_example_hello_world.md deleted file mode 100644 index 39e4bb11d..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_example_hello_world.md +++ /dev/null @@ -1,122 +0,0 @@ -This example shows how to run chef-shell in standalone mode. (For -chef-solo or Chef Infra Client modes, you would need to run chef-shell -using the `-s` or `-z` command line options, and then take into -consideration the necessary configuration settings.) - -When Chef Infra Client is installed using RubyGems or a package manager, -chef-shell should already be installed. When Chef Infra Client is run -from a git clone, it will be located in `chef/bin/chef shell`. To start -chef-shell, just run it without any options. You'll see the loading -message, then the banner, and then the chef-shell prompt: - -``` bash -bin/chef-shell - - loading configuration: none (standalone session) - Session type: standalone - Loading.............done. - - Welcome to the chef-shell 15.10.12 - For usage see https://docs.chef.io/chef_shell.html - - run `help' for help, `exit' or ^D to quit. - - chef (15.10.12 )> -``` - -(Use the help command to print a list of supported commands.) Use the -recipe_mode command to switch to recipe context: - -``` bash -chef > recipe_mode - chef:recipe_mode > -``` - -Typing is evaluated in the same context as recipes. Create a file -resource: - -``` bash -chef:recipe_mode > file "/tmp/ohai2u_shef" - => #< Chef::Resource::File:0x1b691ac - @enclosing_provider=nil, - @resource_name=:file, - @before=nil, - @supports={}, - @backup=5, - @allowed_actions=[:nothing, :create, :delete, :touch, :create_if_missing], - @only_if=nil, - @noop=nil, - @collection=#< Chef::ResourceCollection:0x1b9926c - @insert_after_idx=nil, - @resources_by_name={"file[/tmp/ohai2u_shef]"=>0}, - @resources=[#< Chef::Resource::File:0x1b691ac ...>]>, - @updated=false, - @provider=nil, - @node=< Chef::Node:0xdeeaae - @name="eigenstate.local">, - @recipe_name=nil, - @not_if=nil, - @name="/tmp/ohai2u_shef", - @action="create", - @path="/tmp/ohai2u_shef", - @source_line="/Users/username/ruby/chef/chef/(irb#1) line 1", - @params={}, - @actions={}, - @cookbook_name=nil, - @ignore_failure=false> -``` - -(The previous example was formatted for presentation.) At this point, -chef-shell has created the resource and put it in the run-list, but not -yet created the file. To initiate a Chef Infra Client run, use the -`run_chef` command: - -``` bash -chef:recipe_mode > run_chef - [Fri, 15 Jan 2020 10:42:47 -0800] DEBUG: Processing file[/tmp/ohai2u_shef] - [Fri, 15 Jan 2020 10:42:47 -0800] DEBUG: file[/tmp/ohai2u_shef] using Chef::Provider::File - [Fri, 15 Jan 2020 10:42:47 -0800] INFO: Creating file[/tmp/ohai2u_shef] at /tmp/ohai2u_shef - => true -``` - -chef-shell can also switch to the same context as attribute files. Set -an attribute with the following syntax: - -``` bash -chef:recipe_mode > attributes_mode - chef:attributes > set[:hello] = "ohai2u-again" - => "ohai2u-again" - chef:attributes > -``` - -Switch back to recipe_mode context and use the attributes: - -``` bash -chef:attributes > recipe_mode - => :attributes - chef:recipe_mode > file "/tmp/#{node.hello}" -``` - -Now, run Chef Infra Client again: - -``` bash -chef:recipe_mode > run_chef - [Fri, 15 Jan 2020 10:53:22 -0800] DEBUG: Processing file[/tmp/ohai2u_shef] - [Fri, 15 Jan 2020 10:53:22 -0800] DEBUG: file[/tmp/ohai2u_shef] using Chef::Provider::File - [Fri, 15 Jan 2020 10:53:22 -0800] DEBUG: Processing file[/tmp/ohai2u-again] - [Fri, 15 Jan 2020 10:53:22 -0800] DEBUG: file[/tmp/ohai2u-again] using Chef::Provider::File - [Fri, 15 Jan 2020 10:53:22 -0800] INFO: Creating file[/tmp/ohai2u-again] at /tmp/ohai2u-again - => true - chef:recipe_mode > -``` - -Because the first resource (`file[/tmp/ohai2u_shef]`) is still in the -run-list, it gets executed again. And because that file already exists, -Chef Infra Client doesn't attempt to re-create it. Finally, the files -were created using the `ls` method: - -``` bash -chef:recipe_mode > ls("/tmp").grep(/ohai/) - => ["ohai2u-again", "ohai2u_shef"] - Shell Tutorial -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_manage.md b/www/layouts/shortcodes/ws_chef_shell_manage.md deleted file mode 100644 index 2515cd4ad..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_manage.md +++ /dev/null @@ -1,132 +0,0 @@ -When chef-shell is configured to access a Chef Infra Server, chef-shell -can list, show, search for and edit cookbooks, clients, nodes, roles, -environments, policyfiles, and data bags. - -The syntax for managing objects on the Chef Infra Server is as follows: - -``` bash -chef-shell -z named_configuration -``` - -Where: - -- `named_configuration` is an existing configuration file in - `~/.chef/named_configuration/chef_shell.rb`, such as `production`, - `staging`, or `test`. - -Once in chef-shell, commands can be run against objects as follows: - -``` bash -chef (preprod) > items.command -``` - -Where: - -- `items` is the type of item to search for: `cookbooks`, `clients`, - `nodes`, `roles`, `environments` or a data bag. -- `command` is the command: `list`, `show`, `find`, or `edit`. - -For example, to list all of the nodes in a configuration named -"preprod", enter: - -``` bash -chef (preprod) > nodes.list -``` - -Which will return something similar to: - -``` bash -=> [node[i-f09a939b], node[i-049a936f], node[i-eaaaa581], node[i-9154b1fb], - node[i-6a213101], node[i-c2687aa9], node[i-7abeaa11], node[i-4eb8ac25], - node[i-9a2030f1], node[i-a06875cb], node[i-145f457f], node[i-e032398b], - node[i-dc8c98b7], node[i-6afdf401], node[i-f49b119c], node[i-5abfab31], - node[i-78b8ac13], node[i-d99678b3], node[i-02322269], node[i-feb4a695], - node[i-9e2232f5], node[i-6e213105], node[i-cdde3ba7], node[i-e8bfb083], - node[i-743c2c1f], node[i-2eaca345], node[i-aa7f74c1], node[i-72fdf419], - node[i-140e1e7f], node[i-f9d43193], node[i-bd2dc8d7], node[i-8e7f70e5], - node[i-78f2e213], node[i-962232fd], node[i-4c322227], node[i-922232f9], - node[i-c02728ab], node[i-f06c7b9b]] -``` - -The `list` command can take a code block, which will applied (but not -saved), to each object that is returned from the server. For example: - -``` bash -chef (preprod) > nodes.list {|n| puts "#{n.name}: #{n.run_list}" } -``` - -will return something similar to: - -``` bash -=> i-f09a939b: role[lb], role[preprod], recipe[aws] - i-049a936f: role[lb], role[preprod], recipe[aws] - i-9154b1fb: recipe[erlang], role[base], role[couchdb], role[preprod], - i-6a213101: role[chef], role[preprod] - # more... -``` - -The `show` command can be used to display a specific node. For example: - -``` bash -chef (preprod) > load_balancer = nodes.show('i-f09a939b') -``` - -will return something similar to: - -``` bash -=> node[i-f09a939b] -``` - -Or: - -``` bash -chef (preprod) > load_balancer.ec2.public_hostname -``` - -will return something similar to: - -``` bash -=> "ec2-111-22-333-44.compute-1.amazonaws.com" -``` - -The `find` command can be used to search the Chef Infra Server from the -chef-shell. For example: - -``` bash -chef (preprod) > pp nodes.find(:ec2_public_hostname => 'ec2*') -``` - -You can also format the results with a code block. For example: - -``` bash -chef (preprod) > pp nodes.find(:ec2_public_hostname => 'ec2*') {|n| n.ec2.ami_id } and nil -``` - -will return something similar to: - -``` bash -=> ["ami-f8927a91", - "ami-f8927a91", - "ami-a89870c1", - "ami-a89870c1", - "ami-a89870c1", - "ami-a89870c1", - "ami-a89870c1" - # and more... -``` - -Or: - -``` bash -chef (preprod) > amis = nodes.find(:ec2_public_hostname => 'ec2*') {|n| n.ec2.ami_id } -chef (preprod) > puts amis.uniq.sort -``` - -will return something similar to: - -``` bash -=> ami-4b4ba522 - ami-a89870c1 - ami-eef61587 - ami-f8927a91 -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_modes.md b/www/layouts/shortcodes/ws_chef_shell_modes.md deleted file mode 100644 index 39352e042..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_modes.md +++ /dev/null @@ -1,30 +0,0 @@ -chef-shell is tool that is run using an Interactive Ruby (IRb) session. -chef-shell currently supports recipe and attribute file syntax, as well -as interactive debugging features. chef-shell has three run modes: - - ---- - - - - - - - - - - - - - - - - - - - - -
ModeDescription
StandaloneDefault. No cookbooks are loaded, and the run-list is empty.
Solochef-shell acts as a Chef Solo Client. It attempts to load the chef-solo configuration file at ~/.chef/config.rb and any JSON attributes passed. If the JSON attributes set a run-list, it will be honored. Cookbooks will be loaded in the same way that chef-solo loads them. chef-solo mode is activated with the -s or --solo command line option, and JSON attributes are specified in the same way as for chef-solo, with -j /path/to/chef-solo.json.
Clientchef-shell acts as a Chef Infra Client. During startup, it reads the Chef Infra Client configuration file from ~/.chef/client.rb and contacts the Chef Infra Server to get the node's run_list, attributes, and cookbooks. Chef Infra Client mode is activated with the -z or --client options. You can also specify the configuration file with -c CONFIG and the server URL with -S SERVER_URL.
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_run_as_chef_client.md b/www/layouts/shortcodes/ws_chef_shell_run_as_chef_client.md deleted file mode 100644 index 185fe622c..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_run_as_chef_client.md +++ /dev/null @@ -1,14 +0,0 @@ -By default, chef-shell loads in standalone mode and does not connect to -the Chef Infra Server. The chef-shell can be run as a Chef Infra Client -to verify functionality that is only available when Chef Infra Client -connects to the Chef Infra Server, such as search functionality or -accessing data stored in data bags. - -chef-shell can use the same credentials as knife when connecting to a -Chef Infra Server. Make sure that the settings in chef-shell.rb are the -same as those in config.rb, and then use the `-z` option as part of the -command. For example: - -``` bash -chef-shell -z -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_step_through_run_list.md b/www/layouts/shortcodes/ws_chef_shell_step_through_run_list.md deleted file mode 100644 index 494792914..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_step_through_run_list.md +++ /dev/null @@ -1,89 +0,0 @@ -To explore how using the **breakpoint** to manually step through a Chef -Infra Client run, create a simple recipe in chef-shell: - -``` bash -chef > recipe_mode - chef:recipe > echo off - chef:recipe > file "/tmp/before-breakpoint" - chef:recipe > breakpoint "foo" - chef:recipe > file "/tmp/after-breakpoint" -``` - -and then run Chef Infra Client: - -``` bash -chef:recipe > run_chef - [Fri, 15 Jan 2020 14:17:49 -0800] DEBUG: Processing file[/tmp/before-breakpoint] - [Fri, 15 Jan 2020 14:17:49 -0800] DEBUG: file[/tmp/before-breakpoint] using Chef::Provider::File - [Fri, 15 Jan 2020 14:17:49 -0800] INFO: Creating file[/tmp/before-breakpoint] at /tmp/before-breakpoint - [Fri, 15 Jan 2020 14:17:49 -0800] DEBUG: Processing [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] - [Fri, 15 Jan 2020 14:17:49 -0800] DEBUG: [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] using Chef::Provider::Breakpoint -``` - -Chef Infra Client ran the first resource before the breakpoint -(`file[/tmp/before-breakpoint]`), but then stopped after execution. Chef -Infra Client attempted to name the breakpoint after its position in the -source file, but Chef Infra Client was confused because the resource was -entered interactively. From here, chef-shell can resume the interrupted -Chef Infra Client run: - -``` bash -chef:recipe > chef_run.resume - [Fri, 15 Jan 2020 14:27:08 -0800] INFO: Creating file[/tmp/after-breakpoint] at /tmp/after-breakpoint -``` - -A quick view of the `/tmp` directory shows that the following files were -created: - -``` bash -after-breakpoint -before-breakpoint -``` - -You can rewind and step through a Chef Infra Client run: - -``` bash -chef:recipe > Chef::Log.level = :debug # debug logging won't turn on automatically in this case - => :debug - chef:recipe > chef_run.rewind - => 0 - chef:recipe > chef_run.step - [Fri, 15 Jan 2020 14:40:52 -0800] DEBUG: Processing file[/tmp/before-breakpoint] - [Fri, 15 Jan 2020 14:40:52 -0800] DEBUG: file[/tmp/before-breakpoint] using Chef::Provider::File - => 1 - chef:recipe > chef_run.step - [Fri, 15 Jan 2020 14:40:54 -0800] DEBUG: Processing [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] - [Fri, 15 Jan 2020 14:40:54 -0800] DEBUG: [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] using Chef::Provider::Breakpoint - => 2 - chef:recipe > chef_run.step - [Fri, 15 Jan 2020 14:40:56 -0800] DEBUG: Processing file[/tmp/after-breakpoint] - [Fri, 15 Jan 2020 14:40:56 -0800] DEBUG: file[/tmp/after-breakpoint] using Chef::Provider::File - => 3 -``` - -From the output, the rewound run-list is shown, but when the resources -are executed again, they will repeat their checks for the existence of -files. If they exist, Chef Infra Client will skip creating them. If the -files are deleted, then: - -``` bash -chef:recipe > ls("/tmp").grep(/breakpoint/).each {|f| rm "/tmp/#{f}" } - => ["after-breakpoint", "before-breakpoint"] -``` - -Rewind, and then resume your Chef Infra Client run to get the expected -results: - -``` bash -chef:recipe > chef_run.rewind - chef:recipe > chef_run.resume - [Fri, 15 Jan 2020 14:48:56 -0800] DEBUG: Processing file[/tmp/before-breakpoint] - [Fri, 15 Jan 2020 14:48:56 -0800] DEBUG: file[/tmp/before-breakpoint] using Chef::Provider::File - [Fri, 15 Jan 2020 14:48:56 -0800] INFO: Creating file[/tmp/before-breakpoint] at /tmp/before-breakpoint - [Fri, 15 Jan 2020 14:48:56 -0800] DEBUG: Processing [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] - [Fri, 15 Jan 2020 14:48:56 -0800] DEBUG: [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] using Chef::Provider::Breakpoint - chef:recipe > chef_run.resume - [Fri, 15 Jan 2020 14:49:20 -0800] DEBUG: Processing file[/tmp/after-breakpoint] - [Fri, 15 Jan 2020 14:49:20 -0800] DEBUG: file[/tmp/after-breakpoint] using Chef::Provider::File - [Fri, 15 Jan 2020 14:49:20 -0800] INFO: Creating file[/tmp/after-breakpoint] at /tmp/after-breakpoint -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_shell_summary.md b/www/layouts/shortcodes/ws_chef_shell_summary.md deleted file mode 100644 index a1778a3d5..000000000 --- a/www/layouts/shortcodes/ws_chef_shell_summary.md +++ /dev/null @@ -1,4 +0,0 @@ -chef-shell is a recipe debugging tool that allows the use of breakpoints -within recipes. chef-shell runs as an Interactive Ruby (IRb) session. -chef-shell supports both recipe and attribute file syntax, as well as -interactive debugging features. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_tags.md b/www/layouts/shortcodes/ws_chef_tags.md deleted file mode 100644 index 47e5b2541..000000000 --- a/www/layouts/shortcodes/ws_chef_tags.md +++ /dev/null @@ -1,4 +0,0 @@ -A tag is a custom description that is applied to a node. A tag, once -applied, can be helpful when managing nodes using knife or when building -recipes by providing alternate methods of grouping similar types of -information. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chef_workstation.md b/www/layouts/shortcodes/ws_chef_workstation.md deleted file mode 100644 index c9af5c38f..000000000 --- a/www/layouts/shortcodes/ws_chef_workstation.md +++ /dev/null @@ -1,9 +0,0 @@ -Chef Workstation contains everything that is needed to start using Chef -Infra and Chef InSpec: - -- Chef Infra Client -- Chef InSpec -- chef and knife command line tools -- Testing tools such as Test Kitchen, ChefSpec, and Cookstyle -- Everything else needed to author cookbooks and upload them to the - Chef Infra Server \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_chefspec_summary.md b/www/layouts/shortcodes/ws_chefspec_summary.md deleted file mode 100644 index 7182dda25..000000000 --- a/www/layouts/shortcodes/ws_chefspec_summary.md +++ /dev/null @@ -1,5 +0,0 @@ -Use ChefSpec to simulate the convergence of resources on a node: - -- Is an extension of RSpec, a behavior-driven development (BDD) - framework for Ruby -- Is the fastest way to test resources and recipes \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_config_rb_client_dot_d_directories.md b/www/layouts/shortcodes/ws_config_rb_client_dot_d_directories.md deleted file mode 100644 index eb1392ce5..000000000 --- a/www/layouts/shortcodes/ws_config_rb_client_dot_d_directories.md +++ /dev/null @@ -1,41 +0,0 @@ -Chef Infra Client supports reading multiple configuration files by -putting them inside a `.d` configuration directory. For example: -`/etc/chef/client.d`. All files that end in `.rb` in the `.d` directory -are loaded; other non-`.rb` files are ignored. - -`.d` directories may exist in any location where the `client.rb`, -`config.rb`, or `solo.rb` files are present, such as: - -- `/etc/chef/client.d` -- `/etc/chef/config.d` -- `~/chef/solo.d` - -(There is no support for a `knife.d` directory; use `config.d` instead.) - -For example, when using knife, the following configuration files would -be loaded: - -- `~/.chef/config.rb` -- `~/.chef/config.d/company_settings.rb` -- `~/.chef/config.d/ec2_configuration.rb` -- `~/.chef/config.d/old_settings.rb.bak` - -The `old_settings.rb.bak` file is ignored because it's not a -configuration file. The `config.rb`, `company_settings.rb`, and -`ec2_configuration` files are merged together as if they are a single -configuration file. - -
- -

Note

- -
- -If multiple configuration files exists in a `.d` directory, ensure that -the same setting has the same value in all files. - - - -
- -
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_cookbooks_summary.md b/www/layouts/shortcodes/ws_cookbooks_summary.md deleted file mode 100644 index e0bb86447..000000000 --- a/www/layouts/shortcodes/ws_cookbooks_summary.md +++ /dev/null @@ -1,10 +0,0 @@ -A cookbook is the fundamental unit of configuration and policy -distribution. A cookbook defines a scenario and contains everything that -is required to support that scenario: - -- Recipes that specify the resources to use and the order in which - they are to be applied -- Attribute values -- File distributions -- Templates -- Extensions to Chef, such as custom resources and libraries \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_ctl_kitchen_common_option_platforms.md b/www/layouts/shortcodes/ws_ctl_kitchen_common_option_platforms.md deleted file mode 100644 index 13260abd5..000000000 --- a/www/layouts/shortcodes/ws_ctl_kitchen_common_option_platforms.md +++ /dev/null @@ -1,15 +0,0 @@ -For example, if a kitchen.yml file contains the following: - -``` javascript -- name: centos-7 -- name: centos-8 -- name: fedora-latest -- name: ubuntu-1604 -- name: ubuntu-1804 -``` - -then a regular expression like `(04|7)` would run Test Kitchen against -`centos-7`, `ubuntu-1604`, and `ubuntu-1804`. A regular expression like -`(ubuntu)` would run Test Kitchen against `ubuntu-1604` and -`ubuntu-1804`. A regular expression like `(fedora)` would run Test -Kitchen against only `fedora-latest`. Default: `all`. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_ctl_kitchen_summary.md b/www/layouts/shortcodes/ws_ctl_kitchen_summary.md deleted file mode 100644 index a17a256ab..000000000 --- a/www/layouts/shortcodes/ws_ctl_kitchen_summary.md +++ /dev/null @@ -1,23 +0,0 @@ -kitchen is the command-line tool for Test Kitchen, an integration -testing tool maintained by Chef Software. Test Kitchen runs tests -against any combination of platforms using any combination of test -suites. Each test, however, is done against a specific instance, which -is comprised of a single platform and a single set of testing criteria. -This allows each test to be run in isolation, ensuring that different -behaviors within the same codebase can be tested thoroughly before those -changes are committed to production. - -
- -

Note

- -
- -Any Test Kitchen subcommand that does not specify an instance will be -applied to all instances. - - - -
- -
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_ctl_push_jobs_client_summary.md b/www/layouts/shortcodes/ws_ctl_push_jobs_client_summary.md deleted file mode 100644 index 6cbff8b22..000000000 --- a/www/layouts/shortcodes/ws_ctl_push_jobs_client_summary.md +++ /dev/null @@ -1 +0,0 @@ -The Chef Push Jobs executable can be run as a command-line tool. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_data_bag.md b/www/layouts/shortcodes/ws_data_bag.md deleted file mode 100644 index 7cc365263..000000000 --- a/www/layouts/shortcodes/ws_data_bag.md +++ /dev/null @@ -1,2 +0,0 @@ -Data bags store global variables as JSON data. Data bags are indexed for -searching and can be loaded by a cookbook or accessed during a search. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_data_bag_encryption.md b/www/layouts/shortcodes/ws_data_bag_encryption.md deleted file mode 100644 index e7720a78b..000000000 --- a/www/layouts/shortcodes/ws_data_bag_encryption.md +++ /dev/null @@ -1,24 +0,0 @@ -A data bag item may be encrypted using [shared secret -encryption](https://en.wikipedia.org/wiki/Symmetric-key_algorithm). This -allows each data bag item to store confidential information (such as a -database password) or to be managed in a source control system (without -plain-text data appearing in revision history). Each data bag item may -be encrypted individually; if a data bag contains multiple encrypted -data bag items, these data bag items are not required to share the same -encryption keys. - -
- -

Note

- -
- -Because the contents of encrypted data bag items are not visible to the -Chef Infra Server, search queries against data bags with encrypted items -will not return any results. - - - -
- -
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_environment.md b/www/layouts/shortcodes/ws_environment.md deleted file mode 100644 index c6b6fdc6c..000000000 --- a/www/layouts/shortcodes/ws_environment.md +++ /dev/null @@ -1,10 +0,0 @@ -An environment is a way to map an organization's real-life workflow to -what can be configured and managed when using Chef Infra. This mapping -is accomplished by setting attributes and pinning cookbooks at the -environment level. With environments, you can change cookbook -configurations depending on the system's designation. For example, by -designating different staging and production environments, you can then -define the correct URL of a database server for each environment. -Environments also allow organizations to move new cookbook releases from -staging to production with confidence by stepping releases through -testing environments before entering production. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_fips_intro_client.md b/www/layouts/shortcodes/ws_fips_intro_client.md deleted file mode 100644 index 980280aec..000000000 --- a/www/layouts/shortcodes/ws_fips_intro_client.md +++ /dev/null @@ -1,32 +0,0 @@ -Federal Information Processing Standards (FIPS) is a United States -government computer security standard that specifies security -requirements for cryptography. The current version of the standard is -FIPS 140-2. Chef Infra Client can be configured to allow OpenSSL to -enforce FIPS-validated security during a Chef Infra Client run. This -will disable cryptography that is explicitly disallowed in -FIPS-validated software, including certain ciphers and hashing -algorithms. Any attempt to use any disallowed cryptography will cause -Chef Infra Client to throw an exception during a Chef Infra Client run. - -
- -

Note

- -
- -Chef uses MD5 hashes to uniquely identify files that are stored on the -Chef Infra Server. MD5 is used only to generate a unique hash identifier -and is not used for any cryptographic purpose. - - - -
- -
- -Notes about FIPS: - -- May be enabled for nodes running on Microsoft Windows and Enterprise - Linux platforms -- Should only be enabled for environments that require FIPS 140-2 - compliance \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_azure.md b/www/layouts/shortcodes/ws_knife_azure.md deleted file mode 100644 index aea17b9ef..000000000 --- a/www/layouts/shortcodes/ws_knife_azure.md +++ /dev/null @@ -1,4 +0,0 @@ -Microsoft Azure is a cloud hosting platform from Microsoft that provides -virtual machines for Linux and Windows Server, cloud and database -services, and more. Use the `knife azure` subcommand to manage -API-driven cloud servers hosted by Microsoft Azure. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_bootstrap_no_validator.md b/www/layouts/shortcodes/ws_knife_bootstrap_no_validator.md deleted file mode 100644 index e38fc898b..000000000 --- a/www/layouts/shortcodes/ws_knife_bootstrap_no_validator.md +++ /dev/null @@ -1,42 +0,0 @@ -The ORGANIZATION-validator.pem is typically added to the .chef directory -on the workstation. When a node is bootstrapped from that workstation, -the ORGANIZATION-validator.pem is used to authenticate the newly-created -node to the Chef Infra Server during the initial Chef Infra Client run. -It is possible to bootstrap a node using the USER.pem file instead of -the ORGANIZATION-validator.pem file. This is known as a "validatorless -bootstrap". - -To create a node via the USER.pem file, simply delete the -ORGANIZATION-validator.pem file on the workstation. For example: - -``` bash -rm -f /home/lamont/.chef/myorg-validator.pem -``` - -and then make the following changes in the config.rb file: - -- Remove the `validation_client_name` setting -- Edit the `validation_key` setting to be something that isn't a path - to an existent ORGANIZATION-validator.pem file. For example: - `/nonexist`. - -As long as a USER.pem is also present on the workstation from which the -validatorless bootstrap operation will be initiated, the bootstrap -operation will run and will use the USER.pem file instead of the -ORGANIZATION-validator.pem file. - -When running a validatorless `knife bootstrap` operation, the output is -similar to: - -``` bash -desktop% knife bootstrap 10.1.1.1 -N foo01.acme.org \ - -E dev -r 'role[base]' -j '{ "foo": "bar" }' \ - --ssh-user vagrant --sudo -Node foo01.acme.org exists, overwrite it? (Y/N) -Client foo01.acme.org exists, overwrite it? (Y/N) -Creating new client for foo01.acme.org -Creating new node for foo01.acme.org -Connecting to 10.1.1.1 -10.1.1.1 Starting first Chef Client run... -[....etc...] -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_bootstrap_node_fips.md b/www/layouts/shortcodes/ws_knife_bootstrap_node_fips.md deleted file mode 100644 index 477b8f2ac..000000000 --- a/www/layouts/shortcodes/ws_knife_bootstrap_node_fips.md +++ /dev/null @@ -1,11 +0,0 @@ -``` bash -knife bootstrap 192.0.2.0 -P vanilla -x root -r 'recipe[apt],recipe[xfs],recipe[vim]' --fips -``` - -which shows something similar to: - -``` none -OpenSSL FIPS 140 mode enabled -... -192.0.2.0 Chef Infra Client finished, 12/12 resources updated in 78.942455583 seconds -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_bootstrap_summary.md b/www/layouts/shortcodes/ws_knife_bootstrap_summary.md deleted file mode 100644 index 37333b3f0..000000000 --- a/www/layouts/shortcodes/ws_knife_bootstrap_summary.md +++ /dev/null @@ -1,3 +0,0 @@ -Use the `knife bootstrap` subcommand to run a bootstrap operation that -installs Chef Infra Client on the target system. The bootstrap operation -must specify the IP address or FQDN of the target system. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_client_summary.md b/www/layouts/shortcodes/ws_knife_client_summary.md deleted file mode 100644 index 073a4ae99..000000000 --- a/www/layouts/shortcodes/ws_knife_client_summary.md +++ /dev/null @@ -1,4 +0,0 @@ -Use the `knife client` subcommand to manage an API client list and their -associated RSA public key-pairs. This allows authentication requests to -be made to the Chef Infra Server by any entity that uses the Chef Infra -Server API, such as Chef Infra Client and knife. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_common_see_all_config_options.md b/www/layouts/shortcodes/ws_knife_common_see_all_config_options.md deleted file mode 100644 index cf4fe1e8f..000000000 --- a/www/layouts/shortcodes/ws_knife_common_see_all_config_options.md +++ /dev/null @@ -1,3 +0,0 @@ -See [config.rb](/workstation/config_rb_optional_settings/) for more information -about how to add certain knife options as settings in the config.rb -file. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_common_see_common_options_link.md b/www/layouts/shortcodes/ws_knife_common_see_common_options_link.md deleted file mode 100644 index c7392476e..000000000 --- a/www/layouts/shortcodes/ws_knife_common_see_common_options_link.md +++ /dev/null @@ -1,2 +0,0 @@ -Review the list of [common options](/workstation/knife_options/) available to -this (and all) knife subcommands and plugins. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_common_windows_quotes.md b/www/layouts/shortcodes/ws_knife_common_windows_quotes.md deleted file mode 100644 index 0de3e97d5..000000000 --- a/www/layouts/shortcodes/ws_knife_common_windows_quotes.md +++ /dev/null @@ -1,18 +0,0 @@ -When running knife in Microsoft Windows, a string may be interpreted as -a wildcard pattern when quotes are not present in the command. The -number of quotes to use depends on the shell from which the command is -being run. - -When running knife from the command prompt, a string should be -surrounded by single quotes (`' '`). For example: - -``` bash -knife node run_list set test-node 'recipe[iptables]' -``` - -When running knife from Windows PowerShell, a string should be -surrounded by triple single quotes (`''' '''`). For example: - -``` bash -knife node run_list set test-node '''recipe[iptables]''' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_common_windows_quotes_module.md b/www/layouts/shortcodes/ws_knife_common_windows_quotes_module.md deleted file mode 100644 index beb3f56b3..000000000 --- a/www/layouts/shortcodes/ws_knife_common_windows_quotes_module.md +++ /dev/null @@ -1,53 +0,0 @@ -The Chef Client 12.4 release adds an optional feature to the Microsoft -Installer Package (MSI) for Chef. This feature enables the ability to -pass quoted strings from the Windows PowerShell command line without the -need for triple single quotes (`''' '''`). This feature installs a -Windows PowerShell module (typically in `C:\opscode\chef\modules`) that -is also appended to the `PSModulePath` environment variable. This -feature is not enabled by default. To activate this feature, run the -following command from within Windows PowerShell: - -``` bash -Import-Module chef -``` - -or add `Import-Module chef` to the profile for Windows PowerShell -located at: - -``` bash -~\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 -``` - -This module exports cmdlets that have the same name as the command-line -tools---chef-client, knife, chef-apply---that are built into Chef. - -For example: - -``` bash -knife exec -E 'puts ARGV' """&s0meth1ng""" -``` - -is now: - -``` bash -knife exec -E 'puts ARGV' '&s0meth1ng' -``` - -and: - -``` bash -knife node run_list set test-node '''role[ssssssomething]''' -``` - -is now: - -``` bash -knife node run_list set test-node 'role[ssssssomething]' -``` - -To remove this feature, run the following command from within Windows -PowerShell: - -``` bash -Remove-Module chef -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_configure_summary.md b/www/layouts/shortcodes/ws_knife_configure_summary.md deleted file mode 100644 index 1c905af35..000000000 --- a/www/layouts/shortcodes/ws_knife_configure_summary.md +++ /dev/null @@ -1,3 +0,0 @@ -Use the `knife configure` subcommand to create the -[client.rb](/config_rb_client/) and [config.rb](/workstation/config_rb/) files -so that they can be distributed to workstations and nodes. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_cookbook_summary.md b/www/layouts/shortcodes/ws_knife_cookbook_summary.md deleted file mode 100644 index 80c447375..000000000 --- a/www/layouts/shortcodes/ws_knife_cookbook_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife cookbook` subcommand to interact with cookbooks that are -located on the Chef Infra Server or the local chef-repo. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_data_bag_edit.md b/www/layouts/shortcodes/ws_knife_data_bag_edit.md deleted file mode 100644 index 3af67a010..000000000 --- a/www/layouts/shortcodes/ws_knife_data_bag_edit.md +++ /dev/null @@ -1,4 +0,0 @@ -Use the `edit` argument to edit the data contained in a data bag. If -encryption is being used, the data bag will be decrypted, the data will -be made available in the \$EDITOR, and then encrypted again before -saving it to the Chef Infra Server. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_data_bag_edit_item.md b/www/layouts/shortcodes/ws_knife_data_bag_edit_item.md deleted file mode 100644 index 05afc3223..000000000 --- a/www/layouts/shortcodes/ws_knife_data_bag_edit_item.md +++ /dev/null @@ -1,27 +0,0 @@ -To edit an item named "charlie" that is contained in a data bag named -"admins", enter: - -``` bash -knife data bag edit admins charlie -``` - -to open the \$EDITOR. Once opened, you can update the data before saving -it to the Chef Infra Server. For example, by changing: - -``` javascript -{ - "id": "charlie" -} -``` - -to: - -``` javascript -{ - "id": "charlie", - "uid": 1005, - "gid": "ops", - "shell": "/bin/zsh", - "comment": "Crazy Charlie" -} -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_data_bag_from_file_create_encrypted_local_mode.md b/www/layouts/shortcodes/ws_knife_data_bag_from_file_create_encrypted_local_mode.md deleted file mode 100644 index cbdeba352..000000000 --- a/www/layouts/shortcodes/ws_knife_data_bag_from_file_create_encrypted_local_mode.md +++ /dev/null @@ -1,11 +0,0 @@ -To generate an encrypted data bag item in a JSON file for use when Chef -Infra Client is run in local mode (via the `--local-mode` option), -enter: - -``` bash -knife data bag from file my_data_bag /path/to/data_bag_item.json -z --secret-file /path/to/encrypted_data_bag_secret -``` - -this will create an encrypted JSON file in: - - data_bags/my_data_bag/data_bag_item.json \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_data_bag_summary.md b/www/layouts/shortcodes/ws_knife_data_bag_summary.md deleted file mode 100644 index c05b74507..000000000 --- a/www/layouts/shortcodes/ws_knife_data_bag_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife data bag` subcommand to manage arbitrary stores of -globally available JSON data. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_delete_summary.md b/www/layouts/shortcodes/ws_knife_delete_summary.md deleted file mode 100644 index 7b9aa4e2b..000000000 --- a/www/layouts/shortcodes/ws_knife_delete_summary.md +++ /dev/null @@ -1,5 +0,0 @@ -Use the `knife delete` subcommand to delete an object from a Chef Infra -Server. This subcommand works similar to `knife cookbook delete`, -`knife data bag delete`, `knife environment delete`, -`knife node delete`, and `knife role delete`, but with a single verb -(and a single action). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_deps_summary.md b/www/layouts/shortcodes/ws_knife_deps_summary.md deleted file mode 100644 index 3fde702d7..000000000 --- a/www/layouts/shortcodes/ws_knife_deps_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife deps` subcommand to identify dependencies for a node, -role, or cookbook. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_diff_summary.md b/www/layouts/shortcodes/ws_knife_diff_summary.md deleted file mode 100644 index 1c6f8b4e6..000000000 --- a/www/layouts/shortcodes/ws_knife_diff_summary.md +++ /dev/null @@ -1,8 +0,0 @@ -Use the `knife diff` subcommand to compare the differences between files -and directories on the Chef Infra Server and in the chef-repo. For -example, to compare files on the Chef Infra Server prior to uploading or -downloading files using the `knife download` and `knife upload` -subcommands, or to ensure that certain files in multiple production -environments are the same. This subcommand is similar to the `git diff` -command that can be used to diff what is in the chef-repo with what is -synced to a git repository. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_download_summary.md b/www/layouts/shortcodes/ws_knife_download_summary.md deleted file mode 100644 index b0a0311b5..000000000 --- a/www/layouts/shortcodes/ws_knife_download_summary.md +++ /dev/null @@ -1,9 +0,0 @@ -Use the `knife download` subcommand to download roles, cookbooks, -environments, nodes, and data bags from the Chef Infra Server to the -current working directory. It can be used to back up data on the Chef -Infra Server, inspect the state of one or more files, or to extract -out-of-process changes users may have made to files on the Chef Infra -Server, such as if a user made a change that bypassed version source -control. This subcommand is often used in conjunction with `knife diff`, -which can be used to see exactly what changes will be downloaded, and -then `knife upload`, which does the opposite of `knife download`. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_edit_admin_users.md b/www/layouts/shortcodes/ws_knife_edit_admin_users.md deleted file mode 100644 index 44bf4d030..000000000 --- a/www/layouts/shortcodes/ws_knife_edit_admin_users.md +++ /dev/null @@ -1,9 +0,0 @@ -A user who belongs to the `admins` group must be removed from the group -before they may be removed from an organization. To remove a user from -the `admins` group, run the following: - -``` bash -EDITOR=vi knife edit /groups/admins.json -``` - -make the required changes, and then save the file. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_edit_summary.md b/www/layouts/shortcodes/ws_knife_edit_summary.md deleted file mode 100644 index 5d8b74def..000000000 --- a/www/layouts/shortcodes/ws_knife_edit_summary.md +++ /dev/null @@ -1,4 +0,0 @@ -Use the `knife edit` subcommand to edit objects on the Chef Infra -Server. This subcommand works similar to `knife cookbook edit`, -`knife data bag edit`, `knife environment edit`, `knife node edit`, and -`knife role edit`, but with a single verb (and a single action). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_environment_summary.md b/www/layouts/shortcodes/ws_knife_environment_summary.md deleted file mode 100644 index 418e12948..000000000 --- a/www/layouts/shortcodes/ws_knife_environment_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife environment` subcommand to manage environments within a -single organization on the Chef Infra Server. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_exec_summary.md b/www/layouts/shortcodes/ws_knife_exec_summary.md deleted file mode 100644 index 40f2d7ecd..000000000 --- a/www/layouts/shortcodes/ws_knife_exec_summary.md +++ /dev/null @@ -1,5 +0,0 @@ -Use the `knife exec` subcommand to execute Ruby scripts in the context -of a fully configured Chef Infra Client. Use this subcommand to run -scripts that will only access Chef Infra Server one time (or otherwise -very infrequently) or any time that an operation does not warrant full -usage of the knife subcommand library. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_list_summary.md b/www/layouts/shortcodes/ws_knife_list_summary.md deleted file mode 100644 index 3d00062b0..000000000 --- a/www/layouts/shortcodes/ws_knife_list_summary.md +++ /dev/null @@ -1,4 +0,0 @@ -Use the `knife list` subcommand to view a list of objects on the Chef -Infra Server. This subcommand works similar to `knife cookbook list`, -`knife data bag list`, `knife environment list`, `knife node list`, and -`knife role list`, but with a single verb (and a single action). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_add.md b/www/layouts/shortcodes/ws_knife_node_run_list_add.md deleted file mode 100644 index 0cf916a54..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_add.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `run_list add` argument to add run-list items (roles or recipes) -to a node. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_add_default_recipe.md b/www/layouts/shortcodes/ws_knife_node_run_list_add_default_recipe.md deleted file mode 100644 index db53e0512..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_add_default_recipe.md +++ /dev/null @@ -1,5 +0,0 @@ -To add the default recipe of a cookbook to a run-list, enter: - -``` bash -knife node run_list add NODE_NAME 'COOKBOOK' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_add_options.md b/www/layouts/shortcodes/ws_knife_node_run_list_add_options.md deleted file mode 100644 index 50210705b..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_add_options.md +++ /dev/null @@ -1,9 +0,0 @@ -This argument has the following options: - -`-a ITEM`, `--after ITEM` - -: Add a run-list item after the specified run-list item. - -`-b ITEM`, `--before ITEM` - -: Add a run-list item before the specified run-list item. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_add_recipe_with_cookbook.md b/www/layouts/shortcodes/ws_knife_node_run_list_add_recipe_with_cookbook.md deleted file mode 100644 index c267a2f6a..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_add_recipe_with_cookbook.md +++ /dev/null @@ -1,5 +0,0 @@ -To add a recipe to a run-list using the cookbook format, enter: - -``` bash -knife node run_list add NODE_NAME 'COOKBOOK::RECIPE_NAME' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_add_recipe_with_fqdn.md b/www/layouts/shortcodes/ws_knife_node_run_list_add_recipe_with_fqdn.md deleted file mode 100644 index 4b2604f84..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_add_recipe_with_fqdn.md +++ /dev/null @@ -1,5 +0,0 @@ -To add a recipe to a run-list using the fully qualified format, enter: - -``` bash -knife node run_list add NODE_NAME 'recipe[COOKBOOK::RECIPE_NAME]' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_add_role.md b/www/layouts/shortcodes/ws_knife_node_run_list_add_role.md deleted file mode 100644 index e5e9666fc..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_add_role.md +++ /dev/null @@ -1,5 +0,0 @@ -To add a role to a run-list, enter: - -``` bash -knife node run_list add NODE_NAME 'role[ROLE_NAME]' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_add_roles_and_recipes.md b/www/layouts/shortcodes/ws_knife_node_run_list_add_roles_and_recipes.md deleted file mode 100644 index 4b4823924..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_add_roles_and_recipes.md +++ /dev/null @@ -1,5 +0,0 @@ -To add roles and recipes to a run-list, enter: - -``` bash -knife node run_list add NODE_NAME 'recipe[COOKBOOK::RECIPE_NAME],recipe[COOKBOOK::RECIPE_NAME],role[ROLE_NAME]' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_add_syntax.md b/www/layouts/shortcodes/ws_knife_node_run_list_add_syntax.md deleted file mode 100644 index cebd31eec..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_add_syntax.md +++ /dev/null @@ -1,5 +0,0 @@ -This argument has the following syntax: - -``` bash -knife node run_list add NODE_NAME RUN_LIST_ITEM (options) -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_remove.md b/www/layouts/shortcodes/ws_knife_node_run_list_remove.md deleted file mode 100644 index 948bf56fc..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_remove.md +++ /dev/null @@ -1,7 +0,0 @@ -Use the `run_list remove` argument to remove run-list items (roles or -recipes) from a node. A recipe must be in one of the following formats: -fully qualified, cookbook, or default. Both roles and recipes must be in -quotes, for example: `'role[ROLE_NAME]'` or -`'recipe[COOKBOOK::RECIPE_NAME]'`. Use a comma to separate roles and -recipes when removing more than one, like this: -`'recipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]'`. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_remove_role.md b/www/layouts/shortcodes/ws_knife_node_run_list_remove_role.md deleted file mode 100644 index d51203e97..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_remove_role.md +++ /dev/null @@ -1,5 +0,0 @@ -To remove a role from a run-list, enter: - -``` bash -knife node run_list remove NODE_NAME 'role[ROLE_NAME]' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_remove_run_list.md b/www/layouts/shortcodes/ws_knife_node_run_list_remove_run_list.md deleted file mode 100644 index 9e501c688..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_remove_run_list.md +++ /dev/null @@ -1,6 +0,0 @@ -To remove a recipe from a run-list using the fully qualified format, -enter: - -``` bash -knife node run_list remove NODE_NAME 'recipe[COOKBOOK::RECIPE_NAME]' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_remove_syntax.md b/www/layouts/shortcodes/ws_knife_node_run_list_remove_syntax.md deleted file mode 100644 index b2c7d7700..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_remove_syntax.md +++ /dev/null @@ -1,5 +0,0 @@ -This argument has the following syntax: - -``` bash -knife node run_list remove NODE_NAME RUN_LIST_ITEM -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_set.md b/www/layouts/shortcodes/ws_knife_node_run_list_set.md deleted file mode 100644 index 1ee3baa2f..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_set.md +++ /dev/null @@ -1,6 +0,0 @@ -Use the `run_list set` argument to set the run-list for a node. A recipe -must be in one of the following formats: fully qualified, cookbook, or -default. Both roles and recipes must be in quotes, for example: -`'role[ROLE_NAME]'` or `'recipe[COOKBOOK::RECIPE_NAME]'`. Use a comma to -separate roles and recipes when setting more than one, like this: -`'recipe[COOKBOOK::RECIPE_NAME],COOKBOOK::RECIPE_NAME,role[ROLE_NAME]'`. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_run_list_set_syntax.md b/www/layouts/shortcodes/ws_knife_node_run_list_set_syntax.md deleted file mode 100644 index f58030b68..000000000 --- a/www/layouts/shortcodes/ws_knife_node_run_list_set_syntax.md +++ /dev/null @@ -1,5 +0,0 @@ -This argument has the following syntax: - -``` bash -knife node run_list set NODE_NAME RUN_LIST_ITEM -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_node_summary.md b/www/layouts/shortcodes/ws_knife_node_summary.md deleted file mode 100644 index e04a48f3f..000000000 --- a/www/layouts/shortcodes/ws_knife_node_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife node` subcommand to manage the nodes that exist on a Chef -Infra Server. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_raw_summary.md b/www/layouts/shortcodes/ws_knife_raw_summary.md deleted file mode 100644 index 37accc32d..000000000 --- a/www/layouts/shortcodes/ws_knife_raw_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife raw` subcommand to send a REST request to an endpoint in -the Chef Infra Server API. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_recipe_list_summary.md b/www/layouts/shortcodes/ws_knife_recipe_list_summary.md deleted file mode 100644 index a4fb14722..000000000 --- a/www/layouts/shortcodes/ws_knife_recipe_list_summary.md +++ /dev/null @@ -1,5 +0,0 @@ -Use the `knife recipe list` subcommand to view all of the recipes that -are on a Chef Infra Server. A regular expression can be used to limit -the results to recipes that match a specific pattern. The regular -expression must be within quotes and not be surrounded by forward -slashes (/). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_role_summary.md b/www/layouts/shortcodes/ws_knife_role_summary.md deleted file mode 100644 index cf8298876..000000000 --- a/www/layouts/shortcodes/ws_knife_role_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife role` subcommand to manage the roles that are associated -with one or more nodes on a Chef Infra Server. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_cookbook.md b/www/layouts/shortcodes/ws_knife_search_by_cookbook.md deleted file mode 100644 index 243f9b5be..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_cookbook.md +++ /dev/null @@ -1,7 +0,0 @@ -To search for cookbooks on a node, use the `recipes` attribute followed -by the `cookbook::recipe` pattern, escaping both of the `:` characters. -For example: - -``` bash -knife search node 'recipes:cookbook_name\:\:recipe_name' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_nested_attribute.md b/www/layouts/shortcodes/ws_knife_search_by_nested_attribute.md deleted file mode 100644 index dad5c15b5..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_nested_attribute.md +++ /dev/null @@ -1,5 +0,0 @@ -To find a nested attribute, use a pattern similar to the following: - -``` bash -knife search node -a . -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_node.md b/www/layouts/shortcodes/ws_knife_search_by_node.md deleted file mode 100644 index b44b8c3b5..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_node.md +++ /dev/null @@ -1,5 +0,0 @@ -To search for all nodes running Ubuntu, enter: - -``` bash -knife search node 'platform:ubuntu' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_node_and_environment.md b/www/layouts/shortcodes/ws_knife_search_by_node_and_environment.md deleted file mode 100644 index e7bd99e5f..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_node_and_environment.md +++ /dev/null @@ -1,6 +0,0 @@ -To search for all nodes running CentOS in the production environment, -enter: - -``` bash -knife search node 'chef_environment:production AND platform:centos' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_platform_ids.md b/www/layouts/shortcodes/ws_knife_search_by_platform_ids.md deleted file mode 100644 index 5ed87ba92..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_platform_ids.md +++ /dev/null @@ -1,20 +0,0 @@ -To search for the IDs of all nodes running on the Amazon EC2 platform, -enter: - -``` bash -knife search node 'ec2:*' -i -``` - -to return something like: - -``` bash -4 items found - -ip-0A7CA19F.ec2.internal - -ip-0A58CF8E.ec2.internal - -ip-0A58E134.ec2.internal - -ip-0A7CFFD5.ec2.internal -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_platform_instance_type.md b/www/layouts/shortcodes/ws_knife_search_by_platform_instance_type.md deleted file mode 100644 index 70e1a74ea..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_platform_instance_type.md +++ /dev/null @@ -1,24 +0,0 @@ -To search for the instance type (flavor) of all nodes running on the -Amazon EC2 platform, enter: - -``` bash -knife search node 'ec2:*' -a ec2.instance_type -``` - -to return something like: - -``` bash -4 items found - -ec2.instance_type: m1.large -id: ip-0A7CA19F.ec2.internal - -ec2.instance_type: m1.large -id: ip-0A58CF8E.ec2.internal - -ec2.instance_type: m1.large -id: ip-0A58E134.ec2.internal - -ec2.instance_type: m1.large -id: ip-0A7CFFD5.ec2.internal -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_query_for_many_attributes.md b/www/layouts/shortcodes/ws_knife_search_by_query_for_many_attributes.md deleted file mode 100644 index c5600a322..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_query_for_many_attributes.md +++ /dev/null @@ -1,7 +0,0 @@ -To build a search query to use more than one attribute, use an -underscore (`_`) to separate each attribute. For example, the following -query will search for all nodes running a specific version of Ruby: - -``` bash -knife search node "languages_ruby_version:2.7.0" -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_query_for_nested_attribute.md b/www/layouts/shortcodes/ws_knife_search_by_query_for_nested_attribute.md deleted file mode 100644 index caeb6506b..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_query_for_nested_attribute.md +++ /dev/null @@ -1,5 +0,0 @@ -To build a search query that can find a nested attribute: - -``` bash -knife search node name: -a kernel.machine -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_by_recipe.md b/www/layouts/shortcodes/ws_knife_search_by_recipe.md deleted file mode 100644 index 2085a476c..000000000 --- a/www/layouts/shortcodes/ws_knife_search_by_recipe.md +++ /dev/null @@ -1,12 +0,0 @@ -To search for recipes that are used by a node, use the `recipes` -attribute to search for the recipe names, enter something like: - -``` bash -knife search node 'recipes:recipe_name' -``` - -or: - -``` bash -knife search node '*:*' -a recipes | grep 'recipe_name' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_summary.md b/www/layouts/shortcodes/ws_knife_search_summary.md deleted file mode 100644 index 860cfcdf4..000000000 --- a/www/layouts/shortcodes/ws_knife_search_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife search` subcommand to run a search query for information -that is indexed on a Chef Infra Server. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_search_test_query_for_ssh.md b/www/layouts/shortcodes/ws_knife_search_test_query_for_ssh.md deleted file mode 100644 index 1d254b6da..000000000 --- a/www/layouts/shortcodes/ws_knife_search_test_query_for_ssh.md +++ /dev/null @@ -1,8 +0,0 @@ -To test a search query that will be used in a `knife ssh` subcommand: - -``` bash -knife search node "role:web NOT name:web03" -``` - -where the query in the previous example will search all servers that -have the `web` role, but not on the server named `web03`. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_serve_summary.md b/www/layouts/shortcodes/ws_knife_serve_summary.md deleted file mode 100644 index 4fac9040a..000000000 --- a/www/layouts/shortcodes/ws_knife_serve_summary.md +++ /dev/null @@ -1,8 +0,0 @@ -Use the `knife serve` subcommand to run a persistent chef-zero against -the local chef-repo. (chef-zero is a lightweight Chef Infra Server that -runs in-memory on the local machine.) This is the same as running the -Chef Infra Client executable with the `--local-mode` option. The -`chef_repo_path` is located automatically and the Chef Infra Server will -bind to the first available port between `8889` and `9999`. -`knife serve` will print the URL for the local Chef Infra Server, so -that it may be added to the config.rb file. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_show_summary.md b/www/layouts/shortcodes/ws_knife_show_summary.md deleted file mode 100644 index a39fc82ff..000000000 --- a/www/layouts/shortcodes/ws_knife_show_summary.md +++ /dev/null @@ -1,5 +0,0 @@ -Use the `knife show` subcommand to view the details of one (or more) -objects on the Chef Infra Server. This subcommand works similar to -`knife cookbook show`, `knife data bag show`, `knife environment show`, -`knife node show`, and `knife role show`, but with a single verb (and a -single action). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_ssh_summary.md b/www/layouts/shortcodes/ws_knife_ssh_summary.md deleted file mode 100644 index 2d1ea72cf..000000000 --- a/www/layouts/shortcodes/ws_knife_ssh_summary.md +++ /dev/null @@ -1,3 +0,0 @@ -Use the `knife ssh` subcommand to invoke SSH commands (in parallel) on a -subset of nodes within an organization, based on the results of a -[search query](/chef_search/) made to the Chef Infra Server. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_ssl_check_bad_ssl_certificate.md b/www/layouts/shortcodes/ws_knife_ssl_check_bad_ssl_certificate.md deleted file mode 100644 index ffe71aeb4..000000000 --- a/www/layouts/shortcodes/ws_knife_ssl_check_bad_ssl_certificate.md +++ /dev/null @@ -1,42 +0,0 @@ -If the SSL certificate cannot be verified, the response to - -``` bash -knife ssl check -``` - -is similar to: - -``` bash -Connecting to host chef-server.example.com:443 -ERROR: The SSL certificate of chef-server.example.com could not be verified -Certificate issuer data: - /C=US/ST=WA/L=S/O=Corp/OU=Ops/CN=chef-server.example.com/emailAddress=you@example.com - -Configuration Info: - -OpenSSL Configuration: -* Version: OpenSSL 1.0.2u 20 Dec 2019 -* Certificate file: /opt/chef-workstation/embedded/ssl/cert.pem -* Certificate directory: /opt/chef-workstation/embedded/ssl/certs -Chef SSL Configuration: -* ssl_ca_path: nil -* ssl_ca_file: nil -* trusted_certs_dir: "/Users/grantmc/Downloads/chef-repo/.chef/trusted_certs" - -TO FIX THIS ERROR: - -If the server you are connecting to uses a self-signed certificate, -you must configure chef to trust that certificate. - -By default, the certificate is stored in the following location on the -host where your Chef Infra Server runs: - - /var/opt/opscode/nginx/ca/SERVER_HOSTNAME.crt - -Copy that file to your trusted_certs_dir (currently: - - /Users/grantmc/Downloads/chef-repo/.chef/trusted_certs) - -using SSH/SCP or some other secure method, then re-run this command to -confirm that the certificate is now trusted. -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_ssl_check_summary.md b/www/layouts/shortcodes/ws_knife_ssl_check_summary.md deleted file mode 100644 index fd721f25b..000000000 --- a/www/layouts/shortcodes/ws_knife_ssl_check_summary.md +++ /dev/null @@ -1,30 +0,0 @@ -Use the `knife ssl check` subcommand to verify the SSL configuration for -the Chef Infra Server or a location specified by a URL or URI. Invalid -certificates will not be used by OpenSSL. - -When this command is run, the certificate files (`*.crt` and/or `*.pem`) -that are located in the `/.chef/trusted_certs` directory are checked to -see if they have valid X.509 certificate properties. A warning is -returned when certificates do not have valid X.509 certificate -properties or if the `/.chef/trusted_certs` directory does not contain -any certificates. - -
- -

Warning

- -
- -When verification of a remote server's SSL certificate is disabled, Chef -Infra Client will issue a warning similar to "SSL validation of HTTPS -requests is disabled. HTTPS connections are still encrypted, but Chef -Infra Client is not able to detect forged replies or man-in-the-middle -attacks." To configure SSL for Chef Infra Client, set `ssl_verify_mode` -to `:verify_peer` (recommended) **or** `verify_api_cert` to `true` in -the client.rb file. - - - -
- -
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_ssl_check_verify_server_config.md b/www/layouts/shortcodes/ws_knife_ssl_check_verify_server_config.md deleted file mode 100644 index ded4df082..000000000 --- a/www/layouts/shortcodes/ws_knife_ssl_check_verify_server_config.md +++ /dev/null @@ -1,12 +0,0 @@ -If the SSL certificate can be verified, the response to - -``` bash -knife ssl check -``` - -is similar to: - -``` bash -Connecting to host chef-server.example.com:443 -Successfully verified certificates from 'chef-server.example.com' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_ssl_fetch_summary.md b/www/layouts/shortcodes/ws_knife_ssl_fetch_summary.md deleted file mode 100644 index 5e4e005e1..000000000 --- a/www/layouts/shortcodes/ws_knife_ssl_fetch_summary.md +++ /dev/null @@ -1,27 +0,0 @@ -Use the `knife ssl fetch` subcommand to copy SSL certificates from an -HTTPS server to the `trusted_certs_dir` directory that is used by knife -and Chef Infra Client to store trusted SSL certificates. When these -certificates match the hostname of the remote server, running -`knife ssl fetch` is the only step required to verify a remote server -that is accessed by either knife or Chef Infra Client. - -
- -

Warning

- -
- -It is the user's responsibility to verify the authenticity of every SSL -certificate before downloading it to the `/.chef/trusted_certs` -directory. knife will use any certificate in that directory as if it is -a 100% trusted and authentic SSL certificate. knife will not be able to -determine if any certificate in this directory has been tampered with, -is forged, malicious, or otherwise harmful. Therefore it is essential -that users take the proper steps before downloading certificates into -this directory. - - - -
- -
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_ssl_fetch_verify_certificate.md b/www/layouts/shortcodes/ws_knife_ssl_fetch_verify_certificate.md deleted file mode 100644 index 74d38db73..000000000 --- a/www/layouts/shortcodes/ws_knife_ssl_fetch_verify_certificate.md +++ /dev/null @@ -1,30 +0,0 @@ -The SSL certificate that is downloaded to the `/.chef/trusted_certs` -directory should be verified to ensure that it is, in fact, the same -certificate as the one located on the Chef Infra Server. This can be -done by comparing the SHA-256 checksums. - -1. View the checksum on the Chef Infra Server: - - ``` bash - ssh ubuntu@chef-server.example.com sudo sha256sum /var/opt/opscode/nginx/ca/chef-server.example.com.crt - ``` - - The response is similar to: - - ``` bash - /var/opt/opscode/nginx/ca/chef-server.example.com.crt - ``` - -2. View the checksum on the workstation: - - ``` bash - gsha256sum .chef/trusted_certs/chef-server.example.com.crt - ``` - - The response is similar to: - - ``` bash - .chef/trusted_certs/chef-server.example.com.crt - ``` - -3. Verify that the checksum values are identical. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_status_include_run_lists.md b/www/layouts/shortcodes/ws_knife_status_include_run_lists.md deleted file mode 100644 index ef436304b..000000000 --- a/www/layouts/shortcodes/ws_knife_status_include_run_lists.md +++ /dev/null @@ -1,16 +0,0 @@ -To include run-lists in the status, enter: - -``` bash -knife status --run-list -``` - -to return something like: - -``` bash -20 hours ago, dev-vm.chisamore.com, ubuntu 10.04, dev-vm.chisamore.com, 10.66.44.126, role[lb]. -3 hours ago, i-225f954f, ubuntu 10.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102, role[web]. -3 hours ago, i-a45298c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 174.129.127.206, role[web]. -3 hours ago, i-5272a43f, ubuntu 10.04, ec2-184-73-9-250.compute-1.amazonaws.com, 184.73.9.250, role[web]. -3 hours ago, i-226ca64f, ubuntu 10.04, ec2-75-101-240-230.compute-1.amazonaws.com, 75.101.240.230, role[web]. -3 hours ago, i-f65c969b, ubuntu 10.04, ec2-184-73-60-141.compute-1.amazonaws.com, 184.73.60.141, role[web]. -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_status_returned_by_query.md b/www/layouts/shortcodes/ws_knife_status_returned_by_query.md deleted file mode 100644 index cdcc81d3d..000000000 --- a/www/layouts/shortcodes/ws_knife_status_returned_by_query.md +++ /dev/null @@ -1,16 +0,0 @@ -To show the status of a subset of nodes that are returned by a specific -query, enter: - -``` bash -knife status "role:web" --run-list -``` - -to return something like: - -``` bash -3 hours ago, i-225f954f, ubuntu 10.04, ec2-67-202-63-102.compute-1.amazonaws.com, 67.202.63.102, role[web]. -3 hours ago, i-a45298c9, ubuntu 10.04, ec2-174-129-127-206.compute-1.amazonaws.com, 174.129.127.206, role[web]. -3 hours ago, i-5272a43f, ubuntu 10.04, ec2-184-73-9-250.compute-1.amazonaws.com, 184.73.9.250, role[web]. -3 hours ago, i-226ca64f, ubuntu 10.04, ec2-75-101-240-230.compute-1.amazonaws.com, 75.101.240.230, role[web]. -3 hours ago, i-f65c969b, ubuntu 10.04, ec2-184-73-60-141.compute-1.amazonaws.com, 184.73.60.141, role[web]. -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_status_summary.md b/www/layouts/shortcodes/ws_knife_status_summary.md deleted file mode 100644 index a0492c2cd..000000000 --- a/www/layouts/shortcodes/ws_knife_status_summary.md +++ /dev/null @@ -1,3 +0,0 @@ -Use the `knife status` subcommand to display a brief summary of the -nodes on a Chef Infra Server, including the time of the most recent -successful Chef Infra Client run. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_tag_summary.md b/www/layouts/shortcodes/ws_knife_tag_summary.md deleted file mode 100644 index d849f558f..000000000 --- a/www/layouts/shortcodes/ws_knife_tag_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife tag` subcommand to apply tags to nodes on a Chef Infra -Server. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_upload_summary.md b/www/layouts/shortcodes/ws_knife_upload_summary.md deleted file mode 100644 index 117540592..000000000 --- a/www/layouts/shortcodes/ws_knife_upload_summary.md +++ /dev/null @@ -1,13 +0,0 @@ -Use the `knife upload` subcommand to upload data to the Chef Infra -Server from the current working directory in the chef-repo. The -following types of data may be uploaded with this subcommand: - -- Cookbooks -- Data bags -- Roles stored as JSON data -- Environments stored as JSON data - -(Roles and environments stored as Ruby data will not be uploaded.) This -subcommand is often used in conjunction with `knife diff`, which can be -used to see exactly what changes will be uploaded, and then -`knife download`, which does the opposite of `knife upload`. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_user_summary.md b/www/layouts/shortcodes/ws_knife_user_summary.md deleted file mode 100644 index a54f2498e..000000000 --- a/www/layouts/shortcodes/ws_knife_user_summary.md +++ /dev/null @@ -1,2 +0,0 @@ -Use the `knife user` subcommand to manage the list of users and their -associated RSA public key-pairs. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_windows_summary.md b/www/layouts/shortcodes/ws_knife_windows_summary.md deleted file mode 100644 index d92533160..000000000 --- a/www/layouts/shortcodes/ws_knife_windows_summary.md +++ /dev/null @@ -1,5 +0,0 @@ -The `knife windows` subcommand is used to interact with Windows systems -managed by Chef Infra. Nodes are configured using WinRM, which allows -external applications to call native objects like batch scripts, Windows -PowerShell scripts, or scripting library variables. The `knife windows` -subcommand supports NTLM and Kerberos methods of authentication. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_windows_winrm_ports.md b/www/layouts/shortcodes/ws_knife_windows_winrm_ports.md deleted file mode 100644 index 3d810e586..000000000 --- a/www/layouts/shortcodes/ws_knife_windows_winrm_ports.md +++ /dev/null @@ -1,2 +0,0 @@ -WinRM requires that a target node be accessible via the ports configured -to support access via HTTP or HTTPS. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_knife_xargs_summary.md b/www/layouts/shortcodes/ws_knife_xargs_summary.md deleted file mode 100644 index 4f3f38896..000000000 --- a/www/layouts/shortcodes/ws_knife_xargs_summary.md +++ /dev/null @@ -1,3 +0,0 @@ -Use the `knife xargs` subcommand to take patterns from standard input, -download as JSON, run a command against the downloaded JSON, and then -upload any changes. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_node.md b/www/layouts/shortcodes/ws_node.md deleted file mode 100644 index 9561ea19e..000000000 --- a/www/layouts/shortcodes/ws_node.md +++ /dev/null @@ -1,2 +0,0 @@ -A node is any device---physical, virtual, cloud, network device, -etc.---that is under management by Chef Infra. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_node_ctl_attribute.md b/www/layouts/shortcodes/ws_node_ctl_attribute.md deleted file mode 100644 index 5c9e07946..000000000 --- a/www/layouts/shortcodes/ws_node_ctl_attribute.md +++ /dev/null @@ -1,35 +0,0 @@ -Any other attribute type that is contained in this JSON file will be -treated as a `normal` attribute. Setting attributes at other precedence -levels is not possible. For example, attempting to update `override` -attributes using the `-j` option: - -``` javascript -{ - "name": "dev-99", - "description": "Install some stuff", - "override_attributes": { - "apptastic": { - "enable_apptastic": "false", - "apptastic_tier_name": "dev-99.bomb.com" - } - } -} -``` - -will result in a node object similar to: - -``` javascript -{ - "name": "maybe-dev-99", - "normal": { - "name": "dev-99", - "description": "Install some stuff", - "override_attributes": { - "apptastic": { - "enable_apptastic": "false", - "apptastic_tier_name": "dev-99.bomb.com" - } - } - } -} -``` diff --git a/www/layouts/shortcodes/ws_node_run_list.md b/www/layouts/shortcodes/ws_node_run_list.md deleted file mode 100644 index 177b9a4a2..000000000 --- a/www/layouts/shortcodes/ws_node_run_list.md +++ /dev/null @@ -1,11 +0,0 @@ -A run-list defines all of the information necessary for Chef to -configure a node into the desired state. A run-list is: - -- An ordered list of roles and/or recipes that are run in the exact - order defined in the run-list; if a recipe appears more than once in - the run-list, Chef Infra Client will not run it twice -- Always specific to the node on which it runs; nodes may have a - run-list that is identical to the run-list used by other nodes -- Stored as part of the node object on the Chef server -- Maintained using knife and then uploaded from the workstation to the - Chef Infra Server, or maintained using Chef Automate \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_node_run_list_format.md b/www/layouts/shortcodes/ws_node_run_list_format.md deleted file mode 100644 index 91f57c280..000000000 --- a/www/layouts/shortcodes/ws_node_run_list_format.md +++ /dev/null @@ -1,20 +0,0 @@ -A run-list must be in one of the following formats: fully qualified, -cookbook, or default. Both roles and recipes must be in quotes, for -example: - -``` ruby -'role[NAME]' -``` - -or - -``` ruby -'recipe[COOKBOOK::RECIPE]' -``` - -Use a comma to separate roles and recipes when adding more than one item -the run-list: - -``` ruby -'recipe[COOKBOOK::RECIPE],COOKBOOK::RECIPE,role[NAME]' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_notes_knife_cookbook_site_use_devkit_berkshelf.md b/www/layouts/shortcodes/ws_notes_knife_cookbook_site_use_devkit_berkshelf.md deleted file mode 100644 index d6698f9dc..000000000 --- a/www/layouts/shortcodes/ws_notes_knife_cookbook_site_use_devkit_berkshelf.md +++ /dev/null @@ -1,3 +0,0 @@ -Please consider managing community cookbooks using the version of -Berkshelf that ships with Chef Workstation. For more information about -Chef Workstation, see [About Chef Workstation](/workstation/). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_push_jobs_summary.md b/www/layouts/shortcodes/ws_push_jobs_summary.md deleted file mode 100644 index b2b15ba51..000000000 --- a/www/layouts/shortcodes/ws_push_jobs_summary.md +++ /dev/null @@ -1,11 +0,0 @@ -Chef Push Jobs is an extension of the Chef Infra Server that allows jobs -to be run against nodes independently of a Chef Infra Client run. A job -is an action or a command to be executed against a subset of nodes; the -nodes against which a job is run are determined by the results of a -search query made to the Chef Infra Server. - -Chef Push Jobs uses the Chef Infra Server API and a Ruby client to -initiate all connections to the Chef Infra Server. Connections use the -same authentication and authorization model as any other request made to -the Chef Infra Server. A knife plugin is used to initiate job creation -and job tracking. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_role.md b/www/layouts/shortcodes/ws_role.md deleted file mode 100644 index 9bbd6c317..000000000 --- a/www/layouts/shortcodes/ws_role.md +++ /dev/null @@ -1,9 +0,0 @@ -A role is a way to define certain patterns and processes that exist -across nodes in an organization as belonging to a single job function. -Each role consists of zero (or more) attributes and a run-list. Each -node can have zero (or more) roles assigned to it. When a role is run -against a node, the configuration details of that node are compared -against the attributes of the role, and then the contents of that role's -run-list are applied to the node's configuration details. When a Chef -Infra Client runs, it merges its own attributes and run-lists with those -contained within each assigned role. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_ruby_style_patterns_hyphens.md b/www/layouts/shortcodes/ws_ruby_style_patterns_hyphens.md deleted file mode 100644 index 3edb8d02c..000000000 --- a/www/layouts/shortcodes/ws_ruby_style_patterns_hyphens.md +++ /dev/null @@ -1,6 +0,0 @@ -Cookbook and custom resource names should contain only alphanumeric -characters. A hyphen (`-`) is a valid character and may be used in -cookbook and custom resource names, but it is discouraged. Chef Infra -Client will return an error if a hyphen is not converted to an -underscore (`_`) when referencing from a recipe the name of a custom -resource in which a hyphen is located. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search.md b/www/layouts/shortcodes/ws_search.md deleted file mode 100644 index c99e9eccc..000000000 --- a/www/layouts/shortcodes/ws_search.md +++ /dev/null @@ -1,10 +0,0 @@ -Search indexes allow queries to be made for any type of data that is -indexed by the Chef Infra Server, including data bags (and data bag -items), environments, nodes, and roles. A defined query syntax is used -to support search patterns like exact, wildcard, range, and fuzzy. A -search is a full-text query that can be done from several locations, -including from within a recipe, by using the `search` subcommand in -knife, the `search` method in the Recipe DSL, the search box in the Chef -management console, and by using the `/search` or `/search/INDEX` -endpoints in the Chef Infra Server API. The search engine is based on -Apache Solr and is run from the Chef Infra Server. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_boolean_and.md b/www/layouts/shortcodes/ws_search_boolean_and.md deleted file mode 100644 index d1d681f0e..000000000 --- a/www/layouts/shortcodes/ws_search_boolean_and.md +++ /dev/null @@ -1,54 +0,0 @@ -To join queries using the `AND` boolean operator, enter the following: - -``` bash -knife search sample "id:b* AND animal:dog" -``` - -to return something like: - -``` bash -{ - "total": 1, - "start": 0, - "rows": [ - { - "comment": "an item named baz", - "id": "baz", - "animal": "dog" - } - ] -} -``` - -Or, to find all of the computers running on the Microsoft Windows -platform that are associated with a role named `jenkins`, enter: - -``` bash -knife search node 'platform:windows AND roles:jenkins' -``` - -to return something like: - -``` bash -2 items found - -Node Name: windows-server-2012r2.domain.com -Environment: _default -FQDN: windows-server-2012r2 -IP: 0000::0000:0000:0000:0000 -Run List: role[jenkins-windows] -Roles: jenkins-windows, jenkins -Recipes: jenkins-client::windows, jenkins::node_windows -Platform: windows 6.3.9600 -Tags: - -Node Name: 123-windows-2012r2-amd64-builder -Environment: _default -FQDN: ABC-1234567890AB -IP: 123.45.6.78 -Run List: role[123-windows-2012r2-amd64-builder] -Roles: 123-windows-2012r2-amd64-builder, jenkins -Recipes: jenkins::node_windows, git_windows -Platform: windows 6.3.9600 -Tags: -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_boolean_not.md b/www/layouts/shortcodes/ws_search_boolean_not.md deleted file mode 100644 index f4a4b6788..000000000 --- a/www/layouts/shortcodes/ws_search_boolean_not.md +++ /dev/null @@ -1,37 +0,0 @@ -To negate search results using the `NOT` boolean operator, enter the -following: - -``` bash -knife search sample "(NOT id:foo)" -``` - -to return something like: - -``` bash -{ - "total": 4, - "start": 0, - "rows": [ - { - "comment": "an item named bar", - "id": "bar", - "animal": "cat" - }, - { - "comment": "an item named baz", - "id": "baz" - "animal": "dog" - }, - { - "comment": "an item named abc", - "id": "abc", - "animal": "unicorn" - }, - { - "comment": "an item named qux", - "id": "qux", - "animal", "penguin" - } - ] -} -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_boolean_operators.md b/www/layouts/shortcodes/ws_search_boolean_operators.md deleted file mode 100644 index 0384fe408..000000000 --- a/www/layouts/shortcodes/ws_search_boolean_operators.md +++ /dev/null @@ -1,31 +0,0 @@ -An operator can be used to ensure that certain terms are included in the -results, are excluded from the results, or are not included even when -other aspects of the query match. Searches can use the following -operators: - - ---- - - - - - - - - - - - - - - - - - - - - -
OperatorDescription
ANDUse to find a match when both terms exist.
ORUse to find a match if either term exists.
NOTUse to exclude the term after NOT from the search results.
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_boolean_operators_andnot.md b/www/layouts/shortcodes/ws_search_boolean_operators_andnot.md deleted file mode 100644 index c1c150fe9..000000000 --- a/www/layouts/shortcodes/ws_search_boolean_operators_andnot.md +++ /dev/null @@ -1,28 +0,0 @@ -Operators must be in ALL CAPS. Parentheses can be used to group clauses -and to form sub-queries. - -
- -

Warning

- -
- -Using `AND NOT` together may trigger an error. For example: - -``` bash -ERROR: knife search failed: invalid search query: -'datacenter%3A123%20AND%20NOT%20hostname%3Adev-%20AND%20NOT%20hostanem%3Asyslog-' -Parse error at offset: 38 Reason: Expected one of \ at line 1, column 42 (byte 42) after AND -``` - -Use `-` instead of `NOT`. For example: - -``` bash -knife search sample "id:foo AND -id:bar" -``` - - - -
- -
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_boolean_or.md b/www/layouts/shortcodes/ws_search_boolean_or.md deleted file mode 100644 index 55715762e..000000000 --- a/www/layouts/shortcodes/ws_search_boolean_or.md +++ /dev/null @@ -1,26 +0,0 @@ -To join queries using the `OR` boolean operator, enter the following: - -``` bash -knife search sample "id:foo OR id:abc" -``` - -to return something like: - -``` bash -{ - "total": 2, - "start": 0, - "rows": [ - { - "comment": "an item named foo", - "id": "foo", - "animal": "pony" - }, - { - "comment": "an item named abc", - "id": "abc", - "animal": "unicorn" - } - ] -} -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_key.md b/www/layouts/shortcodes/ws_search_key.md deleted file mode 100644 index 85a6497db..000000000 --- a/www/layouts/shortcodes/ws_search_key.md +++ /dev/null @@ -1,4 +0,0 @@ -A field name/description pair is available in the JSON object. Use the -field name when searching for this information in the JSON object. Any -field that exists in any JSON description for any role, node, Chef Infra -Client, environment, or data bag can be searched. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_key_name.md b/www/layouts/shortcodes/ws_search_key_name.md deleted file mode 100644 index b2333cd75..000000000 --- a/www/layouts/shortcodes/ws_search_key_name.md +++ /dev/null @@ -1,9 +0,0 @@ -To see the available keys for a node, enter the following (for a node -named `staging`): - -``` bash -knife node show staging -Fj | less -``` - -to return a full JSON description of the node and to view the available -keys with which any search query can be based. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_key_nested.md b/www/layouts/shortcodes/ws_search_key_nested.md deleted file mode 100644 index 2196f16bf..000000000 --- a/www/layouts/shortcodes/ws_search_key_nested.md +++ /dev/null @@ -1,142 +0,0 @@ -A nested field appears deeper in the JSON data structure. For example, -information about a network interface might be several layers deep: -`node['network']['interfaces']['en1']`. When nested fields are present -in a JSON structure, Chef Infra Client will extract those nested fields -to the top-level, flattening them into compound fields that support -wildcard search patterns. - -By combining wildcards with range-matching patterns and wildcard -queries, it is possible to perform very powerful searches, such as using -the vendor part of the MAC address to find every node that has a network -card made by the specified vendor. - -Consider the following snippet of JSON data: - -``` javascript -{"network": - [ - //snipped... - "interfaces", - {"en1": { - "number": "1", - "flags": [ - "UP", - "BROADCAST", - "SMART", - "RUNNING", - "SIMPLEX", - "MULTICAST" - ], - "addresses": { - "fe80::fa1e:dfff:fed8:63a2": { - "scope": "Link", - "prefixlen": "64", - "family": "inet6" - }, - "f8:1e:df:d8:63:a2": { - "family": "lladdr" - }, - "192.0.2.0": { - "netmask": "255.255.255.0", - "broadcast": "192.168.0.255", - "family": "inet" - } - }, - "mtu": "1500", - "media": { - "supported": { - "autoselect": { - "options": [ - - ] - } - }, - "selected": { - "autoselect": { - "options": [ - - ] - } - } - }, - "type": "en", - "status": "active", - "encapsulation": "Ethernet" - }, - //snipped... -``` - -Before this data is indexed on the Chef Infra Server, the nested fields -are extracted into the top level, similar to: - -``` none -"broadcast" => "192.168.0.255", -"flags" => ["UP", "BROADCAST", "SMART", "RUNNING", "SIMPLEX", "MULTICAST"] -"mtu" => "1500" -``` - -which allows searches like the following to find data that is present in -this node: - -``` ruby -node "broadcast:192.168.0.*" -``` - -or: - -``` ruby -node "mtu:1500" -``` - -or: - -``` ruby -node "flags:UP" -``` - -This data is also flattened into various compound fields, which follow -the same pattern as the JSON hierarchy and use underscores (`_`) to -separate the levels of data, similar to: - -``` none -# ...snip... -"network_interfaces_en1_addresses_192.0.2.0_broadcast" => "192.168.0.255", -"network_interfaces_en1_addresses_fe80::fa1e:tldr_family" => "inet6", -"network_interfaces_en1_addresses" => ["fe80::fa1e:tldr","f8:1e:df:tldr","192.0.2.0"] -# ...snip... -``` - -which allows searches like the following to find data that is present in -this node: - -``` ruby -node "network_interfaces_en1_addresses:192.0.2.0" -``` - -This flattened data structure also supports using wildcard compound -fields, which allow searches to omit levels within the JSON data -structure that are not important to the search query. In the following -example, an asterisk (`*`) is used to show where the wildcard can exist -when searching for a nested field: - -``` ruby -"network_interfaces_*_flags" => ["UP", "BROADCAST", "SMART", "RUNNING", "SIMPLEX", "MULTICAST"] -"network_interfaces_*_addresses" => ["fe80::fa1e:dfff:fed8:63a2", "192.0.2.0", "f8:1e:df:d8:63:a2"] -"network_interfaces_en0_media_*" => ["autoselect", "none", "1000baseT", "10baseT/UTP", "100baseTX"] -"network_interfaces_en1_*" => ["1", "UP", "BROADCAST", "SMART", "RUNNING", "SIMPLEX", "MULTICAST", - "fe80::fa1e:dfff:fed8:63a2", "f8:1e:df:d8:63:a2", "192.0.2.0", - "1500", "supported", "selected", "en", "active", "Ethernet"] -``` - -For each of the wildcard examples above, the possible values are shown -contained within the brackets. When running a search query, the query -syntax for wildcards is to simply omit the name of the node (while -preserving the underscores), similar to: - -``` ruby -network_interfaces__flags -``` - -This query will search within the `flags` node, within the JSON -structure, for each of `UP`, `BROADCAST`, `SMART`, `RUNNING`, `SIMPLEX`, -and `MULTICAST`. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_key_nested_range.md b/www/layouts/shortcodes/ws_search_key_nested_range.md deleted file mode 100644 index 3cc018944..000000000 --- a/www/layouts/shortcodes/ws_search_key_nested_range.md +++ /dev/null @@ -1,8 +0,0 @@ -To use a range search to find IP addresses within a subnet, enter the -following: - -``` bash -knife search node 'ipaddress:[192.168.0.* TO 192.0.2.*]' -``` - -where `192.168.0.* TO 192.0.2.*` defines the subnet range. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_key_nested_starting_with.md b/www/layouts/shortcodes/ws_search_key_nested_starting_with.md deleted file mode 100644 index aa4f91337..000000000 --- a/www/layouts/shortcodes/ws_search_key_nested_starting_with.md +++ /dev/null @@ -1,9 +0,0 @@ -To find all IP address that are on the same network, enter the -following: - -``` bash -knife search node 'ipaddress:192.168*' -``` - -where `192.168*` is the network address for which the search will be -run. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_key_wildcard_asterisk.md b/www/layouts/shortcodes/ws_search_key_wildcard_asterisk.md deleted file mode 100644 index baf1c6e13..000000000 --- a/www/layouts/shortcodes/ws_search_key_wildcard_asterisk.md +++ /dev/null @@ -1,6 +0,0 @@ -To use an asterisk (`*`) to replace zero (or more) characters in a -wildcard search, enter the following: - -``` bash -knife search node 'platfo*:ubuntu' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_key_wildcard_question_mark.md b/www/layouts/shortcodes/ws_search_key_wildcard_question_mark.md deleted file mode 100644 index 6da5d60b5..000000000 --- a/www/layouts/shortcodes/ws_search_key_wildcard_question_mark.md +++ /dev/null @@ -1,6 +0,0 @@ -To use a question mark (`?`) to replace a single character in a wildcard -search, enter the following: - -``` bash -knife search node 'platfor?:ubuntu' -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern.md b/www/layouts/shortcodes/ws_search_pattern.md deleted file mode 100644 index a1fc84881..000000000 --- a/www/layouts/shortcodes/ws_search_pattern.md +++ /dev/null @@ -1,4 +0,0 @@ -A search pattern is a way to fine-tune search results by returning -anything that matches some type of incomplete search query. There are -four types of search patterns that can be used when searching the search -indexes on the Chef Infra Server: exact, wildcard, range, and fuzzy. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_exact.md b/www/layouts/shortcodes/ws_search_pattern_exact.md deleted file mode 100644 index 42fd2417c..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_exact.md +++ /dev/null @@ -1,8 +0,0 @@ -An exact matching search pattern is used to search for a key with a name -that exactly matches a search query. If the name of the key contains -spaces, quotes must be used in the search pattern to ensure the search -query finds the key. The entire query must also be contained within -quotes, so as to prevent it from being interpreted by Ruby or a command -shell. The best way to ensure that quotes are used consistently is to -quote the entire query using single quotes (' ') and a search pattern -with double quotes (" "). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_exact_key_and_item.md b/www/layouts/shortcodes/ws_search_pattern_exact_key_and_item.md deleted file mode 100644 index fb55d55ed..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_exact_key_and_item.md +++ /dev/null @@ -1,21 +0,0 @@ -To search in a specific data bag for a specific data bag item, enter the -following: - -``` bash -knife search admins 'id:charlie' -``` - -where `admins` is the name of the data bag and `charlie` is the name of -the data bag item. Something similar to the following will be returned: - -``` bash -1 items found -_rev: 1-39ff4099f2510f477b4c26bef81f75b9 -chef_type: data_bag_item -comment: Charlie the Unicorn -data_bag: admins -gid: ops -id: charlie -shell: /bin/zsh -uid: 1005 -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_exact_key_and_item_string.md b/www/layouts/shortcodes/ws_search_pattern_exact_key_and_item_string.md deleted file mode 100644 index 9f20629e5..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_exact_key_and_item_string.md +++ /dev/null @@ -1,22 +0,0 @@ -To search in a specific data bag using a string to find any matching -data bag item, enter the following: - -``` bash -knife search admins 'comment:"Charlie the Unicorn"' -``` - -where `admins` is the name of the data bag and `Charlie the Unicorn` is -the string that will be used during the search. Something similar to the -following will be returned: - -``` bash -1 items found -_rev: 1-39ff4099f2510f477b4c26bef81f75b9 -chef_type: data_bag_item -comment: Charlie the Unicorn -data_bag: admins -gid: ops -id: charlie -shell: /bin/zsh -uid: 1005 -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_fuzzy.md b/www/layouts/shortcodes/ws_search_pattern_fuzzy.md deleted file mode 100644 index 6a35cc2cf..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_fuzzy.md +++ /dev/null @@ -1,12 +0,0 @@ -A fuzzy matching search pattern is used to search based on the proximity -of two strings of characters. An (optional) integer may be used as part -of the search query to more closely define the proximity. A fuzzy -matching search pattern has the following syntax: - -``` ruby -"search_query"~edit_distance -``` - -where `search_query` is the string that will be used during the search -and `edit_distance` is the proximity. A tilde ("\~") is used to separate -the edit distance from the search query. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_fuzzy_summary.md b/www/layouts/shortcodes/ws_search_pattern_fuzzy_summary.md deleted file mode 100644 index 6432d162e..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_fuzzy_summary.md +++ /dev/null @@ -1,25 +0,0 @@ -To use a fuzzy search pattern enter something similar to: - -``` bash -knife search client "name:boo~" -``` - -where `boo~` defines the fuzzy search pattern. This will return -something similar to: - -``` javascript -{ - "total": 1, - "start": 0, - "rows": [ - { - "public_key": "too long didn't read", - "name": "foo", - "_rev": "1-f11a58043906e33d39a686e9b58cd92f", - "json_class": "Chef::ApiClient", - "admin": false, - "chef_type": "client" - } - ] -} -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_range.md b/www/layouts/shortcodes/ws_search_pattern_range.md deleted file mode 100644 index 4328141c7..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_range.md +++ /dev/null @@ -1,12 +0,0 @@ -A range matching search pattern is used to query for values that are -within a range defined by upper and lower boundaries. A range matching -search pattern can be inclusive or exclusive of the boundaries. Use -square brackets ("\[ \]") to denote inclusive boundaries and curly -braces ("{ }") to denote exclusive boundaries and with the following -syntax: - -``` ruby -boundary TO boundary -``` - -where `TO` is required (and must be capitalized). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_range_exclusive.md b/www/layouts/shortcodes/ws_search_pattern_range_exclusive.md deleted file mode 100644 index 4295a96ec..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_range_exclusive.md +++ /dev/null @@ -1,11 +0,0 @@ -A data bag named `sample` contains four data bag items: `abc`, `bar`, -`baz`, and `quz`. All of the items that are exclusive to `bar` and `foo` -can be searched for using an exclusive search pattern. - -To search using an exclusive range, enter the following: - -``` bash -knife search sample "id:{bar TO foo}" -``` - -where curly braces (`{ }`) are used to define the range. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_range_in_between.md b/www/layouts/shortcodes/ws_search_pattern_range_in_between.md deleted file mode 100644 index e69aaf51c..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_range_in_between.md +++ /dev/null @@ -1,11 +0,0 @@ -A data bag named `sample` contains four data bag items: `abc`, `bar`, -`baz`, and `quz`. All of the items in-between `bar` and `foo`, -inclusive, can be searched for using an inclusive search pattern. - -To search using an inclusive range, enter the following: - -``` bash -knife search sample "id:[bar TO foo]" -``` - -where square brackets (`[ ]`) are used to define the range. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_wildcard.md b/www/layouts/shortcodes/ws_search_pattern_wildcard.md deleted file mode 100644 index 9c1188cb5..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_wildcard.md +++ /dev/null @@ -1,10 +0,0 @@ -A wildcard matching search pattern is used to query for substring -matches that replace zero (or more) characters in the search pattern -with anything that could match the replaced character. There are two -types of wildcard searches: - -- A question mark (`?`) can be used to replace exactly one character - (as long as that character is not the first character in the search - pattern) -- An asterisk (`*`) can be used to replace any number of characters - (including zero) \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_wildcard_any_node.md b/www/layouts/shortcodes/ws_search_pattern_wildcard_any_node.md deleted file mode 100644 index c4e1d50b1..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_wildcard_any_node.md +++ /dev/null @@ -1,8 +0,0 @@ -To search for any node that contains the specified key, enter the -following: - -``` bash -knife search node 'foo:*' -``` - -where `foo` is the name of the node. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_pattern_wildcard_node_contains.md b/www/layouts/shortcodes/ws_search_pattern_wildcard_node_contains.md deleted file mode 100644 index 298fde897..000000000 --- a/www/layouts/shortcodes/ws_search_pattern_wildcard_node_contains.md +++ /dev/null @@ -1,26 +0,0 @@ -To search for a node using a partial name, enter one of the following: - -``` bash -knife search node 'name:app*' -``` - -or: - -``` bash -knife search node 'name:app1*.example.com' -``` - -or: - -``` bash -knife search node 'name:app?.example.com' -``` - -or: - -``` bash -knife search node 'name:app1.example.???' -``` - -to return `app1.example.com` (and any other node that matches any of the -string searches above). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_query_syntax.md b/www/layouts/shortcodes/ws_search_query_syntax.md deleted file mode 100644 index e81c9a29e..000000000 --- a/www/layouts/shortcodes/ws_search_query_syntax.md +++ /dev/null @@ -1,15 +0,0 @@ -A search query is comprised of two parts: the key and the search -pattern. A search query has the following syntax: - -``` ruby -key:search_pattern -``` - -where `key` is a field name that is found in the JSON description of an -indexable object on the Chef Infra Server (a role, node, client, -environment, or data bag) and `search_pattern` defines what will be -searched for, using one of the following search patterns: exact, -wildcard, range, or fuzzy matching. Both `key` and `search_pattern` are -case-sensitive; `key` has limited support for multiple character -wildcard matching using an asterisk ("\*") (and as long as it is not the -first character). \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_search_special_characters.md b/www/layouts/shortcodes/ws_search_special_characters.md deleted file mode 100644 index 37f02abe5..000000000 --- a/www/layouts/shortcodes/ws_search_special_characters.md +++ /dev/null @@ -1,15 +0,0 @@ -A special character can be used to fine-tune a search query and to -increase the accuracy of the search results. The following characters -can be included within the search query syntax, but each occurrence of a -special character must be escaped with a backslash (`\`), also (`/`) -must be escaped against the Elasticsearch: - -``` ruby -+ - && | | ! ( ) { } [ ] ^ " ~ * ? : \ / -``` - -For example: - -``` ruby -\(1\+1\)\:2 -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_supermarket_api_summary.md b/www/layouts/shortcodes/ws_supermarket_api_summary.md deleted file mode 100644 index 890f9f86b..000000000 --- a/www/layouts/shortcodes/ws_supermarket_api_summary.md +++ /dev/null @@ -1,7 +0,0 @@ -The Supermarket API is used to provide access to cookbooks, tools, and -users on the [Chef Supermarket](https://supermarket.chef.io). All of the -cookbooks, tools, and users on the Supermarket are accessible through a -RESTful API by accessing `supermarket.chef.io/api/v1/` via the supported -endpoints. In most cases, knife is the best way to interact with the -Supermarket; however in some cases, direct use of the Supermarket API is -necessary. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_test_kitchen.md b/www/layouts/shortcodes/ws_test_kitchen.md deleted file mode 100644 index e4cf1c32a..000000000 --- a/www/layouts/shortcodes/ws_test_kitchen.md +++ /dev/null @@ -1,10 +0,0 @@ -Use [Test Kitchen](https://kitchen.ci/) to automatically test cookbooks -across any combination of platforms and test suites: - -- Test suites are defined in a kitchen.yml file. See the - [configuration](/workstation/config_yml_kitchen/) documentation for options - and syntax information. -- Supports cookbook testing across many cloud providers and - virtualization technologies. -- Uses a comprehensive set of operating system base images from Chef's - [Bento](https://github.com/chef/bento) project. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant.md b/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant.md deleted file mode 100644 index c1e932624..000000000 --- a/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant.md +++ /dev/null @@ -1,4 +0,0 @@ -The `kitchen-vagrant` driver for Kitchen generates a single Vagrantfile -for each instance of Kitchen in a sandboxed directory. The -`kitchen-vagrant` driver supports VirtualBox and VMware Fusion, requires -Vagrant 1.1.0 (or higher), and is the default driver for Test Kitchen. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant_config.md b/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant_config.md deleted file mode 100644 index ce453cf0c..000000000 --- a/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant_config.md +++ /dev/null @@ -1,24 +0,0 @@ -The `kitchen-vagrant` driver can predict the box name for Vagrant and -the download URL that have been published by Chef. For example: - -``` ruby -platforms: -- name: ubuntu-16.04 -- name: ubuntu-18.04 -- name: centos-7 -- name: centos-8 -- name: debian-10 -``` - -which will generate a configuration file similar to: - -``` ruby -platforms: -- name: ubuntu-16.04 - driver: - box: bento/ubuntu-16.04 -- name: ubuntu-18.04 - driver: - box: bento/ubuntu-18.04 -# ... -``` \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant_settings.md b/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant_settings.md deleted file mode 100644 index e875c1d00..000000000 --- a/www/layouts/shortcodes/ws_test_kitchen_driver_vagrant_settings.md +++ /dev/null @@ -1,81 +0,0 @@ -The following attributes are used to configure `kitchen-vagrant` for -Chef: - - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AttributeDescription
boxRequired. Use to specify the box on which Vagrant will run. Default value: computed from the platform name of the instance.
box_check_updateUse to check for box updates. Default value: false.
box_urlUse to specify the URL at which the configured box is located. Default value: computed from the platform name of the instance, but only when the Vagrant provider is VirtualBox- or VMware-based.
communicatorUse to override the config.vm.communicator setting in Vagrant. For example, when a base box is a Microsoft Windows operating system that does not have SSH installed and enabled, Vagrant will not be able to boot without a custom Vagrant file. Default value: nil (assumes SSH is available).
customizeA hash of key-value pairs that define customizations that should be made to the Vagrant virtual machine. For example: customize: memory: 1024 cpuexecutioncap: 50.
guestUse to specify the config.vm.guest setting in the default Vagrantfile.
guiUse to enable the graphical user interface for the defined platform. This is passed to the config.vm.provider setting in Vagrant, but only when the Vagrant provider is VirtualBox- or VMware-based.
networkUse to specify an array of network customizations to be applied to the virtual machine. Default value: []. For example: network: - ["forwarded_port", {guest: 80, host: 8080}] - ["private_network", {ip: "192.168.33.33"}].
pre_create_commandUse to run a command immediately prior to vagrant up --no-provisioner.
providerUse to specify the Vagrant provider. This value must match a provider name in Vagrant.
provisionUse to provision Vagrant when the instance is created. This is useful if the operating system needs customization during provisioning. Default value: false.
ssh_keyUse to specify the private key file used for SSH authentication.
synced_foldersUse to specify a collection of synchronized folders on each Vagrant instance. Source paths are relative to the Kitchen root path. Default value: []. For example: synced_folders: - ["data/%{instance_name}", "/opt/instance_data"] - ["/host_path", "/vm_path", "create: true, type: :nfs"].
vagrantfile_erbUse to specify an alternate Vagrant Embedded Ruby (ERB) template to be used by this driver.
vagrantfilesAn array of paths to one (or more) Vagrant files to be merged with the default Vagrant file. The paths may be absolute or relative to the kitchen.yml file.
vm_hostnameUse to specify the internal hostname for the instance. This is not required when connecting to a Vagrant virtual machine. Set this to false to prevent this value from being rendered in the default Vagrantfile. Default value: computed from the platform name of the instance.
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_test_kitchen_drivers.md b/www/layouts/shortcodes/ws_test_kitchen_drivers.md deleted file mode 100644 index fedf410f7..000000000 --- a/www/layouts/shortcodes/ws_test_kitchen_drivers.md +++ /dev/null @@ -1,83 +0,0 @@ -Test Kitchen uses a driver plugin architecture to enable Test Kitchen to -test instances on cloud providers such as Amazon EC2, Google Compute -Engine, and Microsoft Azure. You can also test on multiple local -hypervisors, such as VMware, Hyper-V, or VirtualBox. - -
- -

Note

- -
- -Chef Workstation includes many common Test Kitchen drivers. - -
- -
- -Most drivers have driver-specific configuration settings that must be -added to the kitchen.yml file before Test Kitchen will be able to use -that platform during cookbook testing. For information about these -driver-specific settings, please refer to the driver-specific -documentation. - -Some popular drivers: - - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Driver PluginDescription
kitchen-azurermA driver for Microsoft Azure.
kitchen-cloudstackA driver for CloudStack.
kitchen-digitaloceanA driver for DigitalOcean. This driver ships in Chef Workstation.
kitchen-dokkenA driver for Docker. This driver ships in Chef Workstation.
kitchen-dscA driver for Windows PowerShell Desired State Configuration (DSC).
kitchen-ec2A driver for Amazon EC2. This driver ships in Chef Workstation.
kitchen-googleA driver for Google Compute Engine. This driver ships in Chef Workstation
kitchen-hypervA driver for Microsoft Hyper-V Server. This driver ships in Chef Workstation.
kitchen-openstackA driver for OpenStack. This driver ships in Chef Workstation.
kitchen-rackspaceA driver for Rackspace.
kitchen-vagrantA driver for HashiCorp Vagrant. This driver ships in Chef Workstation.
\ No newline at end of file diff --git a/www/layouts/shortcodes/ws_test_kitchen_yml.md b/www/layouts/shortcodes/ws_test_kitchen_yml.md deleted file mode 100644 index 0b90559c8..000000000 --- a/www/layouts/shortcodes/ws_test_kitchen_yml.md +++ /dev/null @@ -1,2 +0,0 @@ -Use a kitchen.yml file to define what is required to run Test Kitchen, -including drivers, provisioners, platforms, and test suites. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_test_kitchen_yml_syntax.md b/www/layouts/shortcodes/ws_test_kitchen_yml_syntax.md deleted file mode 100644 index 937ac1917..000000000 --- a/www/layouts/shortcodes/ws_test_kitchen_yml_syntax.md +++ /dev/null @@ -1,116 +0,0 @@ -The basic structure of a kitchen.yml file is as follows: - -``` yaml -driver: - name: driver_name - -provisioner: - name: provisioner_name - -verifier: - name: verifier_name - -transport: - name: transport_name - -platforms: - - name: platform-version - driver: - name: driver_name - - name: platform-version - -suites: - - name: suite_name - run_list: - - recipe[cookbook_name::recipe_name] - attributes: { foo: "bar" } - excludes: - - platform-version - - name: suite_name - driver: - name: driver_name - run_list: - - recipe[cookbook_name::recipe_name] - attributes: { foo: "bar" } - includes: - - platform-version -``` - -where: - -- `driver_name` is the name of a driver that will be used to create - platform instances used during cookbook testing. This is the default - driver used for all platforms and suites **unless** a platform or - suite specifies a `driver` to override the default driver for that - platform or suite; a driver specified for a suite will override a - driver set for a platform - -- `provisioner_name` specifies how Chef Infra Client will be simulated - during testing. `chef_zero` and `chef_solo` are the most common - provisioners used for testing cookbooks - -- `verifier_name` specifies which application to use when running - tests, such as `inspec` - -- `transport_name` specifies which transport to use when executing - commands remotely on the test instance. `winrm` is the default - transport on Windows. The `ssh` transport is the default on all - other operating systems. - -- `platform-version` is the name of a platform on which Test Kitchen - will perform cookbook testing, for example, `ubuntu-16.04` or - `centos-7`; depending on the platform, additional driver - details---for example, instance names and URLs used with cloud - platforms like OpenStack or Amazon EC2---may be required - -- `platforms` may define Chef Infra Server attributes that are common - to the collection of test suites - -- `suites` is a collection of test suites, with each `suite_name` - grouping defining an aspect of a cookbook to be tested. Each - `suite_name` must specify a run-list, for example: - - ``` ruby - run_list: - - recipe[cookbook_name::default] - - recipe[cookbook_name::recipe_name] - ``` - -- Each `suite_name` grouping may specify `attributes` as a Hash: - `{ foo: "bar" }` - -- A `suite_name` grouping may use `excludes` and `includes` to - exclude/include one (or more) platforms. For example: - - ``` ruby - excludes: - - platform-version - - platform-version # for additional platforms - ``` - -For example, a very simple kitchen.yml file: - -``` yaml -driver: - name: vagrant - -provisioner: - name: chef_zero - -platforms: - - name: ubuntu-18.04 - - name: centos-8 - - name: debian-10 - -suites: - - name: default - run_list: - - recipe[apache::httpd] - excludes: - - debian-10 -``` - -This file uses Vagrant as the driver, which requires no additional -configuration because it's the default driver used by Test Kitchen, -chef-zero as the provisioner, and a single (default) test suite that -runs on Ubuntu 16.04, and CentOS 7. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_test_kitchen_yml_syntax_proxy.md b/www/layouts/shortcodes/ws_test_kitchen_yml_syntax_proxy.md deleted file mode 100644 index 584396244..000000000 --- a/www/layouts/shortcodes/ws_test_kitchen_yml_syntax_proxy.md +++ /dev/null @@ -1,43 +0,0 @@ -The environment variables `http_proxy`, `https_proxy`, and `ftp_proxy` -are honored by Test Kitchen for proxies. The client.rb file is read to -look for proxy configuration settings. If `http_proxy`, `https_proxy`, -and `ftp_proxy` are specified in the client.rb file, Chef Infra Client -will configure the `ENV` variable based on these (and related) settings. -For example: - -``` ruby -http_proxy 'http://proxy.example.org:8080' -http_proxy_user 'myself' -http_proxy_pass 'Password1' -``` - -will be set to: - -``` ruby -ENV['http_proxy'] = 'http://myself:Password1@proxy.example.org:8080' -``` - -Test Kitchen also supports `http_proxy` and `https_proxy` in the -`kitchen.yml` file. You can set them manually or have them read from -your local environment variables: - -``` yaml -driver: - name: vagrant - -provisioner: - name: chef_zero - # Set proxy settings manually, or - http_proxy: 'http://user:password@server:port' - https_proxy: 'http://user:password@server:port' - - # Read from local environment variables - http_proxy: <%= ENV['http_proxy'] %> - https_proxy: <%= ENV['https_proxy'] %> -``` - -This will not set the proxy environment variables for applications other -than Chef. The Vagrant plugin, -[vagrant-proxyconf](http://tmatilai.github.io/vagrant-proxyconf/), can -be used to set the proxy environment variables for applications inside -the VM. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_windows_spaces_and_directories.md b/www/layouts/shortcodes/ws_windows_spaces_and_directories.md deleted file mode 100644 index 794441656..000000000 --- a/www/layouts/shortcodes/ws_windows_spaces_and_directories.md +++ /dev/null @@ -1,4 +0,0 @@ -Directories that are used by Chef products on Windows cannot have -spaces. For example, `C:\Users\User Name` will not work, but -`C:\Users\UserName` will. Chef commands may fail if used against a -directory with a space in its name. \ No newline at end of file diff --git a/www/layouts/shortcodes/ws_windows_top_level_directory_names.md b/www/layouts/shortcodes/ws_windows_top_level_directory_names.md deleted file mode 100644 index dc27723b0..000000000 --- a/www/layouts/shortcodes/ws_windows_top_level_directory_names.md +++ /dev/null @@ -1,6 +0,0 @@ -Windows will throw errors when path name lengths are too long. For this -reason, it's often helpful to use a very short top-level directory, much -like what is done in UNIX and Linux. For example, Chef uses `/opt/` to -install Chef Workstation on macOS. A similar approach can be done on -Microsoft Windows, by creating a top-level directory with a short name. -For example: `C:\chef`. \ No newline at end of file From 9fe836bfd6de9b9262569b9de402b36ae44cc279 Mon Sep 17 00:00:00 2001 From: IanMadd Date: Tue, 4 Aug 2020 11:00:09 -0700 Subject: [PATCH 2/7] Remove unneeded templates Signed-off-by: IanMadd --- www/layouts/partials/head.html | 12 --- www/layouts/partials/sidebar-on-canvas.html | 85 --------------------- www/static/css/preview.css | 20 ----- 3 files changed, 117 deletions(-) delete mode 100644 www/layouts/partials/head.html delete mode 100644 www/layouts/partials/sidebar-on-canvas.html delete mode 100644 www/static/css/preview.css diff --git a/www/layouts/partials/head.html b/www/layouts/partials/head.html deleted file mode 100644 index 6a82f2be0..000000000 --- a/www/layouts/partials/head.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - {{ .Title }} - - {{ $options := (dict "includePaths" (slice "node_modules")) }} - {{ $style := resources.Get "sass/main.scss" | resources.ToCSS $options }} - - - \ No newline at end of file diff --git a/www/layouts/partials/sidebar-on-canvas.html b/www/layouts/partials/sidebar-on-canvas.html deleted file mode 100644 index 77369b09a..000000000 --- a/www/layouts/partials/sidebar-on-canvas.html +++ /dev/null @@ -1,85 +0,0 @@ -{{ $currentPage := . }} -{{ $currentSection := $currentPage.Section }} - - diff --git a/www/static/css/preview.css b/www/static/css/preview.css deleted file mode 100644 index 564094457..000000000 --- a/www/static/css/preview.css +++ /dev/null @@ -1,20 +0,0 @@ -#sidebar-nav > .nav > .accordion-menu .nested.is-accordion-submenu .is-accordion-submenu-item a{ - padding-bottom: 0px; -} - -.accordion-menu .is-accordion-submenu-parent:not(.has-submenu-toggle) > a{ - padding-bottom: 0px; -} - -.menu_weight{ - padding: 0 0 12px 20px; - font-size: 10px; -} - -.page_menu_true { - color: green; -} - -.page_menu_false { - color: red; -} \ No newline at end of file From 7bb487046a8e8e7148960c6027112ab7b913f34a Mon Sep 17 00:00:00 2001 From: IanMadd Date: Tue, 4 Aug 2020 11:03:53 -0700 Subject: [PATCH 3/7] Change shortcode references in docs Signed-off-by: IanMadd --- www/content/workstation/_index.md | 2 +- www/content/workstation/chef_shell.md | 26 +++---- www/content/workstation/chefspec.md | 2 +- www/content/workstation/config_rb.md | 2 +- www/content/workstation/config_yml_kitchen.md | 16 ++-- www/content/workstation/ctl_kitchen.md | 24 +++--- .../workstation/ctl_push_jobs_client.md | 4 +- www/content/workstation/getting_started.md | 2 +- .../workstation/install_workstation.md | 4 +- www/content/workstation/kitchen.md | 14 ++-- www/content/workstation/knife.md | 56 ++++++------- www/content/workstation/knife_azure.md | 2 +- www/content/workstation/knife_azurerm.md | 2 +- www/content/workstation/knife_bootstrap.md | 14 ++-- www/content/workstation/knife_client.md | 8 +- www/content/workstation/knife_configure.md | 6 +- www/content/workstation/knife_cookbook.md | 28 +++---- .../workstation/knife_cookbook_site.md | 12 +-- www/content/workstation/knife_data_bag.md | 22 +++--- www/content/workstation/knife_delete.md | 6 +- www/content/workstation/knife_deps.md | 6 +- www/content/workstation/knife_diff.md | 6 +- www/content/workstation/knife_download.md | 6 +- www/content/workstation/knife_edit.md | 8 +- www/content/workstation/knife_environment.md | 10 +-- www/content/workstation/knife_exec.md | 6 +- www/content/workstation/knife_list.md | 6 +- www/content/workstation/knife_node.md | 52 ++++++------- www/content/workstation/knife_raw.md | 6 +- www/content/workstation/knife_recipe_list.md | 4 +- www/content/workstation/knife_role.md | 12 +-- www/content/workstation/knife_search.md | 78 +++++++++---------- www/content/workstation/knife_serve.md | 4 +- www/content/workstation/knife_setup.md | 2 +- www/content/workstation/knife_show.md | 4 +- www/content/workstation/knife_ssh.md | 6 +- www/content/workstation/knife_ssl_check.md | 6 +- www/content/workstation/knife_ssl_fetch.md | 4 +- www/content/workstation/knife_status.md | 10 +-- www/content/workstation/knife_supermarket.md | 4 +- www/content/workstation/knife_tag.md | 6 +- www/content/workstation/knife_upload.md | 6 +- www/content/workstation/knife_user.md | 8 +- www/content/workstation/knife_windows.md | 4 +- www/content/workstation/knife_xargs.md | 6 +- .../workstation/plugin_kitchen_vagrant.md | 6 +- 46 files changed, 264 insertions(+), 264 deletions(-) diff --git a/www/content/workstation/_index.md b/www/content/workstation/_index.md index 3a632c159..831a05866 100644 --- a/www/content/workstation/_index.md +++ b/www/content/workstation/_index.md @@ -14,7 +14,7 @@ aliases = ["/about_workstation.html", "/about_chefdk.html", "/chef_dk.html", "/a [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/_index.md) -{{% ws_chef_workstation %}} +{{% chef_workstation %}} Chef Workstation replaces ChefDK, combining all the existing features with new features, such as ad-hoc task support and the new Chef diff --git a/www/content/workstation/chef_shell.md b/www/content/workstation/chef_shell.md index 86a3c53a0..e52bd04ec 100644 --- a/www/content/workstation/chef_shell.md +++ b/www/content/workstation/chef_shell.md @@ -14,13 +14,13 @@ aliases = ["/chef_shell.html", "/chef_shell/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/ctl_chef_shell.md) -{{% ws_chef_shell_summary %}} +{{% chef_shell_summary %}} The chef-shell executable is run as a command-line tool. ## Modes -{{% ws_chef_shell_modes %}} +{{% chef_shell_modes %}} ## Options @@ -67,7 +67,7 @@ This command has the following options: {{< warning >}} - {{% ws_node_ctl_attribute %}} + {{% node_ctl_attribute %}} {{< /warning >}} @@ -98,35 +98,35 @@ This command has the following options: ## Configure -{{% ws_chef_shell_config %}} +{{% chef_shell_config %}} ### chef-shell.rb -{{% ws_chef_shell_config_rb %}} +{{% chef_shell_config_rb %}} ### Run as a Chef Infra Client -{{% ws_chef_shell_run_as_chef_client %}} +{{% chef_shell_run_as_chef_client %}} ## Debugging Cookbooks -{{% ws_chef_shell_breakpoints %}} +{{% chef_shell_breakpoints %}} ### Step Through Run-list -{{% ws_chef_shell_step_through_run_list %}} +{{% chef_shell_step_through_run_list %}} ### Debug Existing Recipe -{{< readFile_shortcode file="ws_chef_shell_debug_existing_recipe.md" >}} +{{< readFile_shortcode file="chef_shell_debug_existing_recipe.md" >}} ### Advanced Debugging -{{< readFile_shortcode file="ws_chef_shell_advanced_debug.md" >}} +{{< readFile_shortcode file="chef_shell_advanced_debug.md" >}} ## Manipulating Chef Infra Server Data -{{% ws_chef_shell_manage %}} +{{% chef_shell_manage %}} ## Examples @@ -134,8 +134,8 @@ The following examples show how to use chef-shell. ### "Hello World" -{{< readFile_shortcode file="ws_chef_shell_example_hello_world.md" >}} +{{< readFile_shortcode file="chef_shell_example_hello_world.md" >}} ### Get Specific Nodes -{{% ws_chef_shell_example_get_specific_nodes %}} +{{% chef_shell_example_get_specific_nodes %}} diff --git a/www/content/workstation/chefspec.md b/www/content/workstation/chefspec.md index 3e59616fe..dae625e45 100644 --- a/www/content/workstation/chefspec.md +++ b/www/content/workstation/chefspec.md @@ -14,7 +14,7 @@ aliases = ["/chefspec.html", "/chefspec/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/chefspec.md) -{{% ws_chefspec_summary %}} +{{% chefspec_summary %}} ChefSpec is a framework that tests resources and recipes as part of a simulated Chef Infra Client run. ChefSpec tests execute very quickly. diff --git a/www/content/workstation/config_rb.md b/www/content/workstation/config_rb.md index 1e97d7a6f..6a4915415 100644 --- a/www/content/workstation/config_rb.md +++ b/www/content/workstation/config_rb.md @@ -362,7 +362,7 @@ Use the following setting to specify URLs that do not need a proxy: ## .d Directories -{{% ws_config_rb_client_dot_d_directories %}} +{{% config_rb_client_dot_d_directories %}} ## Optional Settings diff --git a/www/content/workstation/config_yml_kitchen.md b/www/content/workstation/config_yml_kitchen.md index af6a620cb..a2ab99db5 100644 --- a/www/content/workstation/config_yml_kitchen.md +++ b/www/content/workstation/config_yml_kitchen.md @@ -26,7 +26,7 @@ data across any combination of platforms and test suites: - Uses a comprehensive set of base images provided by [Bento](https://github.com/chef/bento) -{{% ws_test_kitchen_yml %}} +{{% test_kitchen_yml %}} {{< note >}} @@ -38,7 +38,7 @@ about Test Kitchen. ## Syntax -{{% ws_test_kitchen_yml_syntax %}} +{{% test_kitchen_yml_syntax %}} ## Provisioner Settings @@ -430,7 +430,7 @@ kitchen.yml file when the transport is WinRM: ### Work with Proxies -{{< readFile_shortcode file="ws_test_kitchen_yml_syntax_proxy.md" >}} +{{< readFile_shortcode file="test_kitchen_yml_syntax_proxy.md" >}} ## Chef Infra Client Settings @@ -493,19 +493,19 @@ Specific `optional_settings: values` may be specified. ### Bento -{{% ws_bento %}} +{{% bento %}} ### Drivers -{{% ws_test_kitchen_drivers %}} +{{% test_kitchen_drivers %}} ### kitchen-vagrant -{{% ws_test_kitchen_driver_vagrant %}} +{{% test_kitchen_driver_vagrant %}} -{{% ws_test_kitchen_driver_vagrant_settings %}} +{{% test_kitchen_driver_vagrant_settings %}} -{{% ws_test_kitchen_driver_vagrant_config %}} +{{% test_kitchen_driver_vagrant_config %}} ## Examples diff --git a/www/content/workstation/ctl_kitchen.md b/www/content/workstation/ctl_kitchen.md index af6792d74..18e53836e 100644 --- a/www/content/workstation/ctl_kitchen.md +++ b/www/content/workstation/ctl_kitchen.md @@ -14,7 +14,7 @@ aliases = ["/ctl_kitchen.html", "/ctl_kitchen/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/ctl_kitchen.md) -{{% ws_ctl_kitchen_summary %}} +{{% ctl_kitchen_summary %}} {{< note >}} @@ -145,7 +145,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -301,7 +301,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -433,7 +433,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -483,7 +483,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -642,7 +642,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -696,7 +696,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -759,7 +759,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -847,7 +847,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -901,7 +901,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -964,7 +964,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples @@ -1095,7 +1095,7 @@ This subcommand has the following options: platforms. Use a Ruby regular expression to glob two or more platforms into a single run. - {{< readFile_shortcode file="ws_ctl_kitchen_common_option_platforms.md" >}} + {{< readFile_shortcode file="ctl_kitchen_common_option_platforms.md" >}} ### Examples diff --git a/www/content/workstation/ctl_push_jobs_client.md b/www/content/workstation/ctl_push_jobs_client.md index 3343d9f1d..d368b8adb 100644 --- a/www/content/workstation/ctl_push_jobs_client.md +++ b/www/content/workstation/ctl_push_jobs_client.md @@ -14,9 +14,9 @@ aliases = ["/ctl_push_jobs_client.html", "/ctl_push_jobs_client/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/ctl_push_jobs_client.md) -{{% ws_push_jobs_summary %}} +{{% push_jobs_summary %}} -{{% ws_ctl_push_jobs_client_summary %}} +{{% ctl_push_jobs_client_summary %}} ## Options diff --git a/www/content/workstation/getting_started.md b/www/content/workstation/getting_started.md index 1bef406ca..5137d7171 100644 --- a/www/content/workstation/getting_started.md +++ b/www/content/workstation/getting_started.md @@ -99,7 +99,7 @@ On Microsoft Windows, `C:/opscode/Chef Workstation/bin` must be before ## Create the Chef repository -Use [the chef generate repo](/ctl_chef/#chef-generate-repo) to +Use [the chef generate repo]({{< relref "ctl_chef.md#chef-generate-repo" >}}) to create the Chef repository. For example, to create a repository called `chef-repo`: diff --git a/www/content/workstation/install_workstation.md b/www/content/workstation/install_workstation.md index 2a6705d5f..04f093e68 100644 --- a/www/content/workstation/install_workstation.md +++ b/www/content/workstation/install_workstation.md @@ -135,11 +135,11 @@ Alternately, install Chef Workstation using Homebrew: #### Spaces and Directories -{{% ws_windows_spaces_and_directories %}} +{{% windows_spaces_and_directories %}} #### Top-level Directory Names -{{% ws_windows_top_level_directory_names %}} +{{% windows_top_level_directory_names %}} ### Linux diff --git a/www/content/workstation/kitchen.md b/www/content/workstation/kitchen.md index cc0e434d1..ae0a64c14 100644 --- a/www/content/workstation/kitchen.md +++ b/www/content/workstation/kitchen.md @@ -14,7 +14,7 @@ aliases = ["/kitchen.html", "/kitchen/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/kitchen.md) -{{% ws_test_kitchen %}} +{{% test_kitchen %}} The key concepts in Test Kitchen are: @@ -36,11 +36,11 @@ The key concepts in Test Kitchen are: ## Bento -{{% ws_bento %}} +{{% bento %}} ## Drivers -{{% ws_test_kitchen_drivers %}} +{{% test_kitchen_drivers %}} ## Validation with InSpec @@ -53,7 +53,7 @@ converged cookbook for easy local validation of your infrastructure. ## kitchen (executable) -{{% ws_ctl_kitchen_summary %}} +{{% ctl_kitchen_summary %}} {{< note >}} @@ -64,7 +64,7 @@ For more information about the `kitchen` command line tool, see ## kitchen.yml -{{% ws_test_kitchen_yml %}} +{{% test_kitchen_yml %}} {{< note >}} @@ -75,11 +75,11 @@ For more information about the kitchen.yml file, see ### Syntax -{{% ws_test_kitchen_yml_syntax %}} +{{% test_kitchen_yml_syntax %}} ### Work with Proxies -{{< readFile_shortcode file="ws_test_kitchen_yml_syntax_proxy.md" >}} +{{< readFile_shortcode file="test_kitchen_yml_syntax_proxy.md" >}} ## For more information ... diff --git a/www/content/workstation/knife.md b/www/content/workstation/knife.md index ebcf0f02e..90a8c4ea4 100644 --- a/www/content/workstation/knife.md +++ b/www/content/workstation/knife.md @@ -104,103 +104,103 @@ organization. knife_bootstrap -{{% ws_knife_bootstrap_summary %}} +{{% knife_bootstrap_summary %}} knife_client -{{% ws_knife_client_summary %}} +{{% knife_client_summary %}} knife configure -{{% ws_knife_configure_summary %}} +{{% knife_configure_summary %}} knife cookbook -{{% ws_knife_cookbook_summary %}} +{{% knife_cookbook_summary %}} knife data bag -{{% ws_knife_data_bag_summary %}} +{{% knife_data_bag_summary %}} knife delete -{{% ws_knife_delete_summary %}} +{{% knife_delete_summary %}} knife deps -{{% ws_knife_deps_summary %}} +{{% knife_deps_summary %}} knife diff -{{% ws_knife_diff_summary %}} +{{% knife_diff_summary %}} knife download -{{% ws_knife_download_summary %}} +{{% knife_download_summary %}} knife edit -{{% ws_knife_edit_summary %}} +{{% knife_edit_summary %}} knife environment -{{% ws_knife_environment_summary %}} +{{% knife_environment_summary %}} knife exec -{{% ws_knife_exec_summary %}} +{{% knife_exec_summary %}} knife list -{{% ws_knife_list_summary %}} +{{% knife_list_summary %}} knife node -{{% ws_knife_node_summary %}} +{{% knife_node_summary %}} knife raw -{{% ws_knife_raw_summary %}} +{{% knife_raw_summary %}} knife recipe list -{{% ws_knife_recipe_list_summary %}} +{{% knife_recipe_list_summary %}} knife role -{{% ws_knife_role_summary %}} +{{% knife_role_summary %}} knife search -{{% ws_knife_search_summary %}} +{{% knife_search_summary %}} knife serve -{{% ws_knife_serve_summary %}} +{{% knife_serve_summary %}} knife show -{{% ws_knife_show_summary %}} +{{% knife_show_summary %}} knife ssh -{{% ws_knife_ssh_summary %}} +{{% knife_ssh_summary %}} knife ssl check -{{% ws_knife_ssl_check_summary %}} +{{% knife_ssl_check_summary %}} knife ssl fetch -{{% ws_knife_ssl_fetch_summary %}} +{{% knife_ssl_fetch_summary %}} knife status -{{% ws_knife_status_summary %}} +{{% knife_status_summary %}} knife tag -{{% ws_knife_tag_summary %}} +{{% knife_tag_summary %}} knife supermarket @@ -208,15 +208,15 @@ organization. knife upload -{{% ws_knife_upload_summary %}} +{{% knife_upload_summary %}} knife user -{{% ws_knife_user_summary %}} +{{% knife_user_summary %}} knife xargs -{{% ws_knife_xargs_summary %}} +{{% knife_xargs_summary %}} diff --git a/www/content/workstation/knife_azure.md b/www/content/workstation/knife_azure.md index 7ccdb24fd..6345f2fac 100644 --- a/www/content/workstation/knife_azure.md +++ b/www/content/workstation/knife_azure.md @@ -15,7 +15,7 @@ aliases = ["/knife_azure.html", "/knife_azure/"] ## Knife Azure Overview -{{% ws_knife_azure %}} +{{% knife_azure %}} {{< note >}} diff --git a/www/content/workstation/knife_azurerm.md b/www/content/workstation/knife_azurerm.md index d768d9cf3..6dfa9377b 100644 --- a/www/content/workstation/knife_azurerm.md +++ b/www/content/workstation/knife_azurerm.md @@ -15,7 +15,7 @@ aliases = ["/knife_azurerm.html", "/knife_azurerm/"] ## Knife Azure Overview -{{% ws_knife_azure %}} +{{% knife_azure %}} {{< note >}} diff --git a/www/content/workstation/knife_bootstrap.md b/www/content/workstation/knife_bootstrap.md index 03f810df2..a53e483e5 100644 --- a/www/content/workstation/knife_bootstrap.md +++ b/www/content/workstation/knife_bootstrap.md @@ -13,9 +13,9 @@ aliases = ["/knife_bootstrap.html", "/knife_bootstrap/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_bootstrap.md) -{{% ws_chef_client_bootstrap_node %}} +{{% chef_client_bootstrap_node %}} -{{% ws_knife_bootstrap_summary %}} +{{% knife_bootstrap_summary %}} **Considerations:** @@ -49,7 +49,7 @@ knife bootstrap FQDN_or_IP_ADDRESS (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -335,13 +335,13 @@ knife bootstrap FQDN_or_IP_ADDRESS (options) {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} ### Validatorless Bootstrap -{{% ws_knife_bootstrap_no_validator %}} +{{% knife_bootstrap_no_validator %}} {{< note >}} @@ -351,11 +351,11 @@ The `--node-name` option is required for a validatorless bootstrap. ### FIPS Mode -{{% ws_fips_intro_client %}} +{{% fips_intro_client %}} **Bootstrap a node using FIPS** -{{% ws_knife_bootstrap_node_fips %}} +{{% knife_bootstrap_node_fips %}} ## Custom Templates diff --git a/www/content/workstation/knife_client.md b/www/content/workstation/knife_client.md index c7e9f4386..7f31df2ca 100644 --- a/www/content/workstation/knife_client.md +++ b/www/content/workstation/knife_client.md @@ -13,11 +13,11 @@ aliases = ["/knife_client.html", "/knife_client/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_client.md) -{{% ws_knife_client_summary %}} +{{% knife_client_summary %}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -111,7 +111,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -434,7 +434,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_configure.md b/www/content/workstation/knife_configure.md index 1a3056268..7db8490e8 100644 --- a/www/content/workstation/knife_configure.md +++ b/www/content/workstation/knife_configure.md @@ -13,7 +13,7 @@ aliases = ["/knife_configure.html", "/knife_configure/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_configure.md) -{{% ws_knife_configure_summary %}} +{{% knife_configure_summary %}} ## Syntax @@ -33,7 +33,7 @@ knife configure client DIRECTORY {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -70,7 +70,7 @@ config.rb file: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_cookbook.md b/www/content/workstation/knife_cookbook.md index c863e5cdc..7a11c1a29 100644 --- a/www/content/workstation/knife_cookbook.md +++ b/www/content/workstation/knife_cookbook.md @@ -13,13 +13,13 @@ aliases = ["/knife_cookbook.html", "/knife_cookbook/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_cookbook.md) -{{% ws_cookbooks_summary %}} +{{% cookbooks_summary %}} -{{% ws_knife_cookbook_summary %}} +{{% knife_cookbook_summary %}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -51,7 +51,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -73,13 +73,13 @@ knife cookbook bulk delete "^[0-9]{3}$" -p {{< note >}} This command was removed in Chef Client 13.0. Use the [chef generate -cookbook](/ctl_chef/#chef-generate-cookbook) command instead. +cookbook]({{< relref "ctl_chef.md#chef-generate-repo" >}}) command instead. {{< /note >}} {{< note >}} -{{% ws_ruby_style_patterns_hyphens %}} +{{% ruby_style_patterns_hyphens %}} {{< /note >}} @@ -132,7 +132,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -195,7 +195,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -248,7 +248,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -292,7 +292,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -336,7 +336,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -431,7 +431,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -548,7 +548,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -633,7 +633,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_cookbook_site.md b/www/content/workstation/knife_cookbook_site.md index 421b53edc..93df774a2 100644 --- a/www/content/workstation/knife_cookbook_site.md +++ b/www/content/workstation/knife_cookbook_site.md @@ -13,7 +13,7 @@ aliases = ["/knife_cookbook_site.html", "/knife_cookbook_site/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_cookbook_site.md) -{{% ws_supermarket_api_summary %}} +{{% supermarket_api_summary %}} Use the `knife cookbook site` subcommand to interact with cookbooks that are available in the [Chef Supermarket](https://supermarket.chef.io/). A @@ -30,13 +30,13 @@ supermarket](/workstation/knife_supermarket/) command. {{< warning >}} -{{% ws_notes_knife_cookbook_site_use_devkit_berkshelf %}} +{{% notes_knife_cookbook_site_use_devkit_berkshelf %}} {{< /warning >}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -96,7 +96,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -186,7 +186,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -398,7 +398,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_data_bag.md b/www/content/workstation/knife_data_bag.md index d03b93959..44c2343af 100644 --- a/www/content/workstation/knife_data_bag.md +++ b/www/content/workstation/knife_data_bag.md @@ -13,15 +13,15 @@ aliases = ["/knife_data_bag.html", "/knife_data_bag/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_data_bag.md) -{{% ws_data_bag %}} +{{% data_bag %}} -{{% ws_data_bag_encryption %}} +{{% data_bag_encryption %}} -{{% ws_knife_data_bag_summary %}} +{{% knife_data_bag_summary %}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -61,7 +61,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -126,7 +126,7 @@ Type `Y` to confirm a deletion. ## edit -{{% ws_knife_data_bag_edit %}} +{{% knife_data_bag_edit %}} ### Syntax @@ -164,7 +164,7 @@ For encrypted data bag items, use *either* `--secret` or {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -203,7 +203,7 @@ save them. **Edit a data bag item** -{{% ws_knife_data_bag_edit_item %}} +{{% knife_data_bag_edit_item %}} ## from file @@ -255,7 +255,7 @@ For encrypted data bag items, use *either* `--secret` or {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -283,7 +283,7 @@ knife data bag from file devops_data --secret-file "path to decryption file" **Create an encrypted data bag for use with Chef Infra Client local mode** -{{% ws_knife_data_bag_from_file_create_encrypted_local_mode %}} +{{% knife_data_bag_from_file_create_encrypted_local_mode %}} ## list @@ -356,7 +356,7 @@ For encrypted data bag items, use *either* `--secret` or {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_delete.md b/www/content/workstation/knife_delete.md index 307f7db0c..d8177fc18 100644 --- a/www/content/workstation/knife_delete.md +++ b/www/content/workstation/knife_delete.md @@ -13,7 +13,7 @@ aliases = ["/knife_delete.html", "/knife_delete/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_delete.md) -{{% ws_knife_delete_summary %}} +{{% knife_delete_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife delete [PATTERN...] (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -67,7 +67,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_deps.md b/www/content/workstation/knife_deps.md index aa59e1b80..cfe21f188 100644 --- a/www/content/workstation/knife_deps.md +++ b/www/content/workstation/knife_deps.md @@ -13,7 +13,7 @@ aliases = ["/knife_deps.html", "/knife_deps/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_deps.md) -{{% ws_knife_deps_summary %}} +{{% knife_deps_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife deps (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -69,7 +69,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_diff.md b/www/content/workstation/knife_diff.md index c668b7dae..9a1a415f6 100644 --- a/www/content/workstation/knife_diff.md +++ b/www/content/workstation/knife_diff.md @@ -13,7 +13,7 @@ aliases = ["/knife_diff.html", "/knife_diff/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_diff.md) -{{% ws_knife_diff_summary %}} +{{% knife_diff_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife diff [PATTERN...] (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -79,7 +79,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_download.md b/www/content/workstation/knife_download.md index a94baf552..7167ef19a 100644 --- a/www/content/workstation/knife_download.md +++ b/www/content/workstation/knife_download.md @@ -13,7 +13,7 @@ aliases = ["/knife_download.html", "/knife_download/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_download.md) -{{% ws_knife_download_summary %}} +{{% knife_download_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife download [PATTERN...] (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -86,7 +86,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_edit.md b/www/content/workstation/knife_edit.md index 600e0c4f6..dee1956a2 100644 --- a/www/content/workstation/knife_edit.md +++ b/www/content/workstation/knife_edit.md @@ -13,7 +13,7 @@ aliases = ["/knife_edit.html", "/knife_edit/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_edit.md) -{{% ws_knife_edit_summary %}} +{{% knife_edit_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife edit (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -58,7 +58,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -68,4 +68,4 @@ The following examples show how to use this knife subcommand: **Remove a user from /groups/admins.json** -{{% ws_knife_edit_admin_users %}} +{{% knife_edit_admin_users %}} diff --git a/www/content/workstation/knife_environment.md b/www/content/workstation/knife_environment.md index 778c9fd2c..0db424771 100644 --- a/www/content/workstation/knife_environment.md +++ b/www/content/workstation/knife_environment.md @@ -13,13 +13,13 @@ aliases = ["/knife_environment.html", "/knife_environment/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_environment.md) -{{% ws_environment %}} +{{% environment %}} -{{% ws_knife_environment_summary %}} +{{% knife_environment_summary %}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -155,7 +155,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -257,7 +257,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_exec.md b/www/content/workstation/knife_exec.md index ff68a53b7..aa1b51a09 100644 --- a/www/content/workstation/knife_exec.md +++ b/www/content/workstation/knife_exec.md @@ -13,7 +13,7 @@ aliases = ["/knife_exec.html", "/knife_exec/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_exec.md) -{{% ws_knife_exec_summary %}} +{{% knife_exec_summary %}} ## Authenticated API Requests @@ -125,7 +125,7 @@ knife exec SCRIPT (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -144,7 +144,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_list.md b/www/content/workstation/knife_list.md index 071850780..c292818f3 100644 --- a/www/content/workstation/knife_list.md +++ b/www/content/workstation/knife_list.md @@ -13,7 +13,7 @@ aliases = ["/knife_list.html", "/knife_list/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_list.md) -{{% ws_knife_list_summary %}} +{{% knife_list_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife list [PATTERN...] (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -79,7 +79,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_node.md b/www/content/workstation/knife_node.md index 906d4f944..47873e994 100644 --- a/www/content/workstation/knife_node.md +++ b/www/content/workstation/knife_node.md @@ -13,13 +13,13 @@ aliases = ["/knife_node.html", "/knife_node/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_node.md) -{{% ws_node %}} +{{% node %}} -{{% ws_knife_node_summary %}} +{{% knife_node_summary %}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -276,7 +276,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -323,35 +323,35 @@ knife node policy set test-node 'test-group' 'test-name' ## run_list add -{{% ws_node_run_list %}} +{{% node_run_list %}} -{{% ws_knife_node_run_list_add %}} +{{% knife_node_run_list_add %}} -{{% ws_node_run_list_format %}} +{{% node_run_list_format %}} ### Syntax -{{% ws_knife_node_run_list_add_syntax %}} +{{% knife_node_run_list_add_syntax %}} {{< warning >}} -{{% ws_knife_common_windows_quotes %}} +{{% knife_common_windows_quotes %}} {{< /warning >}} {{< note >}} -{{% ws_knife_common_windows_quotes_module %}} +{{% knife_common_windows_quotes_module %}} {{< /note >}} ### Options -{{% ws_knife_node_run_list_add_options %}} +{{% knife_node_run_list_add_options %}} {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -361,31 +361,31 @@ The following examples show how to use this knife subcommand: **Add a role** -{{% ws_knife_node_run_list_add_role %}} +{{% knife_node_run_list_add_role %}} **Add roles and recipes** -{{% ws_knife_node_run_list_add_roles_and_recipes %}} +{{% knife_node_run_list_add_roles_and_recipes %}} **Add a recipe with a FQDN** -{{% ws_knife_node_run_list_add_recipe_with_fqdn %}} +{{% knife_node_run_list_add_recipe_with_fqdn %}} **Add a recipe with a cookbook** -{{% ws_knife_node_run_list_add_recipe_with_cookbook %}} +{{% knife_node_run_list_add_recipe_with_cookbook %}} **Add the default recipe** -{{% ws_knife_node_run_list_add_default_recipe %}} +{{% knife_node_run_list_add_default_recipe %}} ## run_list remove -{{% ws_knife_node_run_list_remove %}} +{{% knife_node_run_list_remove %}} ### Syntax -{{% ws_knife_node_run_list_remove_syntax %}} +{{% knife_node_run_list_remove_syntax %}} ### Options @@ -393,7 +393,7 @@ This command does not have any specific options. {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -403,29 +403,29 @@ The following examples show how to use this knife subcommand: **Remove a role** -{{% ws_knife_node_run_list_remove_role %}} +{{% knife_node_run_list_remove_role %}} **Remove a run-list** -{{% ws_knife_node_run_list_remove_run_list %}} +{{% knife_node_run_list_remove_run_list %}} ## run_list set -{{% ws_knife_node_run_list_set %}} +{{% knife_node_run_list_set %}} ### Syntax -{{% ws_knife_node_run_list_set_syntax %}} +{{% knife_node_run_list_set_syntax %}} {{< warning >}} -{{% ws_knife_common_windows_quotes %}} +{{% knife_common_windows_quotes %}} {{< /warning >}} {{< note >}} -{{% ws_knife_common_windows_quotes_module %}} +{{% knife_common_windows_quotes_module %}} {{< /note >}} diff --git a/www/content/workstation/knife_raw.md b/www/content/workstation/knife_raw.md index ab826b796..5e1e73c29 100644 --- a/www/content/workstation/knife_raw.md +++ b/www/content/workstation/knife_raw.md @@ -13,7 +13,7 @@ aliases = ["/knife_raw.html", "/knife_raw/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_raw.md) -{{% ws_knife_raw_summary %}} +{{% knife_raw_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife raw REQUEST_PATH (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -54,7 +54,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_recipe_list.md b/www/content/workstation/knife_recipe_list.md index 229c028d0..1af69d631 100644 --- a/www/content/workstation/knife_recipe_list.md +++ b/www/content/workstation/knife_recipe_list.md @@ -13,7 +13,7 @@ aliases = ["/knife_recipe_list.html", "/knife_recipe_list/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_recipe_list.md) -{{% ws_knife_recipe_list_summary %}} +{{% knife_recipe_list_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife recipe list REGEX {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} diff --git a/www/content/workstation/knife_role.md b/www/content/workstation/knife_role.md index d15cbc17b..b19f35b37 100644 --- a/www/content/workstation/knife_role.md +++ b/www/content/workstation/knife_role.md @@ -13,9 +13,9 @@ aliases = ["/knife_role.html", "/knife_role/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_role.md) -{{% ws_role %}} +{{% role %}} -{{% ws_knife_role_summary %}} +{{% knife_role_summary %}} {{< note >}} @@ -27,7 +27,7 @@ argument. {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -86,7 +86,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -219,7 +219,7 @@ This command does not have any specific options. {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -291,7 +291,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_search.md b/www/content/workstation/knife_search.md index 413a2dde2..4ab636f3a 100644 --- a/www/content/workstation/knife_search.md +++ b/www/content/workstation/knife_search.md @@ -13,9 +13,9 @@ aliases = ["/knife_search.html", "/knife_search/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_search.md) -{{% ws_search %}} +{{% search %}} -{{% ws_knife_search_summary %}} +{{% knife_search_summary %}} ## Syntax @@ -73,11 +73,11 @@ knife search node "tags:*ubuntu* OR roles:*ubuntu* OR fqdn:*ubuntu* (etc.)" ### Query Syntax -{{% ws_search_query_syntax %}} +{{% search_query_syntax %}} ### Keys -{{% ws_search_key %}} +{{% search_key %}} To search for the available fields for a particular object, use the `show` argument with any of the following knife subcommands: @@ -86,81 +86,81 @@ To search for the available fields for a particular object, use the #### Nested Fields -{{% ws_search_key_nested %}} +{{% search_key_nested %}} #### Examples -{{% ws_search_key_name %}} +{{% search_key_name %}} -{{% ws_search_key_wildcard_question_mark %}} +{{% search_key_wildcard_question_mark %}} -{{% ws_search_key_wildcard_asterisk %}} +{{% search_key_wildcard_asterisk %}} -{{% ws_search_key_nested_starting_with %}} +{{% search_key_nested_starting_with %}} -{{% ws_search_key_nested_range %}} +{{% search_key_nested_range %}} ### About Patterns -{{% ws_search_pattern %}} +{{% search_pattern %}} #### Exact Matching -{{% ws_search_pattern_exact %}} +{{% search_pattern_exact %}} -{{% ws_search_pattern_exact_key_and_item %}} +{{% search_pattern_exact_key_and_item %}} -{{% ws_search_pattern_exact_key_and_item_string %}} +{{% search_pattern_exact_key_and_item_string %}} #### Wildcard Matching -{{% ws_search_pattern_wildcard %}} +{{% search_pattern_wildcard %}} -{{% ws_search_pattern_wildcard_any_node %}} +{{% search_pattern_wildcard_any_node %}} -{{% ws_search_pattern_wildcard_node_contains %}} +{{% search_pattern_wildcard_node_contains %}} #### Range Matching -{{% ws_search_pattern_range %}} +{{% search_pattern_range %}} -{{% ws_search_pattern_range_in_between %}} +{{% search_pattern_range_in_between %}} -{{% ws_search_pattern_range_exclusive %}} +{{% search_pattern_range_exclusive %}} #### Fuzzy Matching -{{% ws_search_pattern_fuzzy %}} +{{% search_pattern_fuzzy %}} -{{% ws_search_pattern_fuzzy_summary %}} +{{% search_pattern_fuzzy_summary %}} ### About Operators -{{% ws_search_boolean_operators %}} +{{% search_boolean_operators %}} -{{% ws_search_boolean_operators_andnot %}} +{{% search_boolean_operators_andnot %}} #### AND -{{% ws_search_boolean_and %}} +{{% search_boolean_and %}} #### NOT -{{% ws_search_boolean_not %}} +{{% search_boolean_not %}} #### OR -{{% ws_search_boolean_or %}} +{{% search_boolean_or %}} ### Special Characters -{{% ws_search_special_characters %}} +{{% search_special_characters %}} ## Options {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -222,40 +222,40 @@ The following examples show how to use this knife subcommand: **Search by platform ID** -{{% ws_knife_search_by_platform_ids %}} +{{% knife_search_by_platform_ids %}} **Search by instance type** -{{% ws_knife_search_by_platform_instance_type %}} +{{% knife_search_by_platform_instance_type %}} **Search by recipe** -{{% ws_knife_search_by_recipe %}} +{{% knife_search_by_recipe %}} **Search by cookbook, then recipe** -{{% ws_knife_search_by_cookbook %}} +{{% knife_search_by_cookbook %}} **Search by node** -{{% ws_knife_search_by_node %}} +{{% knife_search_by_node %}} **Search by node and environment** -{{% ws_knife_search_by_node_and_environment %}} +{{% knife_search_by_node_and_environment %}} **Search for nested attributes** -{{% ws_knife_search_by_nested_attribute %}} +{{% knife_search_by_nested_attribute %}} **Search for multiple attributes** -{{% ws_knife_search_by_query_for_many_attributes %}} +{{% knife_search_by_query_for_many_attributes %}} **Search for nested attributes using a search query** -{{% ws_knife_search_by_query_for_nested_attribute %}} +{{% knife_search_by_query_for_nested_attribute %}} **Use a test query** -{{% ws_knife_search_test_query_for_ssh %}} +{{% knife_search_test_query_for_ssh %}} diff --git a/www/content/workstation/knife_serve.md b/www/content/workstation/knife_serve.md index 6d82132a5..67d80ddba 100644 --- a/www/content/workstation/knife_serve.md +++ b/www/content/workstation/knife_serve.md @@ -13,7 +13,7 @@ aliases = ["/knife_serve.html", "/knife_serve/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_serve.md) -{{% ws_knife_serve_summary %}} +{{% knife_serve_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife serve (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} diff --git a/www/content/workstation/knife_setup.md b/www/content/workstation/knife_setup.md index 5720259d2..536a8b81c 100644 --- a/www/content/workstation/knife_setup.md +++ b/www/content/workstation/knife_setup.md @@ -55,7 +55,7 @@ this path needs to be scripted, use `%USERPROFILE%\chef-repo\.chef`. ### config.rb Configuration Within a Chef Repository -{{% ws_chef_repo_many_users_same_knife %}} +{{% chef_repo_many_users_same_knife %}} ## Generating a config.rb File diff --git a/www/content/workstation/knife_show.md b/www/content/workstation/knife_show.md index 815461b55..ec19bd70f 100644 --- a/www/content/workstation/knife_show.md +++ b/www/content/workstation/knife_show.md @@ -13,7 +13,7 @@ aliases = ["/knife_show.html", "/knife_show/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_show.md) -{{% ws_knife_show_summary %}} +{{% knife_show_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife show [PATTERN...] (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} diff --git a/www/content/workstation/knife_ssh.md b/www/content/workstation/knife_ssh.md index 317de4252..48be3ed86 100644 --- a/www/content/workstation/knife_ssh.md +++ b/www/content/workstation/knife_ssh.md @@ -13,7 +13,7 @@ aliases = ["/knife_ssh.html", "/knife_ssh/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_ssh.md) -{{% ws_knife_ssh_summary %}} +{{% knife_ssh_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife ssh SEARCH_QUERY SSH_COMMAND (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -134,7 +134,7 @@ knife search node "tags:*ubuntu* OR roles:*ubuntu* OR fqdn:*ubuntu* (etc.)" {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_ssl_check.md b/www/content/workstation/knife_ssl_check.md index 2185d5f7c..814789c8d 100644 --- a/www/content/workstation/knife_ssl_check.md +++ b/www/content/workstation/knife_ssl_check.md @@ -13,7 +13,7 @@ aliases = ["/knife_ssl_check.html", "/knife_ssl_check/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_ssl_check.md) -{{% ws_knife_ssl_check_summary %}} +{{% knife_ssl_check_summary %}} ## Syntax @@ -39,11 +39,11 @@ The following examples show how to use this knife subcommand: **SSL certificate has valid X.509 properties** -{{% ws_knife_ssl_check_verify_server_config %}} +{{% knife_ssl_check_verify_server_config %}} **SSL certificate has invalid X.509 properties** -{{% ws_knife_ssl_check_bad_ssl_certificate %}} +{{% knife_ssl_check_bad_ssl_certificate %}} **Verify the SSL configuration for Chef Infra Client** diff --git a/www/content/workstation/knife_ssl_fetch.md b/www/content/workstation/knife_ssl_fetch.md index 8013364aa..cbc69de15 100644 --- a/www/content/workstation/knife_ssl_fetch.md +++ b/www/content/workstation/knife_ssl_fetch.md @@ -13,7 +13,7 @@ aliases = ["/knife_ssl_fetch.html", "/knife_ssl_fetch/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_ssl_fetch.md) -{{% ws_knife_ssl_fetch_summary %}} +{{% knife_ssl_fetch_summary %}} ## Syntax @@ -64,4 +64,4 @@ knife ssl fetch https://www.example.com **Verify Checksums** -{{% ws_knife_ssl_fetch_verify_certificate %}} +{{% knife_ssl_fetch_verify_certificate %}} diff --git a/www/content/workstation/knife_status.md b/www/content/workstation/knife_status.md index f7c294404..e2e2cff6c 100644 --- a/www/content/workstation/knife_status.md +++ b/www/content/workstation/knife_status.md @@ -13,7 +13,7 @@ aliases = ["/knife_status.html", "/knife_status/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_status.md) -{{% ws_knife_status_summary %}} +{{% knife_status_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife status (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -59,7 +59,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -69,7 +69,7 @@ The following examples show how to use this knife subcommand: **View status, include run-lists** -{{% ws_knife_status_include_run_lists %}} +{{% knife_status_include_run_lists %}} **View status using a time range** @@ -89,7 +89,7 @@ to return something like: **View status using a query** -{{% ws_knife_status_returned_by_query %}} +{{% knife_status_returned_by_query %}} **View status for all nodes** diff --git a/www/content/workstation/knife_supermarket.md b/www/content/workstation/knife_supermarket.md index efa9d7f7a..458b3e635 100644 --- a/www/content/workstation/knife_supermarket.md +++ b/www/content/workstation/knife_supermarket.md @@ -22,13 +22,13 @@ arguments do not require a user account: `download`, `search`, {{< note >}} -{{% ws_notes_knife_cookbook_site_use_devkit_berkshelf %}} +{{% notes_knife_cookbook_site_use_devkit_berkshelf %}} {{< /note >}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} diff --git a/www/content/workstation/knife_tag.md b/www/content/workstation/knife_tag.md index a37ebb544..b7a398020 100644 --- a/www/content/workstation/knife_tag.md +++ b/www/content/workstation/knife_tag.md @@ -13,13 +13,13 @@ aliases = ["/knife_tag.html", "/knife_tag/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_tag.md) -{{% ws_chef_tags %}} +{{% chef_tags %}} -{{% ws_knife_tag_summary %}} +{{% knife_tag_summary %}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} diff --git a/www/content/workstation/knife_upload.md b/www/content/workstation/knife_upload.md index 06a87c689..933d6b444 100644 --- a/www/content/workstation/knife_upload.md +++ b/www/content/workstation/knife_upload.md @@ -13,7 +13,7 @@ aliases = ["/knife_upload.html", "/knife_upload/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_upload.md) -{{% ws_knife_upload_summary %}} +{{% knife_upload_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife upload [PATTERN...] (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -86,7 +86,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_user.md b/www/content/workstation/knife_user.md index 882d638e5..e5d5dcdaf 100644 --- a/www/content/workstation/knife_user.md +++ b/www/content/workstation/knife_user.md @@ -13,11 +13,11 @@ aliases = ["/knife_user.html", "/knife_user/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_user.md) -{{% ws_knife_user_summary %}} +{{% knife_user_summary %}} {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -66,7 +66,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} @@ -338,7 +338,7 @@ This argument has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/knife_windows.md b/www/content/workstation/knife_windows.md index ae1f8db69..bcfed46a3 100644 --- a/www/content/workstation/knife_windows.md +++ b/www/content/workstation/knife_windows.md @@ -15,7 +15,7 @@ aliases = ["/knife_windows.html", "/knife_windows/"] ## Knife Windows Overview -{{% ws_knife_windows_summary %}} +{{% knife_windows_summary %}} {{< note >}} @@ -241,7 +241,7 @@ Use the `winrm` argument to create a connection to one or more remote machines. As each connection is created, a password must be provided. This argument uses the same syntax as the `search` subcommand. -{{% ws_knife_windows_winrm_ports %}} +{{% knife_windows_winrm_ports %}} ### Syntax diff --git a/www/content/workstation/knife_xargs.md b/www/content/workstation/knife_xargs.md index cd452b6e4..5a2279510 100644 --- a/www/content/workstation/knife_xargs.md +++ b/www/content/workstation/knife_xargs.md @@ -13,7 +13,7 @@ aliases = ["/knife_xargs.html", "/knife_xargs/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/knife_xargs.md) -{{% ws_knife_xargs_summary %}} +{{% knife_xargs_summary %}} ## Syntax @@ -27,7 +27,7 @@ knife xargs [PATTERN...] (options) {{< note >}} -{{% ws_knife_common_see_common_options_link %}} +{{% knife_common_see_common_options_link %}} {{< /note >}} @@ -104,7 +104,7 @@ This subcommand has the following options: {{< note >}} -{{% ws_knife_common_see_all_config_options %}} +{{% knife_common_see_all_config_options %}} {{< /note >}} diff --git a/www/content/workstation/plugin_kitchen_vagrant.md b/www/content/workstation/plugin_kitchen_vagrant.md index 55b613ae9..b84a77a5b 100644 --- a/www/content/workstation/plugin_kitchen_vagrant.md +++ b/www/content/workstation/plugin_kitchen_vagrant.md @@ -14,8 +14,8 @@ aliases = ["/plugin_kitchen_vagrant.html", "/plugin_kitchen_vagrant/"] [\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/plugin_kitchen_vagrant.md) -{{% ws_test_kitchen_driver_vagrant %}} +{{% test_kitchen_driver_vagrant %}} -{{% ws_test_kitchen_driver_vagrant_settings %}} +{{% test_kitchen_driver_vagrant_settings %}} -{{% ws_test_kitchen_driver_vagrant_config %}} +{{% test_kitchen_driver_vagrant_config %}} From 3a98f35d8e0e7672b82098dff7f8d363cca4407a Mon Sep 17 00:00:00 2001 From: IanMadd Date: Tue, 4 Aug 2020 11:05:37 -0700 Subject: [PATCH 4/7] Edit readme and makefile Signed-off-by: IanMadd --- www/Makefile | 1 - www/README.md | 19 +++++++++---------- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/www/Makefile b/www/Makefile index 723468f4d..594d56bc9 100644 --- a/www/Makefile +++ b/www/Makefile @@ -24,7 +24,6 @@ chef_web_docs_submodule: git submodule foreach git reset --hard cp -R content/* chef-web-docs/_vendor/github.com/chef/chef-workstation/www/content cp -R static/images/* chef-web-docs/_vendor/github.com/chef/chef-workstation/www/static/images - cp layouts/shortcodes/* chef-web-docs/_vendor/github.com/chef/chef-workstation/www/layouts/shortcodes/ reset_chef_web_docs: git submodule foreach git reset --hard diff --git a/www/README.md b/www/README.md index e152a737c..e564c2fa7 100644 --- a/www/README.md +++ b/www/README.md @@ -239,18 +239,19 @@ provide additional important information There are often cases where we want to maintain blocks of text that are identical from one page to the next. In those cases, we add that text, formatted in Markdown, -to a shortcode file located in `chef-workstation/www/layouts/shortcodes`. - -Each shortcode in the Chef Workstation documentation must be prefixed with `ws_`. -For example, `ws_shortcode_name.md`. +to a shortcode file located in the `chef-web-docs` repo in +`chef-web-docs/themes/docs-new/layouts/shortcodes`. To add that shortcode to a page in `chef-workstation/www/content`, add the file name, minus the .md suffix, wrapped in double curly braces and percent symbols to the location in the Markdown page where you want that text included. For example, -if you want to add the text in `ws_shortcode_file_name.md` to a page, add -`{{% ws_shortcode_file_name %}}` to the text of that page and it will appear when +if you want to add the text in `shortcode_file_name.md` to a page, add +`{{% shortcode_file_name %}}` to the text of that page and it will appear when Hugo rebuilds the documentation. +To update or add a new shortcode to the Workstation documentation, submit a PR to +`chef/chef-web-docs`. All shortcodes should be in `chef-web-docs/themes/docs-new/layouts/shortcodes`. + **Shortcodes in lists** Hugo doesn't handle shortcodes that are indented in a list item properly. It interprets @@ -326,6 +327,7 @@ aliases = ["/a_deleted_page/", "/another_deleted_page/"] ## Structure ### High Level + ``` . ├── Makefile # contains helpers to quickly start up the development environment @@ -334,18 +336,15 @@ aliases = ["/a_deleted_page/", "/another_deleted_page/"] ``` ### Local Content + ``` . ├── site │   ├── content │   │   ├── workstation # where to keep markdown file documentation -│   ├── layouts -| │   ├── shortcodes -| │   │   ├── ws_.md # how to name your workstation-specific shortcodes | ├── static | | ├── images | | | ├── chef-workstation # where to keep any images you need to reference in your documentation -| | ├── css ``` **Data** From 780477afe7f18f8edfd40aed204f0a2f1b71c26e Mon Sep 17 00:00:00 2001 From: IanMadd Date: Tue, 4 Aug 2020 11:06:01 -0700 Subject: [PATCH 5/7] Move ctl_chef.md from chef-web-docs to chef-workstation Signed-off-by: IanMadd --- www/content/workstation/ctl_chef.md | 1315 +++++++++++++++++++++++++++ 1 file changed, 1315 insertions(+) create mode 100644 www/content/workstation/ctl_chef.md diff --git a/www/content/workstation/ctl_chef.md b/www/content/workstation/ctl_chef.md new file mode 100644 index 000000000..c3379e857 --- /dev/null +++ b/www/content/workstation/ctl_chef.md @@ -0,0 +1,1315 @@ ++++ +title = "chef (executable)" +draft = false + +aliases = ["/ctl_chef.html", "/ctl_chef/"] + +[menu] + [menu.workstation] + title = "chef executable (full page)" + identifier = "chef_workstation/chef_workstation_tools/chef_(executable)/ctl_chef.md chef (executable)" + parent = "chef_workstation/chef_workstation_tools/chef_(executable)" + weight = 10 ++++ + +[\[edit on GitHub\]](https://github.com/chef/workstation/blob/master/www/content/workstation/ctl_chef.md) + +The chef executable is a command-line tool that does the following: + +- Generates repositories, cookbooks, recipes, attributes, templates, + and custom resources. +- Installs gems into the Chef development environment's Ruby + installation. + +## chef capture + +Use the `chef capture` subcommand to capture a node's state as a local [chef-repo](/chef_repo/). Use the generated repository if you need to converge a node locally. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef capture NODE-NAME [options] +``` + +### Options + +`-c`, `--credentials` + +: Credentials file (default $HOME/.chef/credentials). + +`-d`, `--with-data-bags` + +: Download all data bags as part of node capture. + +`-h`, `--help` + +: Show help for the command. + +`-k`, `--client-key` + +: Chef Infra Server API client key. + +`-n`, `--client-name` + +: Chef Infra Server API client name. + +`-o`, `--ssl-no-verify` + +: Do not verify SSL when connecting to Chef Infra Server (default: verify). + +`-p`, `--profile` + +: Profile to use from credentials file (default "default"). + +`-s`, `--chef-server-url` + +: Chef Infra Server URL. + +### Examples + +**Capture a node** + +To capture a node in a local repository, run a command similar to: + +``` bash +chef capture test-server +``` + +This will return something similar to: + +``` bash +- Setting up local repository + - Capturing node object 'test-server' + - Capturing policy data... + - Capturing cookbook artifacts... + - Writing kitchen configuration... + +Repository has been created in './node-test-server-repo'. + +Next, locate version-controlled copies of the cookbooks. This is +important so that you can track changes to the cookbooks as you +edit them. You may have one or more existing paths where you have +checked out cookbooks. If not, now is a good time to open a +separate terminal and clone or check out the cookbooks. + +If all cookbooks are not available in the same base location, +you will have a chance to provide additional locations. + +Press Enter to Continue: + +You're ready to begin! + +Start with 'cd ./node-test-server-repo; kitchen converge'. + +As you identify issues, you can modify cookbooks in their +original checkout locations or in the repository's cookbooks +directory and they will be picked up on subsequent runs +of 'kitchen converge'. + +``` + +See the [Upgrade Lab](/workstation/upgrade_lab/#create-an-upgrade-environment-with-chef-capture) documentation for additional +information on upgrading Chef Infra Client. + +## chef env + +Use the `chef env` subcommand to configure the environment for Chef +Workstation. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef env +``` + +### Options + +This command does not have any specific options. + +### Examples + +None. + +## chef exec + +Use the `chef exec` subcommand to run arbitrary shell commands with the +`PATH` environment variable and the `GEM_HOME` and `GEM_PATH` Ruby +environment variables pointed at Chef Workstation. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef exec SYSTEM_COMMAND (options) +``` + +### Options + +This subcommand has the following options: + +`-h`, `--help` + +: Show help for the command. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +None. + +## chef gem + +The `chef gem` subcommand is a wrapper around the `gem` command in +RubyGems and is used by Chef to install RubyGems into Chef Workstation +development environment. All knife plugins, drivers for Kitchen, and +other Ruby applications that are not packaged within Chef Workstation +will be installed to the `.Chef Workstation` path in the home directory: +`~/.Chef Workstation/gem/ruby/ver.si.on/bin` (where `ver.si.on` is the +version of Ruby that is packaged within Chef Workstation). + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef gem GEM_COMMAND GEM_OPTIONS (options) +``` + +### Options + +This subcommand has the following options: + +`-h`, `--help` + +: Show help for the command. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +**Show an existing gem in Chef Workstation** + +To show a gem, run a command similar to: + +``` bash +chef gem list cookstyle +``` + +to return something similar to: + +``` bash +*** LOCAL GEMS *** + +cookstyle (5.20.0) +``` + +**List all local gems** + +To list all of the installed gems on your development environment, use +the `list` command without any arguments: + +``` bash +chef gem list +``` + +**Search for local gems** + +The `list` command can also be used to search for locally installed +gems. For example, to list all of the gems with `knife` in their title: + +``` bash +chef gem list knife +``` + +which returns the following output: + +``` bash +*** LOCAL GEMS *** + +knife-opc (0.3.2) +knife-push (1.0.2) +knife-windows (1.9.0) +``` + +**Search remote gems** + +Use the `search` command to search for remote gems available for +installation: + +``` bash +chef gem search kitchen +``` + +to return something similar to: + +``` bash +*** REMOTE GEMS *** + +chefkitchen_cli (0.0.1) +gst-kitchen (0.9.0) +guard-kitchen (0.0.2) +jackal-kitchen (0.1.2) +jackal-kitchen-slack (0.1.2) +kitchen (0.0.3) +``` + +**Install a gem** + +To install a gem, run a command similar to: + +``` bash +chef gem install knife-config +``` + +to return something similar to: + +``` bash +Successfully installed knife-config-1.1.0 +1 gem installed +``` + +**Uninstall a gem** + +To uninstall a gem from Chef Workstation environment: + +``` bash +chef gem uninstall knife-config +``` + +to return something similar to: + +``` bash +Successfully uninstalled knife-config-1.1.0 +``` + +**View the contents of a gem** + +To view the contents of a gem, run a command similar to: + +``` bash +chef gem content knife-config +``` + +to return something similar to: + +``` bash +/Users/user/.chefdk/gem/ruby/2.1.0/gems/knife-config-1.1.0/LICENSE +/Users/user/.chefdk/gem/ruby/2.1.0/gems/knife-config-1.1.0/README.md +/Users/user/.chefdk/gem/ruby/2.1.0/gems/knife-config-1.1.0/lib/chef/knife/config.rb +/Users/user/.chefdk/gem/ruby/2.1.0/gems/knife-config-1.1.0/lib/knife-config.rb +``` + +## chef generate attribute + +Use the `chef generate attribute` subcommand to generate an attribute +file in the `/attributes` directory. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef generate attribute COOKBOOK_PATH NAME (options) +``` + +### Options + +This subcommand has the following options: + +`-g GENERATOR_COOKBOOK_PATH`, `--generator-cookbook GENERATOR_COOKBOOK_PATH` + +: The path at which a cookbook named `code_generator` is located. This + cookbook is used by the `chef generate` subcommands to generate + cookbooks, cookbook files, templates, attribute files, and so on. + Default value: `lib/chef-dk/skeletons`, under which is the default + `code_generator` cookbook that is included as part of Chef + Workstation. + +`-h`, `--help` + +: Show help for the command. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +**Create an attribute** + +To generate an attribute, run a command similar to: + +``` bash +chef generate attribute /path/to/cookbook FOO +``` + +will return something similar to: + +``` bash +Recipe: code_generator::attribute + * directory[/Users/grantmc/chef-repo/cookbooks/chef-repo/attributes] action create + - create new directory /Users/grantmc/chef-repo/cookbooks/chef-repo/attributes + + * template[/Users/grantmc/chef-repo/cookbooks/chef-repo/attributes/FOO.rb] action create + - create new file /Users/grantmc/chef-repo/cookbooks/chef-repo/attributes/FOO.rb +``` + +## chef generate cookbook + +Use the `chef generate cookbook` subcommand to generate a cookbook. + +{{< note >}} + +{{% ruby_style_patterns_hyphens %}} + +{{< /note >}} + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef generate cookbook COOKBOOK_PATH/COOKBOOK_NAME (options) +``` + +### Options + +This subcommand has the following options: + +`-g GENERATOR_COOKBOOK_PATH`, `--generator-cookbook GENERATOR_COOKBOOK_PATH` + +: The path at which a cookbook named `code_generator` is located. This + cookbook is used by the `chef generate` subcommands to generate + cookbooks, cookbook files, templates, attribute files, and so on. + Default value: `lib/chef-dk/skeletons`, under which is the default + `code_generator` cookbook that is included as part of Chef + Workstation. + +`-b`, `--berks` + +: Create a Berksfile in the cookbook. Default value: enabled. This is + disabled if the `--policy` option is given. + +`-C COPYRIGHT`, `--copyright COPYRIGHT` + +: Specify the copyright holder for copyright notices in generated + files. Default value: `The Authors` + +`-d`, `--delivery` + +: Generate a delivery config file and build cookbook inside the new + cookbook. Default value: disabled. This option is disabled. It has + no effect and exists only for compatibility with past releases + +`-m EMAIL`, `--email EMAIL` + +: Specify the email address of the author. Default value: + `you@example.com`. + +`-a KEY=VALUE`, `--generator-arg KEY=VALUE` + +: Sets a property named `KEY` to the given `VALUE` on the generator + context object in the generator cookbook. This allows custom + generator cookbooks to accept optional user input on the command + line. + +`-I LICENSE`, `--license LICENSE` + +: Sets the license. Valid values are `all_rights`, `apache2`, `mit`, + `gplv2`, or `gplv3`. Default value: `all_rights`. + +`-P`, `--policy` + +: Create a Policyfile in the cookbook instead of a Berksfile. Default + value: disabled. + +`-h`, `--help` + +: Show help for the command. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +**Create a cookbook** + +To generate a cookbook, run a command similar to: + +``` bash +chef generate cookbook chefdocs +``` + +will return something similar to: + +``` bash +Recipe: code_generator::cookbook + * directory[/Users/grantmc/chefdocs] action create + - create new directory /Users/grantmc/chefdocs + + * template[/Users/grantmc/chefdocs/metadata.rb] action create + - create new file /Users/grantmc/chefdocs/metadata.rb + + * template[/Users/grantmc/chefdocs/README.md] action create + - create new file /Users/grantmc/chefdocs/README.md + + * cookbook_file[/Users/grantmc/chefdocs/chefignore] action create + - create new file /Users/grantmc/chefdocs/chefignore + + * cookbook_file[/Users/grantmc/chefdocs/Berksfile] action create + - create new file /Users/grantmc/chefdocs/Berksfile + + * template[/Users/grantmc/chefdocs/kitchen.yml] action create + - create new file /Users/grantmc/chefdocs/kitchen.yml + + * directory[/Users/grantmc/chefdocs/recipes] action create + - create new directory /Users/grantmc/chefdocs/recipes + + * template[/Users/grantmc/chefdocs/recipes/default.rb] action create + - create new file /Users/grantmc/chefdocs/recipes/default.rb + + * execute[initialize-git] action run + - execute git init . + + * cookbook_file[/Users/grantmc/chefdocs/.gitignore] action create + - create new file /Users/grantmc/chefdocs/.gitignore +``` + +and which creates a directory structure similar to: + + /chefdocs + /.git + .gitignore + kitchen.yml + Berksfile + chefignore + metadata.rb + README.md + /recipes + default.rb + +**Create a cookbook using a custom skeleton cookbook** + +If a custom skeleton cookbook is located on a macOS desktop (and in this +example, the `chef_generator` cookbook is simply a copy of the same +cookbook that ships in Chef Workstation), the following command will use +the skeleton cookbook at the custom location to generate a cookbook into +the repository from which the `chef` command is run: + +``` bash +chef generate cookbook --generator-cookbook ~/Desktop testcookbook +``` + +{{< note >}} + +The `code_generator` cookbook itself is not specified as part of the +path. + +{{< /note >}} + +will return something similar to: + +``` bash +Compiling Cookbooks... +Recipe: code_generator::cookbook + * directory[/Users/grantmc/Desktop/chef-repo/test-cookbook] action create + - create new directory /Users/grantmc/Desktop/chef-repo/test-cookbook + + * template[/Users/grantmc/Desktop/chef-repo/test-cookbook/metadata.rb] action create + - create new file /Users/grantmc/Desktop/chef-repo/test-cookbook/metadata.rb + + * template[/Users/grantmc/Desktop/chef-repo/test-cookbook/README.md] action create + - create new file /Users/grantmc/Desktop/chef-repo/test-cookbook/README.md + + * cookbook_file[/Users/grantmc/Desktop/chef-repo/test-cookbook/chefignore] action create + - create new file /Users/grantmc/Desktop/chef-repo/test-cookbook/chefignore + + * cookbook_file[/Users/grantmc/Desktop/chef-repo/test-cookbook/Berksfile] action create + - create new file /Users/grantmc/Desktop/chef-repo/test-cookbook/Berksfile + + * template[/Users/grantmc/Desktop/chef-repo/test-cookbook/kitchen.yml] action create + - create new file /Users/grantmc/Desktop/chef-repo/test-cookbook/kitchen.yml + + * directory[/Users/grantmc/Desktop/chef-repo/test-cookbook/recipes] action create + - create new directory /Users/grantmc/Desktop/chef-repo/test-cookbook/recipes + + * template[/Users/grantmc/Desktop/chef-repo/test-cookbook/recipes/default.rb] action create + - create new file /Users/grantmc/Desktop/chef-repo/test-cookbook/recipes/default.rb +``` + +## chef generate build-cookbook + +Use the `chef generate build-cookbook` subcommand to generate a delivery +configuration file and build cookbook. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef generate build-cookbook COOKBOOK_PATH/COOKBOOK_NAME (options) +``` + +### Options + +This subcommand has the following options: + +`-g GENERATOR_COOKBOOK_PATH`, `--generator-cookbook GENERATOR_COOKBOOK_PATH` + +: The path at which a cookbook named `code_generator` is located. This + cookbook is used by the `chef generate` subcommands to generate + cookbooks, cookbook files, templates, attribute files, and so on. + Default value: `lib/chef-dk/skeletons`, under which is the default + `code_generator` cookbook that is included as part of Chef + Workstation. + +`-C COPYRIGHT`, `--copyright COPYRIGHT` + +: Specify the copyright holder for copyright notices in generated + files. Default value: `The Authors` + +`-m EMAIL`, `--email EMAIL` + +: Specify the email address of the author. Default value: + `you@example.com`. + +`-a KEY=VALUE`, `--generator-arg KEY=VALUE` + +: Sets a property named `KEY` to the given `VALUE` on the generator + context object in the generator cookbook. This allows custom + generator cookbooks to accept optional user input on the command + line. + +`-I LICENSE`, `--license LICENSE` + +: Sets the license. Valid values are `all_rights`, `apache2`, `mit`, + `gplv2`, or `gplv3`. Default value: `all_rights`. + +`-h`, `--help` + +: Show help for the command. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +None. + +## chef generate file + +Use the `chef generate file` subcommand to generate a file in the +`/files` directory. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef generate file COOKBOOK_PATH NAME (options) +``` + +### Options + +This subcommand has the following options: + +`-g GENERATOR_COOKBOOK_PATH`, `--generator-cookbook GENERATOR_COOKBOOK_PATH` + +: The path at which a cookbook named `code_generator` is located. This + cookbook is used by the `chef generate` subcommands to generate + cookbooks, cookbook files, templates, attribute files, and so on. + Default value: `lib/chef-dk/skeletons`, under which is the default + `code_generator` cookbook that is included as part of Chef + Workstation. + +`-h`, `--help` + +: Show help for the command. + +`-s SOURCE_FILE`, `--source SOURCE_FILE` + +: Copy the contents from a source file. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +None. + +## chef generate resource + +Use the `chef generate resource` subcommand to generate a custom +resource in the `/resources` directory. + +{{< note >}} + +{{% ruby_style_patterns_hyphens %}} + +{{< /note >}} + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef generate resource COOKBOOK_PATH NAME (options) +``` + +### Options + +This subcommand has the following options: + +`-g GENERATOR_COOKBOOK_PATH`, `--generator-cookbook GENERATOR_COOKBOOK_PATH` + +: The path at which a cookbook named `code_generator` is located. This + cookbook is used by the `chef generate` subcommands to generate + cookbooks, cookbook files, templates, attribute files, and so on. + Default value: `lib/chef-dk/skeletons`, under which is the default + `code_generator` cookbook that is included as part of Chef + Workstation. + +`-h`, `--help` + +: Show help for the command. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +None. + +## chef generate recipe + +Use the `chef generate recipe` subcommand to generate a recipe in the +`/recipes` directory. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef generate recipe COOKBOOK_PATH NAME (options) +``` + +### Options + +This subcommand has the following options: + +`-g GENERATOR_COOKBOOK_PATH`, `--generator-cookbook GENERATOR_COOKBOOK_PATH` + +: The path at which a cookbook named `code_generator` is located. This + cookbook is used by the `chef generate` subcommands to generate + cookbooks, cookbook files, templates, attribute files, and so on. + Default value: `lib/chef-dk/skeletons`, under which is the default + `code_generator` cookbook that is included as part of Chef + Workstation. + +`-h`, `--help` + +: Show help for the command. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +None. + +## chef generate repo + +{{% ctl_chef_generate_repo %}} + +### Syntax + +{{% ctl_chef_generate_repo_syntax %}} + +### Options + +{{% ctl_chef_generate_repo_options %}} + +### Examples + +None. + +## chef generate template + +Use the `chef generate template` subcommand to generate a template in +the `/templates` directory. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef generate template COOKBOOK_PATH NAME (options) +``` + +### Options + +This subcommand has the following options: + +`-g GENERATOR_COOKBOOK_PATH`, `--generator-cookbook GENERATOR_COOKBOOK_PATH` + +: The path at which a cookbook named `code_generator` is located. This + cookbook is used by the `chef generate` subcommands to generate + cookbooks, cookbook files, templates, attribute files, and so on. + Default value: `lib/chef-dk/skeletons`, under which is the default + `code_generator` cookbook that is included as part of Chef + Workstation. + +`-h`, `--help` + +: Show help for the command. + +`-s SOURCE_FILE`, `--source SOURCE_FILE` + +: Copy the contents from a source file. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +None. + +## chef report cookbooks + +Use the `chef report cookbooks` subcommand to generate a cookbook-oriented report for your Chef Infra environment. +This report provides details about upgrade compatibility errors and node cookbook usage. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef report cookbooks [options] +``` + +### Options + +This subcommand has the following options: + +`-a`, `--anonymize` + +: Replace cookbook and node names with hash values to protect the sensitive information. + +`-c`, `--credentials string` + +: Credentials file (default $HOME/.chef/credentials). + +`-f`, `--format` + +: Output format: txt is human readable, csv is machine readable (default "txt"). + +`-F`, `--node-filter` + +: Search filter to apply to nodes. + +`-h`, `--help` + +: Show help for the command. + +`-k`, `--client-key` + +: Chef Infra Server API client key. + +`-n`, `--client-name` + +: Chef Infra Server API client name. + +`-o`, `--ssl-no-verify` + +: Do not verify SSL when connecting to Chef Infra Server (default: verify). + +`-p`, `--profile` + +: Profile to use from credentials file (default "default"). + +`-s`, `--chef-server-url` + +: Chef Infra Server URL. + +`-u`, `--only-unused` + +: Generate a report that only includes cookbooks that are not included in any node's runlist. + +`-V`, `--verify-upgrade` + +: Verify the upgrade compatibility of every cookbook. + +`-w`, `--workers` + +: Maximum number of parallel workers at once (default 50). + + +### Examples + +**Generate a report** + +To generate a cookbook oriented report, run a command similar to: + +``` bash +chef report cookbooks +``` + +will return something similar to: + +``` bash +Finding available cookbooks... (5 found) +Analyzing cookbooks... +5 / 5 [----------------------------------------------------------------------------------------------------------------] 100.00% 13 p/s + +-- REPORT SUMMARY -- + + Cookbook Version Policy Group Policy Nodes Affected +-----------+---------+--------------+--------+----------------- + apt 2.7.0 2 + Go 0.1.0 3 + java 0.3.0 4 + java Production K8s 1 + K8s Production K8s 1 + + +Cookbooks report saved to .chef-workstation/reports/cookbooks-20200722120938.txt +``` + +More details of this summary report can be viewed in the text file, the location for which is given at the end of the summary. + +See the [Upgrade Lab](/workstation/upgrade_lab/#chef-report-cookbooks) documentation for additional +information on upgrading Chef Infra Client. + +## chef report nodes + +Use the `chef report nodes` subcommand to generate a nodes-oriented report for your chef environment. This report provides details about nodes, applied policies and the cookooks used during the most recent chef-client run. + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef report nodes [options] +``` + +### Options + +This subcommand has the following options: + +`-a`, `--anonymize` + +: Replace cookbook and node names with hash values to protect the sensitive information. + +`-c`, `--credentials string` + +: Credentials file (default $HOME/.chef/credentials). + +`-f`, `--format` + +: Output format: txt is human readable, csv is machine readable (default "txt"). + +`-F`, `--node-filter` + +: Search filter to apply to nodes. + +`-h`, `--help` + +: Show help for the command. + +`-k`, `--client-key` + +: Chef Infra Server API client key. + +`-n`, `--client-name` + +: Chef Infra Server API client name. + +`-o`, `--ssl-no-verify` + +: Do not verify SSL when connecting to Chef Infra Server (default: verify). + +`-p`, `--profile` + +: Profile to use from credentials file (default "default"). + +`-s`, `--chef-server-url` + +: Chef Infra Server URL. + + +### Examples + +**Generate a report** + +To generate a nodes oriented report, run a command similar to: + +``` bash +chef report nodes +``` + +will return something similar to: + +``` bash +Analyzing nodes... + +-- REPORT SUMMARY -- + + Node Name Chef Version Operating System Number Cookbooks +---------------------+--------------+------------------+------------------- + dev-server-backend 16.1.16 redhat v8.2 3 + dev-server-web 16.1.16 redhat v8.2 1 + production-server 16.1.16 redhat v8.2 2 + staging-server 16.1.16 redhat v8.2 4 + test-server 16.1.16 redhat v8.2 3 + +Nodes report saved to .chef-workstation/reports/nodes-20200722130502.txt + +``` +More details of this summary report can be viewed in the text file, the location for which is given at the end of the summary. + +[Upgrade Lab](https://docs.chef.io/workstation/upgrade_lab) provides further details on how this command can be used in Chef client upgrade process. + + +## chef shell-init + +Use the `chef shell-init` subcommand to set the Ruby included in Chef +Workstation as the system Ruby. Chef Workstation is designed to allow +the isolation of applications used by Chef Workstation from other Ruby +development tools that may be present on the workstation. This supports +Bash, fish, Windows PowerShell (posh), and zsh. + +bash zsh fish PowerShell (posh) + +### Syntax + +This subcommand has the following syntax: + +``` bash +chef shell-init SHELL_NAME (options) +``` + +### Options + +This subcommand has the following options: + +`-h`, `--help` + +: Show help for the command. + +`-v`, `--version` + +: The Chef Infra Client version. + +### Examples + +**Set PowerShell** + +You can use the `chef shell-init` command with Windows PowerShell to add +the appropriate variables to your environment. + +To try it in your current session: + +``` bash +chef shell-init powershell | Invoke-Expression +``` + +To enable it permanently: + +``` bash +"chef shell-init powershell | Invoke-Expression" >> $PROFILE +``` + +**Set the execution policy on new machines** + +On new Windows machines, PowerShell scripts will not work until an +administrator runs the following command: + +``` bash +Set-ExecutionPolicy RemoteSigned +``` + +**Create a \$PROFILE on new machines** + +On new Windows machines, commands cannot be appended to `$PROFILE` if +the folder does not exist, or if there is a new user profile. This will +result in an error similar to the following: + +``` bash +PS C:\Users\Stuart> "chef shell-init powershell | Invoke-Expression" >> $PROFILE +out-file : Could not find a part of the path +'C:\Users\Stuart\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1'. +At line:1 char:1 ++ "chef shell-init powershell | Invoke-Expression" >> $PROFILE ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : OpenError: (:) [Out-File], DirectoryNotFoundException + + FullyQualifiedErrorId : FileOpenFailure,Microsoft.PowerShell.Commands.OutFileCommand +``` + +In this situation, run the following `chef shell-init` command instead: + +``` bash +if(Test-Path $PROFILE){ chef shell-init powershell | Add-Content $PROFILE } else { New-Item -Force -ItemType File $PROFILE; chef shell-init powershell | Add-Content $PROFILE } +``` + +## Policyfile Commands + +{{% policyfile_chef_commands %}} + +### chef clean-policy-cookbooks + +{{% ctl_chef_clean_policy_cookbooks %}} + +#### Syntax + +{{% ctl_chef_clean_policy_cookbooks_syntax %}} + +#### Options + +{{% ctl_chef_clean_policy_cookbooks_options %}} + +#### Examples + +None. + +### chef clean-policy-revisions + +{{% ctl_chef_clean_policy_revisions %}} + +#### Syntax + +{{% ctl_chef_clean_policy_revisions_syntax %}} + +#### Options + +{{% ctl_chef_clean_policy_revisions_options %}} + +#### Examples + +None. + +### chef delete-policy + +{{% ctl_chef_delete_policy %}} + +#### Syntax + +{{% ctl_chef_delete_policy_syntax %}} + +#### Options + +{{% ctl_chef_delete_policy_options %}} + +#### Examples + +None. + +### chef delete-policy-group + +{{% ctl_chef_delete_policy_group %}} + +#### Syntax + +{{% ctl_chef_delete_policy_group_syntax %}} + +#### Options + +{{% ctl_chef_delete_policy_group_options %}} + +#### Examples + +None. + +### chef diff + +{{% ctl_chef_diff %}} + +#### Syntax + +{{% ctl_chef_diff_syntax %}} + +#### Options + +{{% ctl_chef_diff_options %}} + +#### Examples + +**Compare current lock to latest commit on latest branch** + +{{% ctl_chef_diff_current_lock_latest_branch %}} + +**Compare current lock with latest commit on master branch** + +{{% ctl_chef_diff_current_lock_master_branch %}} + +**Compare current lock to specified revision** + +{{% ctl_chef_diff_current_lock_specified_revision %}} + +**Compare lock on master branch to lock on revision** + +{{% ctl_chef_diff_master_lock_revision_lock %}} + +**Compare lock for version with latest commit on master branch** + +{{% ctl_chef_diff_version_lock_master_branch %}} + +**Compare current lock with latest lock for policy group** + +{{% ctl_chef_diff_current_lock_policy_group %}} + +**Compare locks for two policy groups** + +{{% ctl_chef_diff_two_policy_groups %}} + +### chef export + +{{% ctl_chef_export %}} + +#### Syntax + +{{% ctl_chef_export_syntax %}} + +#### Configuration Settings + +{{% ctl_chef_export_config %}} + +#### Options + +{{% ctl_chef_export_options %}} + +#### Examples + +None. + +### chef generate policyfile + +{{% ctl_chef_generate_policyfile %}} + +#### Syntax + +{{% ctl_chef_generate_policyfile_syntax %}} + +#### Options + +{{% ctl_chef_generate_policyfile_options %}} + +#### Examples + +None. + +### chef install + +{{% ctl_chef_install %}} + +#### Syntax + +{{% ctl_chef_install_syntax %}} + +#### Options + +{{% ctl_chef_install_options %}} + +#### Policyfile.lock.json + +{{% policyfile_lock_json %}} + +{{% policyfile_lock_json_example %}} + +#### Examples + +None. + +### chef push + +{{% ctl_chef_push %}} + +#### Syntax + +{{% ctl_chef_push_syntax %}} + +#### Options + +{{% ctl_chef_push_options %}} + +#### Examples + +None. + +### chef push-archive + +{{% ctl_chef_push_archive %}} + +#### Syntax + +{{% ctl_chef_push_archive_syntax %}} + +#### Options + +{{% ctl_chef_push_archive_options %}} + +#### Examples + +None. + +### chef show-policy + +{{% ctl_chef_show_policy %}} + +#### Syntax + +{{% ctl_chef_show_policy_syntax %}} + +#### Options + +{{% ctl_chef_show_policy_options %}} + +#### Examples + +None. + +### chef undelete + +{{% ctl_chef_undelete %}} + +#### Syntax + +{{% ctl_chef_undelete_syntax %}} + +#### Options + +{{% ctl_chef_undelete_options %}} + +#### Examples + +None. + +### chef update + +{{% ctl_chef_update %}} + +#### Syntax + +{{% ctl_chef_update_syntax %}} + +#### Options + +{{% ctl_chef_update_options %}} + +#### Examples + +None. From e025bd16b4ac74dd415a2e3d46a9fa7791f09680 Mon Sep 17 00:00:00 2001 From: IanMadd Date: Mon, 10 Aug 2020 10:09:44 -0700 Subject: [PATCH 6/7] Update changes to ctl_chef.md page Signed-off-by: IanMadd --- www/content/workstation/ctl_chef.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/www/content/workstation/ctl_chef.md b/www/content/workstation/ctl_chef.md index c3379e857..9b7e13c84 100644 --- a/www/content/workstation/ctl_chef.md +++ b/www/content/workstation/ctl_chef.md @@ -396,8 +396,8 @@ This subcommand has the following options: `-b`, `--berks` -: Create a Berksfile in the cookbook. Default value: enabled. This is - disabled if the `--policy` option is given. +: Create a Berksfile in the cookbook. Default: disabled. Optional. + Use to create a berksfile by overriding default creation of a Policyfile. `-C COPYRIGHT`, `--copyright COPYRIGHT` @@ -429,8 +429,8 @@ This subcommand has the following options: `-P`, `--policy` -: Create a Policyfile in the cookbook instead of a Berksfile. Default - value: disabled. +: Create a Policyfile in the cookbook instead of a Berksfile. + Default: enabled. `-h`, `--help` From f3295d182aa8b2ab425c96576a0a75b19a25e74d Mon Sep 17 00:00:00 2001 From: IanMadd Date: Thu, 13 Aug 2020 15:30:45 -0700 Subject: [PATCH 7/7] Update chef-web-docs submodule Signed-off-by: IanMadd --- www/chef-web-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/chef-web-docs b/www/chef-web-docs index 50850be04..021bc51bf 160000 --- a/www/chef-web-docs +++ b/www/chef-web-docs @@ -1 +1 @@ -Subproject commit 50850be04b68ad417403c1e2238c3dab6c6f4537 +Subproject commit 021bc51bf53c0a4315d9ac5ffeda2b7fe1b15a9e