Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] formatting and copy edits #165

Merged
merged 1 commit into from
May 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions www/site/content/docs/chef-workstation/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,24 @@ Chef-run is a tool to execute ad-hoc tasks using Chef.

`chef-run <TARGET[S]> <RESOURCE> <RESOURCE_NAME> [PROPERTIES] [FLAGS]`

Runs a single <RESOURCE> on the specified <TARGET[S]>.
[PROPERTIES] should be specified as key=value.
Runs a single <RESOURCE> on the specified <TARGET[S]>.
[PROPERTIES] specify as key=value.

For example:
For example:

```
```bash
chef-run web01 service nginx
chef-run web01,web02 service nginx action=restart
chef-run web[1:2] service nginx priority=20 action=stop
```

`chef-run <TARGET[S]> <RECIPE> [FLAGS]`

Runs a single recipe located at <RECIPE> on the specified <TARGET[S]>.
Runs a single recipe located at <RECIPE> on the specified <TARGET[S]>.

For example:
For example:

```
```bash
chef-run web01 path/to/cookbook/recipe.rb
chef-run web01,web02 path/to/cookbook
chef-run web0[1:2] cookbook_name
Expand All @@ -36,7 +36,7 @@ chef-run web01 cookbook_name::recipe_name

ARGUMENTS:

```
```bash
<TARGET[S]> The hosts or IPs to target. Can also be an SSH or WinRM URLs
in the form:

Expand All @@ -56,8 +56,8 @@ ARGUMENTS:

FLAGS:

```
-c, --config PATH Location of config file. Defaults to /Users/mchiang/.chef-workstation/config.toml
```bash
-c, --config PATH Location of config file. Defaults to /Users/username/.chef-workstation/config.toml
--cookbook-repo-paths PATH Comma separated list of cookbook repository paths.
-h, --help Show help and usage for `chef-run`
-i, --identity-file PATH SSH identity file to use when connecting. Keys loaded into ssh-agent will also be used.
Expand All @@ -82,6 +82,3 @@ FLAGS:
username will be used for all targets.
-v, --version Show the current version of Chef Run.
```



36 changes: 17 additions & 19 deletions www/site/content/docs/chef-workstation/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,17 @@ title = "Frequently Asked Questions"
weight= "30"
+++

#### Is Chef Workstation open source?

#### Is Chef Workstation open source?

Yes! Our source code is available on [GitHub](https://github.com/chef/chef-workstation). Chef Workstation is open souce software released under the [Apache 2.0 license](https://github.com/chef/chef-workstation/blob/master/LICENSE).
Yes! Our source code is available on [GitHub](https://github.com/chef/chef-workstation). Chef Workstation is open source software released under the [Apache 2.0 license](https://github.com/chef/chef-workstation/blob/master/LICENSE).

#### How can I contribute to Chef Workstation?

We always welcome (and deeply appreciate!) new contributions to the project. The best way to start contributing to Chef Workstation during the beta period is to provide us with in-depth feedback by creating GitHub issues or sending your feedback to <beta@chef.io>.
We always welcome (and deeply appreciate!) new contributions to the project. The best way to start contributing to Chef Workstation during the beta period is to provide us with in-depth feedback by creating GitHub issues or sending your feedback to <beta@chef.io>.

We are working on guidelines on how to keep development of the project awesome for all contributors.
We are working on guidelines on how to keep development of the project awesome for all contributors.

#### Operating Systems Supported
#### Operating Systems Supported

Supported Host Operating Systems:

Expand All @@ -40,31 +39,30 @@ Supported Target Operating Systems:
| Ubuntu | 14.04, 16.04, 18.04 |
| Debian | 7.x, 8.x, 9.x |

* Note: Supported platforms and versions for Chef Workstation are subject to change for the duration of the beta program.
* Note: Supported platforms and versions for Chef Workstation are subject to change for the duration of the beta program.

#### Why does Chef Workstation collect usage analytics and bug reports?
#### Why does Chef Workstation collect usage analytics and bug reports?

Chef Workstation collects information to help us identify bugs and how users are interacting with Chef Workstation to help us make continous improvements.
Chef Workstation collects information to help us identify bugs and how users are interacting with Chef Workstation to help us make continuous improvements.

##### What we capture?
##### What does Chef Workstation capture?

- The Chef specific commands you execute (We do **not** capture any arguments)
- Connection method (WinRM or SSH)
- Host Operating System and version
* The Chef specific commands you execute (We do **not** capture any arguments)
* Connection method (WinRM or SSH)
* Host Operating System and version

##### Who can view it?

You can view the analytics we collect before it is sent. Telemetry from previous run(s) is sent when you start chef-cli. The data can be found in and removed from HOME/.chef-workstation/telemetry/ folder.
You can view the analytics we collect before it is sent. Telemetry from previous run(s) is sent when you start chef-cli. Find--and remove it, your data--from the `HOME/.chef-workstation/telemetry/` folder.

The data collected is only accessible to employees of Chef Software, Inc. and under no circumstances will it be sold/re-sold or used in a malicious manner.
Your data collected is only accessible to employees of Chef Software, Inc. We will never sell, re-sell, or use your data in a malicious manner.

##### How to opt-out?

- You can stop a single session from being captured by setting the environment variable CHEF_TELEMETRY_OPT_OUT to any value before running chef-cli.
- You can disable it completely by adding the following to `$HOME/.chef-workstation/config.toml`
* You can stop a single session from being captured by setting the environment variable CHEF_TELEMETRY_OPT_OUT to any value before running chef-cli.
* You can disable telemetry by adding the following to `$HOME/.chef-workstation/config.toml`

```
```bash
[telemetry]
enabled=false
```

58 changes: 30 additions & 28 deletions www/site/content/docs/chef-workstation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ title = "Getting Started"
weight = "1"
+++

## Overview
## Overview

Chef Workstation gives you everything you need to get started with Chef. Ad-hoc remote execution, scans and configuration tasks, cookbook creation tools, and robust dependency and testing software all in one easy-to-install package.
Chef Workstation gives you everything you need to get started with Chef. Ad-hoc remote execution, scans and configuration tasks, cookbook creation tools, as well as robust dependency and testing software all in one easy-to-install package.

## Install Chef Workstation
## Install Chef Workstation

If you have not installed Chef Workstation, please download and install via https://www.chef.sh.
If you have not installed Chef Workstation, download and install it via https://www.chef.sh.

## Check versions
## Check versions

New ad-hoc commands `chef-run` and ChefDK commands such as `chef` are available via Chef Workstation. Your output may differ if you are running different versions.
New ad-hoc commands `chef-run` and ChefDK commands such as `chef` are available via Chef Workstation. Your output may differ if you are running different versions.

```
$ chef-run -v
```bash
$ chef-run -v
chef-run: 0.1.114

$ chef -v
$ chef -v
Chef Development Kit Version: 3.0.36
chef-client version: 14.1.12
delivery version: master (7206afaf4cf29a17d2144bb39c55b7212cfafcc7)
Expand All @@ -31,35 +31,35 @@ kitchen version: 1.21.2
inspec version: 2.1.72
```

## Ad-hoc remote execution with `chef-run`
## Ad-hoc remote execution with `chef-run`

The `chef-run` utility allows you to execute ad-hoc configuration updates on the systems you manage without needing to first set up a Chef server. With chef-run, you connect to servers over SSH or WinRM, and can apply single resources, recipes, or entire cookbooks directly from your local workstation.
The `chef-run` utility allows you to execute ad-hoc configuration updates on the systems you manage without needing to first set up a Chef server. With chef-run, you connect to servers over SSH or WinRM, and can apply single resources, recipes, or entire cookbooks directly from your local workstation.

### Example: Installing NTP Server

Chef Workstation combines the power of InSpec and chef-run to give you the ability to easily detect and correct issues on any target instance. A common task an environment maintainer might have to perform is ensuring that the Network Time Protocol (NTP) is installed so that clocks are kept in sync between servers. InSpec allows us to simply query whether the package is installed via its package resource:
Chef Workstation combines the power of InSpec and chef-run to give you the ability to easily detect and correct issues on any target instance. A common task that an environment maintainer performs is ensuring that the Network Time Protocol (NTP) is installed, so clocks are kept in sync between servers. InSpec allows us to simply query whether the package is installed via its package resource:

```ruby
describe package('ntp') do
it { should be_installed }
end
```ruby
describe package('ntp') do
it { should be_installed }
end
```

Chef provides a similar single-resource solution for ensuring the package is installed:
Chef provides a similar single-resource solution for ensuring the package is installed:

```ruby
package 'ntp' do
action :install
end
```
```ruby
package 'ntp' do
action :install
end
```

With chef-run, we can converge targets against a single resource without needing to create a cookbook or recipe -- the resource can be run directly from the commandline like so:
Use chef-run, to converge targets against a single resource without needing to create a cookbook or recipe -- run the resource directly from the command-line:

```bash
chef-run myhost package ntp action=install
```
```bash
chef-run myhost package ntp action=install
```

Combined with the InSpec resource to validate whether the package was installed successfully, we have everything we need to define our requirements, and make sure they're met with two simple commmands.
Combined with the InSpec resource to validate whether the package was installed successfully, we have everything we need to define our requirements, and make sure they're met with two simple commands.

![Chef Run NTP Installation](/images/docs/chef-run.gif)

Expand All @@ -68,15 +68,17 @@ Chef Workstation combines the power of InSpec and chef-run to give you the abili
`chef-run` can execute Chef recipes and cookbooks as well, and run against multiple targets in parallel. Here are a few other examples of chef-run in action.

#### Example: Recipe execution on multiple targets

Runs the default recipe from the defined cookbook against myhost1 & myhost2

```bash
chef-run myhost1,myhost2 /path/to/my/cookbook
```

#### Example: Alternate Recipe syntax and targets defined by a range

Runs the `my_cookbook::my_recipe` cookbook against servers myhost1 through myhost20

```bash
chef-run myhost[1:20] my_cookbook::my_recipe
```
```
23 changes: 11 additions & 12 deletions www/site/content/docs/chef-workstation/privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,27 @@ title = "Privacy"
weight = "50"
+++

#### Why does Chef Workstation collect usage analytics and bug reports?
#### Why does Chef Workstation collect usage analytics and bug reports?

Chef Workstation collects information to help us identify bugs and how users are interacting with Chef Workstation to help us make continous improvements.
Chef Workstation collects information to help us identify bugs and how users are interacting with Chef Workstation to help us make continuous improvements.

##### What we capture?
##### What we capture?

- The Chef specific commands you execute (We do **not** capture any arguments)
- Connection method (WinRM or SSH)
- Host Operating System and version
* The Chef specific commands you execute (We do **not** capture any arguments)
* Connection method (WinRM or SSH)
* Host Operating System and version

##### Who can view it?

You can view the analytics we collect before it is sent. Telemetry from previous run(s) is sent when you start chef-cli. The data can be found in and removed from HOME/.chef-workstation/telemetry/ folder.

The data collected is only accessible to employees of Chef Software, Inc. and under no circumstances will it be sold/re-sold or used in a malicious manner.
You can view the analytics we collect before it is sent. Telemetry from previous run(s) is sent when you start chef-cli. Find--and remove it, your data--from the `HOME/.chef-workstation/telemetry/` folder.

Your data collected is only accessible to employees of Chef Software, Inc. We will never sell, re-sell, or use your data in a malicious manner.
##### How to opt-out?

- You can stop a single session from being captured by setting the environment variable CHEF_TELEMETRY_OPT_OUT to any value before running chef-cli.
- You can disable it completely by adding the following to `$HOME/.chef-workstation/config.toml`
* You can stop a single session from being captured by setting the environment variable CHEF_TELEMETRY_OPT_OUT to any value before running chef-cli.
* You can disable telemetry by adding the following to `$HOME/.chef-workstation/config.toml`

```
```bash
[telemetry]
enabled=false
```
16 changes: 8 additions & 8 deletions www/site/content/docs/chef-workstation/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,30 @@ title = "Troubleshooting"
weight = "40"
+++

## Chef Workstation Logs
## Chef Workstation Logs

Chef Workstation logs are stored in ` ~/.chef-workstation/logs`.
Chef Workstation logs are stored in ` ~/.chef-workstation/logs`.

## Uninstall instructions
## Uninstall instructions

### Mac

Please run the following code in your terminal:
Run the following code in your terminal:

```
```bash
rm -rf /opt/chef-workstation;
chefdk_binaries="berks chef chef-apply chef-shell chef-solo chef-vault cookstyle dco delivery foodcritic inspec kitchen knife ohai push-apply pushy-client pushy-service-manager chef-client"
binaries="chef-run chefx $chefdk_binaries"

for binary in $binaries; do
rm -f $PREFIX/bin/$binary
done
```
```

### Windows

Please use **Add / Remove Programs** to remove the Chef Workstation product on the Microsoft Windows platform.
Use **Add / Remove Programs** to remove the Chef Workstation product on the Microsoft Windows platform.

### Linux

Please remove using respective package manager based on the distro. (i.e: `yum`, `apt` etc. )
Remove using respective package manager based on the distribution, for example, `yum` or `apt`.