chef-cft / chef-examples Goto Github PK

Example Request

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

What is the problem you're trying to solve that this example will help with?
For example, if you are trying to setup SAML for Automate using a third party
SSO provider, the problem you are trying to solve is "how to configure
Automate to use my third-party SSO provider for an externally managed IdP". Be
specific with the problem details as well, in the previous example, you would
want to make sure to name the SSO provider you need an example for, along with
details of versions, and anything else you can provide.

External References

• Provide a bullet list of any links to external references that could help the
  person working on the problem.

Additional Notes

Provide anything else that can help the person working the problem.

Example Request

This example request includes usage of the following Chef products:

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Policyfiles are the Chef recommended way of packaging and converging cookbooks onto a node. Currently, there's a lot of opinion out there on how to use policyfiles, but not much on how to organize them. Due to this, it's hard to decide how to organize Policyfiles in SCM when accounting for multiple teams, org silos, and future scaling.

External References

• https://blog.chef.io/policyfiles-a-chef-best-practice/

Additional Notes

This example should show the following:

• It should take into account a basic "app stack" that a typical Chef customer would have in their own environment.
• It should break down the individual components of Policyfiles are created and deployed, and show where SCM is used for each one.
• It needs to be opinionated, and give newcomers to Policyfiles a good foundation on which to start building out their code base, yet also be flexible enough to be modified in the future.
• It should build on consensus of Chef professionals, and not be the opinion of just one person.

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

There is a need to use an ARM template without using the Azure Chef Extension to do some custom things (such as use Policyfiles instead of Envs). Azure provides a way to run a Powershell script during VM creation, however there is no currently defined process to bootstrap the chef client using that method. It would be great to have a working ARM template example that shows what this process looks like.

External References

• https://github.com/Azure/azure-quickstart-templates/tree/master/201-vm-custom-script-windows

The link in https://github.com/chef-cft/chef-examples/tree/jrm/add-pipelines under README under the section of Other for Example Pipelines has a bad link and results in a 404.

To fix: just add the right hyperlink

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

What is the problem you're trying to solve that this example will help with?
For example, if you are trying to setup SAML for Automate using a third party
SSO provider, the problem you are trying to solve is "how to configure
Automate to use my third-party SSO provider for an externally managed IdP". Be
specific with the problem details as well, in the previous example, you would
want to make sure to name the SSO provider you need an example for, along with
details of versions, and anything else you can provide.

External References

• Provide a bullet list of any links to external references that could help the
  person working on the problem.

Additional Notes

Provide anything else that can help the person working the problem.

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Infra Server, Chef Infra Client, Chef Workstation and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Currently, if a node is deleted from a Chef Infra Server, and there is a backup of that node via knife ec backup, the node can be restored using knife node from file my_node.json, however, the permissions for the node to access it's own node object are not restored and must be manually done by granting permissions to itself via Chef Manage. This is not an automated way of restoring a node, there are most likely API calls or knife raw commands that can be used to restore the proper permissions as well as the node object itself. This example would show how to do that.

External References

• N/A

Additional Notes

• N/A

A Comprehensive Guide to Updating Chef Infra Client

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Currently, the only guides for updating the Chef Infra Client from major to major versions are either on blog posts, or outdated, or don't cover everything they should. There is no comprehensive guide that explains the nuances of the upgrade process for both Windows and Linux, and the individual steps are not well documented.

External References

• Chef Client Updater Cookbook: https://github.com/chef-cookbooks/chef_client_updater

Additional Notes

The guide should include the following (as a start):

• A step-by-step guide for upgrading Chef Infra Client on Windows, from 12.x, 13.x and 14.x to 15.x - to be kept updated ongoing.
• A step-by-step guide for upgrading Chef Infra Client on Linux, from 12.x, 13.x and 14.x to 15.x - to be kept updated ongoing.
• A diagram that explains the process
• A way to test prior to upgrading.
• A way to validate that the process worked after the upgrade.

HowTo Migrate from Chef Manage to A2

This example request includes usage of the following Chef products:

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Currently, Chef Manage has some features that don't directly map to Automate 2, since Chef Manage is now being deprecated (see deprecations list here), there should be an easy reference on how to get the same functionality that it provided using Chef's current toolset.

External References

• https://docs.chef.io/versions.html#deprecated-products-and-versions

Additional Notes

• There should be a guide/reference for how to migrate activities that were done on Chef Manage over to A2 and other tools that are current.

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

I am an early adopter of Chef, and I have cookbook, attribute and dependency sprawl, and I can't control where or how I make changes to my environment. I've heard that Role Cookbooks are a way to get some sanity back and get to a point where I can make changes to my Chef-run infrastructure in a much more precise, iterative manner, rather than the current method of pushing out changes and hoping they work. Can I get an example of how this all works, and some practical steps on how to implement it?

External References

• First stab at this model

Additional Notes

N/A

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

A lot of Chef users would love the ability to drop in a RSYSLOG rulebase for Chef Server in order to get Chef Server logs, currently there is no easy "drop-in" for this. The goal is to have a basic reference rulebase along with instructions on how to set it up all interested.

External References

• https://www.rsyslog.com/log-normalization-for-different-formats/

Additional Notes

N/A

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• [ X] Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Customers looking to setup a highly-available Habitat on-prem depot need some good steps to implement.

Example Request

This example request includes usage of the following Chef products (select one
or more):

• [X ] Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Customers do not get blanket access to the applications dashboard within A2. In order to provide that access, we can do this easily with a policy.

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Chef users would like to have a full, step-by-step example of how to use Chef to update Windows using the xWindowsUpdate DSC.

External References

• https://github.com/PowerShell/xWindowsUpdate

Additional Notes

Provide anything else that can help the person working the problem.

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

An example (or examples) of methods for pushing encryption keys for databags to hosts in an automated fashion.

External References

*N/A

Additional Notes

N/A

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

It's sometimes hard to determine why one would choose policyfile workflow over Berks workflow, and vice-versa. It would be great to have a document that shows the pros and cons of both, and helps Chef users better choose how to proceed.

External References

• n/a

Additional Notes

n/a

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• [X ] Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

After talking with Tim Smith about Cookstyle 6.11/Workstation 20.7.96, the latest Rubocop has been pulled in, which has a newer method of defining the autocorrect pieces of Cookstyle rules. We need to update this, so we have rule-writing instructions for both.

External References

• https://docs.rubocop.org/rubocop/development.html#auto-correct

Additional Notes

This should have a new section appended to ensure we maintain historical instructions should the need arise.

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

What is the problem you're trying to solve that this example will help with?
For example, if you are trying to setup SAML for Automate using a third party
SSO provider, the problem you are trying to solve is "how to configure
Automate to use my third-party SSO provider for an externally managed IdP". Be
specific with the problem details as well, in the previous example, you would
want to make sure to name the SSO provider you need an example for, along with
details of versions, and anything else you can provide.

External References

• Provide a bullet list of any links to external references that could help the
  person working on the problem.

Additional Notes

Provide anything else that can help the person working the problem.

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• [x ] Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Cookstyle has replaced Foodcritic, and custom Foodcritic rules are in place at some companies. As such, we need to give them a way to learn and port over Foodcritic rules to Cookstyle (the auto-remediate is super powerful, as a bonus).

Example Request

This example request includes usage of the following Chef products (select one
or more):

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

We need some basic patterns for bootstrapping Chef Infra and leveraging related tools both locally (we have one for Vagrant) and in the cloud.

External References

• AWS (CloudFormation)
• Azure (ARM)
• GCP (Deployment Manager)
• Pulumi
• Terraform

Additional Notes

Try to introduce cloud native examples at first using the native tools available with the platform. Create examples using Terraform and Pulumi.

Example Request

This example request includes usage of the following Chef products:

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

Many customers are using Thycotic for secrets management, there should be an example of how to pull in secrets from Thycotic Secrets Server that Chef users can take and modify for their own use easily.

External References

• https://thycotic.com/products/secret-server/

Additional Notes

• N/A

Example Request

This example request includes usage of the following Chef products:

• Chef Automate
  • Includes Chef Server, Client, Backend, ChefDK and Supermarket
• Chef Workstation
  • Includes Chef Workstation only
• Habitat
  • Includes Habitat, Habitat Builder (on-prem and SaaS)
• InSpec
  • Includes InSpec, Ad-hoc Automate jobs, Audit Cookbook

Problem Statement

A HowTo guide is needed to show how to setup Automate 2.0 with Okta SAML/SSO authentication.

External References

• Automate SAML Docs: https://automate.chef.io/docs/configuration/#saml
• Setting up a SAML Application in Okta: https://developer.okta.com/standards/SAML/setting_up_a_saml_application_in_okta

Additional Notes

N/A