Skip to content

Commit

Permalink
linting
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Maddaus <[email protected]>
  • Loading branch information
IanMadd committed Oct 19, 2023
1 parent b85cd94 commit 7401a1a
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
12 changes: 6 additions & 6 deletions content/chef_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ product = ["client", "server", "workstation"]
- **Chef Infra Server** acts as [a hub for configuration
data](/server/). Chef Infra Server stores cookbooks,
the policies that are applied to nodes, and metadata that describes
each registered node that is being managed by Chef. Nodes use the
each registered node that's being managed by Chef. Nodes use the
Chef Infra Client to ask the Chef Infra Server for configuration
details, such as recipes, templates, and file distributions.

Expand Down Expand Up @@ -68,15 +68,15 @@ Chef Infra has the following major components:
</tr>
<tr>
<td><p><img src="/images/icon_ruby.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>Ruby is the programming language that is the authoring syntax for cookbooks. Most recipes are simple patterns (blocks that define properties and values that map to specific configuration items like packages, files, services, templates, and users. The full power of Ruby is available for when you need a programming language.</p></td>
<td><p>Ruby is the programming language that's the authoring syntax for cookbooks. Most recipes are simple patterns (blocks that define properties and values that map to specific configuration items like packages, files, services, templates, and users. The full power of Ruby is available for when you need a programming language.</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_node.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>{{< readfile file="content/reusable/md/node.md" >}}</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_chef_client.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>Chef Infra Client is installed on each node that is managed with Chef Infra. Chef Infra Client configures the node locally by performing the tasks specified in the run-list. Chef Infra Client will also pull down any required configuration data from the Chef Infra Server during a Chef Infra Client run.</p></td>
<td><p>Chef Infra Client is installed on each node that's managed with Chef Infra. Chef Infra Client configures the node locally by performing the tasks specified in the run-list. Chef Infra Client will also pull down any required configuration data from the Chef Infra Server during a Chef Infra Client run.</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_chef_server.svg" class="align-center" width="130" alt="" /></p></td>
Expand Down Expand Up @@ -210,21 +210,21 @@ Cookbooks are comprised of the following components:
<tr>
<td><p><img src="/images/icon_cookbook_recipes.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>{{< readfile file="content/reusable/md/cookbooks_recipe.md" >}}</p>
<p>The Chef Infra Client will run a recipe only when asked. When the Chef Infra Client runs the same recipe more than once, the results will be the same system state each time. When a recipe is run against a system, but nothing has changed on either the system or in the recipe, the Chef Infra Client will not change anything.</p>
<p>The Chef Infra Client will run a recipe only when asked. When the Chef Infra Client runs the same recipe more than once, the results will be the same system state each time. When a recipe is run against a system, but nothing has changed on either the system or in the recipe, the Chef Infra Client won't change anything.</p>
<p>{{< readfile file="content/reusable/md/infra_lang_summary.md" >}}</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook_resources.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>{{< readfile file="content/reusable/md/resources_common.md" >}}</p>
<p>Chef has <a href="/resources/">many built-in resources</a> that cover all of the most common actions across all of the most common platforms. You can <a href="/custom_resources/">build your own resources</a> to handle any situation that is not covered by a built-in resource.</p></td>
<p>Chef has <a href="/resources/">many built-in resources</a> that cover all of the most common actions across all of the most common platforms. You can <a href="/custom_resources/">build your own resources</a> to handle any situation that's not covered by a built-in resource.</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook_templates.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/template.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook_tests.svg" class="align-center" width="130" alt="" /></p></td>
<td>Testing cookbooks improves the quality of those cookbooks by ensuring they are doing what they are supposed to do and that they are authored in a consistent manner. Unit and integration testing validates the recipes in cookbooks. Syntax testing---often called linting---validates the quality of the code itself. The following tools are popular tools used for testing Chef recipes: Test Kitchen, ChefSpec, and Cookstyle.</td>
<td>Testing cookbooks improves the quality of those cookbooks by ensuring they're doing what they're supposed to do and that they're authored in a consistent manner. Unit and integration testing validates the recipes in cookbooks. Syntax testing---often called linting---validates the quality of the code itself. The following tools are popular tools used for testing Chef recipes: Test Kitchen, ChefSpec, and Cookstyle.</td>
</tr>
</tbody>
</table>
Expand Down
6 changes: 3 additions & 3 deletions content/reusable/md/node_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ limited to, the following:
<tbody>
<tr class="odd">
<td><p><img src="/images/icon_node_type_server.svg" class="align-center" width="130" alt="" /></p></td>
<td>A physical node is typically a server or a virtual machine, but it can be any active device attached to a network that is capable of sending, receiving, and forwarding information over a communications channel. In other words, a physical node is any active device attached to a network that can run a Chef Infra Client and also allow that Chef Infra Client to communicate with a Chef Infra Server.</td>
<td>A physical node is typically a server or a virtual machine, but it can be any active device attached to a network that's capable of sending, receiving, and forwarding information over a communications channel. In other words, a physical node is any active device attached to a network that can run a Chef Infra Client and also allow that Chef Infra Client to communicate with a Chef Infra Server.</td>
</tr>
<tr class="even">
<td><p><img src="/images/icon_node_type_cloud_public.svg" class="align-center" width="130" alt="" /></p></td>
Expand All @@ -29,11 +29,11 @@ limited to, the following:
</tr>
<tr class="even">
<td><p><img src="/images/icon_node_type_network_device.svg" class="align-center" width="130" alt="" /></p></td>
<td>A network node is any networking device---a switch, a router---that is being managed by a Chef Infra Client, such as networking devices by Juniper Networks, Arista, Cisco, and F5. Use Chef to automate common network configurations, such as physical and logical Ethernet link properties and VLANs, on these devices.</td>
<td>A network node is any networking device---a switch, a router---that's being managed by a Chef Infra Client, such as networking devices by Juniper Networks, Arista, Cisco, and F5. Use Chef to automate common network configurations, such as physical and logical Ethernet link properties and VLANs, on these devices.</td>
</tr>
<tr class="odd">
<td><p><img src="/images/icon_node_type_container.svg" class="align-center" width="130" alt="" /></p></td>
<td>Containers are an approach to virtualization that allows a single operating system to host many working configurations, where each working configuration---a container---is assigned a single responsibility that is isolated from all other responsibilities. Containers are popular as a way to manage distributed and scalable applications and services.</td>
<td>Containers are an approach to virtualization that allows a single operating system to host many working configurations, where each working configuration---a container---is assigned a single responsibility that's isolated from all other responsibilities. Containers are popular as a way to manage distributed and scalable applications and services.</td>
</tr>
</tbody>
</table>
8 changes: 4 additions & 4 deletions content/server_orgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ role-based access control:
<tbody>
<tr>
<td><p><img src="/images/icon_server_organization.svg" class="align-center" width="130" alt="" /></p></td>
<td>An organization is the top-level entity for role-based access control in the Chef Infra Server. Each organization contains the default groups (<code>admins</code>, <code>clients</code>, and <code>users</code>, plus <code>billing_admins</code> for the hosted Chef Infra Server), at least one user and at least one node (on which the Chef Infra Client is installed). The Chef Infra Server supports multiple organizations. The Chef Infra Server includes a single default organization that is defined during setup. Additional organizations can be created after the initial setup and configuration of the Chef Infra Server.</td>
<td>An organization is the top-level entity for role-based access control in the Chef Infra Server. Each organization contains the default groups (<code>admins</code>, <code>clients</code>, and <code>users</code>, plus <code>billing_admins</code> for the hosted Chef Infra Server), at least one user and at least one node (on which the Chef Infra Client is installed). The Chef Infra Server supports multiple organizations. The Chef Infra Server includes a single default organization that's defined during setup. Additional organizations can be created after the initial setup and configuration of the Chef Infra Server.</td>
</tr>
<tr>
<td><p><img src="/images/icon_server_groups.svg" class="align-center" width="130" alt="" /></p></td>
Expand All @@ -40,11 +40,11 @@ role-based access control:
</tr>
<tr>
<td><p><img src="/images/icon_server_users.svg" class="align-center" width="130" alt="" /></p></td>
<td>A user is any non-administrator human being who will manage data that is uploaded to the Chef Infra Server from a workstation or who will log on to the Chef management console web user interface. The Chef Infra Server includes a single default user that is defined during setup and is automatically assigned to the <code>admins</code> group.</td>
<td>A user is any non-administrator human being who will manage data that's uploaded to the Chef Infra Server from a workstation or who will log on to the Chef management console web user interface. The Chef Infra Server includes a single default user that's defined during setup and is automatically assigned to the <code>admins</code> group.</td>
</tr>
<tr>
<td><p><img src="/images/icon_chef_client.svg" class="align-center" width="130" alt="" /></p></td>
<td>A client is an actor that has permission to access the Chef Infra Server. A client is most often a node (on which the Chef Infra Client runs), but is also a workstation (on which knife runs), or some other machine that is configured to use the Chef Infra Server API. Each request to the Chef Infra Server that is made by a client uses a private key for authentication that must be authorized by the public key on the Chef Infra Server.</td>
<td>A client is an actor that has permission to access the Chef Infra Server. A client is most often a node (on which the Chef Infra Client runs), but is also a workstation (on which knife runs), or some other machine that's configured to use the Chef Infra Server API. Each request to the Chef Infra Server that's made by a client uses a private key for authentication that must be authorized by the public key on the Chef Infra Server.</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -223,7 +223,7 @@ The Chef Infra Server includes the following default groups:
</tr>
<tr>
<td><code>users</code></td>
<td>The <code>users</code> group defines the list of users who use knife and the Chef management console to interact with objects and object types. In general, think of this permission as "all of the non-admin human actors who work with data that is uploaded to and/or downloaded from the Chef server".</td>
<td>The <code>users</code> group defines the list of users who use knife and the Chef management console to interact with objects and object types. In general, think of this permission as "all of the non-admin human actors who work with data that's uploaded to and/or downloaded from the Chef server".</td>
</tr>
</tbody>
</table>
Expand Down

0 comments on commit 7401a1a

Please sign in to comment.