chefdk_bootstrap (51) Versions 1.9.0 Follow18

Bootstrap a developer workstation for local Chef development using the ChefDK

Policyfile

Berkshelf

Knife

cookbook 'chefdk_bootstrap', '= 1.9.0', :supermarket

cookbook 'chefdk_bootstrap', '= 1.9.0'

knife supermarket install chefdk_bootstrap

knife supermarket download chefdk_bootstrap

README

Dependencies

Changelog

Quality 100%

ChefDK_Bootstrap

Setup your laptop for Chef development in minutes

Run one simple command to easily set up your Windows or Mac machine
for Chef cookbook development in about 20 minutes.

Before You Begin

If you are on a Windows machine, you will need at least PowerShell 3.0. We recommend PowerShell 5.0 because it supports Microsoft DSC.
If you are behind a proxy, you will need to export these proxy environment variables first.

Windows Quickstart

Copy the PowerShell command below and paste them into a PowerShell Admin console. This will download and run the bootstrap
script on your workstation.

 (Invoke-WebRequest -Uri https://raw.githubusercontent.com/Nordstrom/chefdk_bootstrap/master/bootstrap.ps1).Content | Invoke-Expression

Mac Quickstart

Copy the command below and paste it into a terminal. This will download and run the bootstrap script on your workstation.

curl https://raw.githubusercontent.com/Nordstrom/chefdk_bootstrap/master/bootstrap | bash

Mac ChefDK profile setup

Follow the instructions in the ChefDK README to complete the Chef workstation setup.

If you are behind a proxy

Windows

Set Proxy Environment Vars

Copy/paste these environment variables into your terminal.

# change these values to your proxy address
$env:http_proxy='http://myproxy.example.com:1234'

$env:https_proxy=$env:http_proxy

# don't go through the proxy for these addresses.
# change example.com to your corporate DNS domain
$env:no_proxy='localhost,127.0.0.1,example.com'

Use this proxy-aware bootstrap script

Copy the PowerShell command below and paste them into a PowerShell Admin console. This will execute the bootstrap
script on your workstation.

 (Invoke-WebRequest -Uri https://raw.githubusercontent.com/Nordstrom/chefdk_bootstrap/master/bootstrap.ps1 -ProxyUseDefaultCredentials -Proxy $env:https_proxy).Content | Invoke-Expression

Mac

Copy/paste these environment variables into your terminal.

# change these values to your proxy address
export http_proxy=http://myproxy.example.com:1234

export https_proxy=$http_proxy

# don't go through the proxy for these addresses.
# change example.com to your corporate DNS domain
export no_proxy='localhost,127.0.0.1,example.com'

To make these changes permanent, export these environment variables from your bash or zsh profile.

Now run the Quickstart for Mac

Customization

If you want to use your own custom wrapper cookbook, add the name of your cookbook and your private supermarket source to these commands instead of the original Quickstart (examples included below).

JSON attributes

You can pass in attributes via URL/path to a JSON file (see the --json-attributes option in chef-client ). Right now we're passing this in via the CHEFDK_BOOTSTRAP_JSON_ATTRIBUTES environment variable, but in a future version, we'll likely make it a named parameter of the bootstrap script.

Windows

$env:CHEFDK_BOOTSTRAP_JSON_ATTRIBUTES = "http://server/attributes.json"

Mac

export CHEFDK_BOOTSTRAP_JSON_ATTRIBUTES="http://server/attributes.json"

Custom cookbook

Windows

$install = (Invoke-WebRequest -Uri https://raw.githubusercontent.com/Nordstrom/chefdk_bootstrap/master/bootstrap.ps1 -ProxyUseDefaultCredentials -Proxy $env:https_proxy).Content

"$install <your cookbook name> <your private supermarket url>" | Invoke-Expression

Mac

curl https://raw.githubusercontent.com/Nordstrom/chefdk_bootstrap/master/bootstrap | bash -s -- <your cookbook name> <your private supermarket url>

What does it do?

This cookbook installs these tools:

Editor

Atom, a free, general purpose, cross-platform, open source,
text editor. Out of the box, Atom supports all the languages you will need
for Chef development: Ruby, PowerShell, Bash, XML, JSON, etc.

Source Control

Git - command line git client and tools.

Local Virtualization

Virtualbox - Oracle's free, open source virtualization tool for local cookbook testing.

Vagrant - ChefDK's included Test Kitchen tool uses Vagrant to spin up local VMs for cookbook testing.

Recipes

default

Installs Chocolatey for a Windows machine and homebrew for a Mac machine. Both of these are package managers, similar to apt-get on Ubuntu. Chocolatey is used to install packages like posh-git and kdiff3, while homebrew is used to install packages like iterm2.
Installs all the other tools marked true in the
node['chefdk_bootstrap']['package'] hash.
On Windows, includes the Powershell profile configuration recipe.

atom

Installs the Atom editor

conemu

On Windows, installs ConEmu (a console replacement)

git

Installs git.
On Windows, installs git-credential-winstore, and posh-git.

gitextensions

On Windows, installs gitextensions, a GUI git client.

kdiff3

On Windows, installs the free, open-source diff/merge tool, kdiff3.

powershell_profile

Configures a global PowerShell profile to correct the $env:HOME environment variable and run chef shell-init powershell.

vagrant

Installs Vagrant.

virtualbox

Installs Virtualbox.

iterm2

On Mac, installs iterm2.

Attributes

The attributes defined by this recipe are organized under the
node['chefdk_bootstrap'] namespace.

Attribute	Description	Type	Default
['atom']['source_url']	Windows: Atom installer package source URL	URL String	https://atom.io/download/windows
['atom']['source_url']	Mac: Atom installer package source URL	URL String	https://atom.io/download/mac
['package']['atom']	Whether to install Atom or not	boolean	true
['package']['kdiff3']	Whether to install kdiff3 or not	boolean	true
['package']['vagrant']	Whether to install Vagrant or not	boolean	true
['package']['virtualbox']	Whether to install Virtualbox or not	boolean	true
['package']['git']	Whether to install git and related packages or not	boolean	true
['package']['gitextensions']	Whether to install gitextensions or not	boolean	true
['package']['iterm2']	Whether to install iterm2 or not	boolean	true
['package']['chefdk_julia']	Whether to install chefdk_julia or not	boolean	false

Author

Nordstrom, Inc.

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Revision History for chefdk_bootstrap

1.9.0

Fix #134: Put SSH on the path so kitchen login works
Fix #132: Add comments to $Profile.CurrentUserAllHosts PowerShell profile
Fix #63: Dry up the cleanup in the Windows bootstrap
Fix #133: Clean up berkshelf environment variable from Windows bootstrap
Fix #47: Add kitchen config.yml file to pass through proxy settings (when needed)

1.8.0

Fix #130:
Move PowerShell Profile customizations to a PowerShell module on the $env:PSModulePath
Fix #75:
Write PowerShell profile customizations to $Profile.CurrentUserAllHosts

Upgrading from 1.7

This cookbook no longer writes C:\WINDOWS\System32\WindowsPowerShell\v1.0\profile.ps1.
If you are upgrading from 1.7 or earlier you will need to remove the lines added by the chefdk_bootstrap in v1.7.0
or delete the file.

1.7.0

Install ChefDK 0.13.21 via bootstrap script
Add InSpec integration tests for each (Windows) component
Recommend PowerShell 5.0 instead of 4.0 in README
Add ConEmu on Windows (Issue #115)
Fix PowerShell color contrast issues (Issues #40, #117)

1.6.2

Use atom cookbook to install Atom

1.6.1

Fix Atom install on Windows. Fixes #109.

1.6.0

Switch from chocolatey resource in Chocolatey cookbook to chocolatey_package resource in Chef 12.7
Install Virtualbox on Mac via dmg_package resource instead of homebrew. Fixes #97.

1.5.4

Use sudo to remove temporary directory
Switch .kitchen.yml to use @mwrockx's Windows2012R2 Atlas Vagrant box.
Mac: Fix #81 by hiding script download progress from cURL
Improve spec coverage from 46% to 87%
Bootstrap now writes correct Ohai disabled_plugins syntax to remove deprecation warning.

1.5.3

Mac: Don't create directories which homebrew cookbook already creates
Bootstrap: create temporary directory using mktemp -d
Stop creating ~/.chef, ~/chef, and ~/chef/cookbooks directories in bootstrap script since creating these directories has been moved to the cookbook.

1.5.2

Bump homebrew dependency to ~> 2.0 because Homebrew cookbook v2.0.4 fixes chef-cookbooks/homebrew#87. This will fix the bootstrap for Mac users.
Update Windows cookbook dependency

1.5.1

Fix the chefdk_julia install attribute to match others and document it

1.5.0

Install 64-bit git 2.7
Install Git Credential Manager for Windows, which replaces the deprecated git-credential-winstore.
Add option to install chefdk-julia
Refactor specs. Use shared_context for Windows and Mac Chef runs. Fix broken tests by setting node['vagrant']['checksum'] attribute in Chef runs.

1.4.1

Install Vagrant via community Vagrant cookbook

1.4.0

create ~/.chef, ~/chef, ~/chef/cookbooks
fixes #43

1.3.3

Mac OS X: create /opt/homebrew-cask directory
fixes #60

1.3.2

Windows: Check for Admin rights or exit
Windows: Use omnitruck ChefDK installation, selecting specific version
Windows: Check installed ChefDK version, do the right thing.
Windows: Check for error status after various commands
fixes #56
fixes #49
fixes #33

1.3.1

Switch from brew-cask to omnitruck chefdk installation for Mac OS X
Make bootstrap incrementally more robust on Mac OS X
fixes #33
Fixes #45
fixes #56 on mac osx, still an issue on windows

1.3.0

Depend on chocolatey 0.5.0 to improve installation behind a proxy
Install Git v2.5.1 instead of v1.9.5

Dev environment changes

Travis CI builds use ChefDK built-in gems instead of Gemfile + bundler
Rakefile defines default task of :style, :spec

1.2.4

Minor edits to README for clarity

1.2.3

Make non-proxy README instructions work for Windows. Fixes #35
Clear screen as first step in bootstrap script. Fixes #34

1.2.2

Add Apache 2.0 license header.

1.2.1

Add Travis CI support to run style and unit tests
Recommend PowerShell 4.0 instead of PowerShell 3.0 because 4.0 supports DSC.

1.2.0

Update bootstrap script to take a private source and cookbook name and add it to the Berksfile.
Update README.

1.1.3

Add guards around file deletions.

1.1.2

Edit README to clarify proxy instructions.

1.1.1

Add instructions for no_proxy environment variable in the README.

1.1.0

Set proxy environment variables in powershell_profile.
This enables command-line tools like git, cURL, and Test Kitchen to work behind a proxy.

1.0.3

Fix bug in Atom setup for Windows

1.0.2

Edited the README to make the markdown for Chef Supermaket consistent.

1.0.1

Clarified Windows bootstrap instructions.

1.0.0

Added Mac bootstrap functionality.

0.3.0

Add ability to set http_proxy, https_proxy, and no_proxy env vars.

These env vars allow Chef related command line tools, e.g. git, berkshelf, to
work via a web proxy.

0.2.4

Add proxy support to bootstrap script.

0.2.3

Update README
Add introduction to bootstrap script.
Add Atom source URL for Mac platform

0.2.2

Bootstrap script bug fixes

0.2.1

Add PowerShell bootstrap script

0.2.0

Remove support for PuTTY in favor of using git-provided ssh client.

PuTTY is difficult to configure and outside the scope of what this cookbook is
trying to do. Furthermore the Github for Windows client doesn't use PuTTY
either.

0.1.1

Install git via git cookbook
instead of chocolatey.
Install atom editor via windows_package resource instead
of chocolatey.

0.1.0

Initial version

Collaborator Number Metric

1.9.0 passed this metric

Foodcritic Metric

1.9.0 passed this metric

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

ChefDK_Bootstrap

Setup your laptop for Chef development in minutes

Before You Begin

Windows Quickstart

Mac Quickstart

Mac ChefDK profile setup

If you are behind a proxy

Windows

Set Proxy Environment Vars

Use this proxy-aware bootstrap script

Mac

Customization

JSON attributes

Windows

Mac

Custom cookbook

Windows

Mac

What does it do?

Editor

Source Control

Local Virtualization

Recipes

default

atom

conemu

git

gitextensions

kdiff3

powershell_profile

vagrant

virtualbox

iterm2

Attributes

Author

License

Dependent cookbooks

Contingent cookbooks

Revision History for chefdk_bootstrap

1.9.0

1.8.0

Upgrading from 1.7

1.7.0

1.6.2

1.6.1

1.6.0

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.1

1.4.0

1.3.3

1.3.2

1.3.1

1.3.0

Dev environment changes

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.3.0

0.2.4

0.2.3

Collaborator Number Metric

1.9.0 passed this metric

Foodcritic Metric

1.9.0 passed this metric