Skip to content

Commit

Permalink
De-duplicating content
Browse files Browse the repository at this point in the history
I went through and merged, updated, or deleted pages that were left over
after merging the 'chef-web-docs' sources into here. This included
adding more topics top the top level navigation bar as well as details
on new tools (like `chef-run`).

Signed-off-by: tyler-ball <tball@chef.io>
  • Loading branch information
tyler-ball committed Mar 30, 2020
1 parent 6dd4cfe commit 5f79a69
Show file tree
Hide file tree
Showing 15 changed files with 249 additions and 416 deletions.
2 changes: 1 addition & 1 deletion www/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ weight = 10
title = "chef (executable)"
identifier = "chef_workstation/chef_workstation_tools/chef_(executable)"
parent = "chef_workstation/chef_workstation_tools"
weight = 30
weight = 20

[[menu.workstation]]
title = "chef env"
Expand Down
85 changes: 0 additions & 85 deletions www/content/workstation/about.md

This file was deleted.

84 changes: 0 additions & 84 deletions www/content/workstation/chef-run.md

This file was deleted.

26 changes: 23 additions & 3 deletions www/content/workstation/chef-workstation-app.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
+++
title = "Chef Workstation App"
draft = false

aliases = ["/chef_workstation_app.html", "/chef_workstation_app/"]

[menu]
[menu.workstation]
title = "Chef Workstation App"
identifier = "chef_workstation/chef_workstation_tools/chef_workstation_app.md Chef Workstation App"
parent = "chef_workstation/chef_workstation_tools"
weight = 61
+++

+++
title = "About Berkshelf"
draft = false

aliases = ["/berkshelf.html", "/berkshelf/"]

[menu]
[menu.docs]
parent = "Chef Workstation"
weight = "100"
[menu.workstation]
title = "Berkshelf"
identifier = "chef_workstation/chef_workstation_tools/berkshelf.md Berkshelf"
parent = "chef_workstation/chef_workstation_tools"
weight = 10
+++

# About Chef Workstation App
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
+++
title = "chef-run Guide"
title = "chef-run (executable)"
draft = false

aliases = ["/chef_run.html", "/chef_run/"]

[menu]
[menu.docs]
parent = "Chef Workstation"
weight = "999"
[menu.workstation]
title = "chef-run (executable)"
identifier = "chef_workstation/chef_workstation_tools/chef_run.md chef-run (executable)"
parent = "chef_workstation/chef_workstation_tools"
weight = 31
+++

# Using `chef-run`

This document covers some common usage scenarios for `chef-run`
[\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/chef_run.md)

To start with, familiarize yourself with `chef-run`'s arguments and flags
by running `chef-run -h`.
`chef-run` is a tool to execute ad-hoc tasks on one or more target nodes
using Chef. To start with, familiarize yourself with `chef-run`'s
arguments and flags by running `chef-run -h`.

## Apply a Resource to a Single Node over SSH
Apply a Resource to a Single Node over SSH
==========================================

In its simplest form, `chef-run` targets a single machine and execute a single
resource on that machine:
Expand Down Expand Up @@ -47,7 +53,8 @@ chef-run my_user:a_password@host1:2222 directory /tmp/foo
chef-run my_user@host1:2222 directory /tmp/foo --password a_password
```

## Applying a Resource to a Single Node over WinRM
Applying a Resource to a Single Node over WinRM
===============================================

To target WinRM you must specify the `winrm` protocol as part of the connection
information:
Expand All @@ -64,7 +71,8 @@ HTTPS connections are supported by providing the `--ssl` flag.
`chef-run` over WinRM does not support certifcate-based authentication to
target hosts.

## Specifying resource properties and actions
Specifying resource properties and actions
==========================================

All [Chef core resources](https://docs.chef.io/resource_reference.html) can be
specified on the command line. Use the `chef-run` command first, followed by
Expand All @@ -88,7 +96,8 @@ See the documentation for each resource to see available properties available to
customize. As shown in the previous example, you can quote the `key=value` pair
if the value contains a character that would be interpreted by the shell.

## Running a Recipe
Running a Recipe
================

To run a full recipe, specify a recipe using its path:

Expand Down Expand Up @@ -140,7 +149,8 @@ configuration file, use:
chef-run host1 my_cookbook --cookbook-repo-paths '/path/1,/path/b'
```

## Configuring Cookbook Dependencies and Sources
Configuring Cookbook Dependencies and Sources
=============================================

When converging a target node `chef-run` creates a policyfile bundle that
includes the cookbook specified. If the cookbook you specified has its own
Expand Down Expand Up @@ -184,13 +194,14 @@ You can specify different cookbook sources in `Policyfile.rb`, including a
private supermarket. See the [Policyfile
documentation](https://docs.chef.io/config_rb_policyfile.html) for examples.

## Connecting to Automate 2
Connecting to Automate 2
========================

You can configure remote nodes managed with `chef-run` to send run
information to Automate. First, [generate an auth token](https://automate.chef.io/docs/api-tokens/#creating-a-standard-api-token).

Next, add the token to [config.toml]({{< ref "config.md#data-collector" >}}),
specifying the appropriate [url] (https://automate.chef.io/docs/data-collection/) and
Next, add the token to [config.toml]({{< ref "config.md#data_collector" >}}),
specifying the appropriate [url](https://automate.chef.io/docs/data-collection/) and
[token](https://automate.chef.io/docs/api-tokens/#creating-a-standard-api-token)
for the automate server:

Expand Down
4 changes: 2 additions & 2 deletions www/content/workstation/chef_shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ aliases = ["/chef_shell.html", "/chef_shell/"]
title = "chef-shell (executable)"
identifier = "chef_workstation/chef_workstation_tools/chef_shell.md chef-shell (executable)"
parent = "chef_workstation/chef_workstation_tools"
weight = 20
+++
weight = 40
+++

[\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/ctl_chef_shell.md)

Expand Down
6 changes: 3 additions & 3 deletions www/content/workstation/chef_vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ aliases = ["/chef_vault.html", "/chef_vault/"]

[menu]
[menu.workstation]
title = "chef-vault"
identifier = "chef_workstation/chef_workstation_tools/chef_vault.md chef-vault"
title = "chef-vault (executable)"
identifier = "chef_workstation/chef_workstation_tools/chef_vault.md chef-vault (executable)"
parent = "chef_workstation/chef_workstation_tools"
weight = 50
+++
+++

[\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/chef_vault.md)

Expand Down
18 changes: 11 additions & 7 deletions www/content/workstation/config.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
+++
title = "Chef Workstation Configuration"
linkTitle = "Chef Workstation Configuration"
title = "Configure Chef Workstation"
draft = false

aliases = ["/workstation_config.html", "/workstation_config/"]

[menu]
[menu.docs]
parent = "Reference"
weight = "10"
[menu.workstation]
title = "Configure Chef Workstation"
identifier = "chef_workstation/config.md Configure Chef Workstation"
parent = "chef_workstation"
weight = 31
+++

# Configuration

Chef Workstation App and `chef-run` configuration is managed in `config.toml`.
Chef Workstation will create `config.toml` the first time you use `chef-run`,
if one does not already exist. To configure other tools, see their
respective pages found in the [ChefDK
documentation](https://docs.chef.io/about_chefdk.html).
respective pages found in the toolbar under Chef Workstation Tools.

## Default location

Expand Down
4 changes: 2 additions & 2 deletions www/content/workstation/ctl_chef_apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ aliases = ["/ctl_chef_apply.html", "/ctl_chef_apply/"]
title = "chef-apply (executable)"
identifier = "chef_workstation/chef_workstation_tools/ctl_chef_apply.md chef-apply (executable)"
parent = "chef_workstation/chef_workstation_tools"
weight = 40
+++
weight = 30
+++

[\[edit on GitHub\]](https://github.com/chef/chef-workstation/blob/master/www/content/workstation/ctl_chef_apply.md)

Expand Down
Loading

0 comments on commit 5f79a69

Please sign in to comment.