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.

Sign up for GitHub

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

Correct alt text #4191

Merged
merged 3 commits into from
Oct 19, 2023
Merged

Correct alt text #4191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b85cd94
Correct alt text
IanMadd Oct 19, 2023
7401a1a
linting
IanMadd Oct 19, 2023
e95f0da
More linting fixes
IanMadd Oct 19, 2023
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
2 changes: 1 addition & 1 deletion content/chef_client_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Chef Infra Client's Compliance Phase lets you automatically execute compliance a
</colgroup>
<tbody>
<tr>
<td><p><img src="/images/icon_chef_client.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_chef_client.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>{{< readfile file="content/reusable/md/chef_client_summary.md" >}}</p>
<p>{{< readfile file="content/reusable/md/security_key_pairs_chef_client.md" >}}</p></td>
</tr>
Expand Down
76 changes: 38 additions & 38 deletions content/chef_overview.md
View file
Open in desktop
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 @@ -58,33 +58,33 @@ Chef Infra has the following major components:
</thead>
<tbody>
<tr>
<td><p><img src="/images/icon_workstation.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_workstation.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>One (or more) workstations are configured to allow users to author, test, and maintain cookbooks.</p>
<p>Workstation systems run the Chef Workstation package which includes tools such as Chef Infra Client, Chef InSpec, Test Kitchen, ChefSpec, Cookstyle, and other tools necessary for developing and testing your infrastructure with Chef products.</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_cookbook.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>Cookbooks are uploaded to the Chef Infra Server from these workstations. Some cookbooks are custom to the organization and others are based on community cookbooks available from the Chef Supermarket.</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_ruby.svg" class="align-center" width="130" alt="image" /></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><img src="/images/icon_ruby.svg" class="align-center" width="130" alt="" /></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="image" /></p></td>
<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="image" /></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><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'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="image" /></p></td>
<td><p><img src="/images/icon_chef_server.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>The Chef Infra Server acts as a hub of information. Cookbooks and policy settings are uploaded to the Chef Infra Server by users from workstations.</p>
<p>The Chef Infra Client accesses the Chef Infra Server from the node on which it is installed to get configuration data, performs searches of historical Chef Infra Client run data, and then pulls down the necessary configuration data. After a Chef Infra Client run is finished, the Chef Infra Client uploads updated run data to the Chef Infra Server.</p></td>
<p>The Chef Infra Client accesses the Chef Infra Server from the node on which it's installed to get configuration data, performs searches of historical Chef Infra Client run data, and then pulls down the necessary configuration data. After a Chef Infra Client run is finished, the Chef Infra Client uploads updated run data to the Chef Infra Server.</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_chef_supermarket.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_chef_supermarket.svg" class="align-center" width="130" alt="" /></p></td>
<td>Chef Supermarket is the location in which community cookbooks are shared and managed. Cookbooks that are part of the Chef Supermarket may be used by any Chef user. How community cookbooks are used varies from organization to organization.</td>
</tr>
</tbody>
Expand Down Expand Up @@ -127,12 +127,12 @@ Some important tools and components of Chef Workstation include:
</thead>
<tbody>
<tr>
<td><p><img src="/images/icon_workstation.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_workstation.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/workstation/reusable/md/chef_workstation.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_ctl_chef.svg" class="align-center" width="130" alt="image" /></p>
<p><img src="/images/icon_ctl_knife.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_ctl_chef.svg" class="align-center" width="130" alt="" /></p>
<p><img src="/images/icon_ctl_knife.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>Chef Workstation includes important command-line tools:</p>
<ul>
<li>Chef Infra: Use the chef command-line tool to work with items in a chef-repo, which is the primary location in which cookbooks are authored, tested, and maintained, and from which policy is uploaded to the Chef Infra Server</li>
Expand All @@ -145,7 +145,7 @@ Some important tools and components of Chef Workstation include:
</ul></td>
</tr>
<tr>
<td><p><img src="/images/icon_repository.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_repository.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>The chef-repo is the repository structure in which cookbooks are authored, tested, and maintained:</p>
<ul>
<li>Cookbooks contain recipes, attributes, custom resources, libraries, files, templates, tests, and metadata</li>
Expand All @@ -154,11 +154,11 @@ Some important tools and components of Chef Workstation include:
<p>The directory structure within the chef-repo varies. Some organizations prefer to keep all of their cookbooks in a single chef-repo, while other organizations prefer to use a chef-repo for every cookbook.</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_kitchen.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_kitchen.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/workstation/reusable/md/test_kitchen.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_chefspec.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_chefspec.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/chefspec_summary.md" >}}</td>
</tr>
</tbody>
Expand Down Expand Up @@ -192,39 +192,39 @@ Cookbooks are comprised of the following components:
</thead>
<tbody>
<tr>
<td><p><img src="/images/icon_cookbook_attributes.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_cookbook_attributes.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/cookbooks_attribute.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook_files.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_cookbook_files.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/resource_cookbook_file_summary.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook_libraries.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_cookbook_libraries.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/libraries_summary.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook_metadata.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_cookbook_metadata.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/cookbooks_metadata.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook_recipes.svg" class="align-center" width="130" alt="image" /></p></td>
<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="image" /></p></td>
<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="image" /></p></td>
<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="image" /></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><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'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 Expand Up @@ -254,12 +254,12 @@ The key components of nodes that are under management by Chef include:
</thead>
<tbody>
<tr>
<td><p><img src="/images/icon_chef_client.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_chef_client.svg" class="align-center" width="130" alt="" /></p></td>
<td><p>{{< readfile file="content/reusable/md/chef_client_summary.md" >}}</p>
<p>{{< readfile file="content/reusable/md/security_key_pairs_chef_client.md" >}}</p></td>
</tr>
<tr>
<td><p><img src="/images/icon_ohai.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_ohai.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/ohai_summary.md" >}}</td>
</tr>
</tbody>
Expand All @@ -282,19 +282,19 @@ The key components of nodes that are under management by Chef include:
</thead>
<tbody>
<tr>
<td><p><img src="/images/icon_search.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_search.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/search.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_manage.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_manage.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/chef_manager.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_data_bags.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_data_bags.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/data_bag.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_policy.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_policy.svg" class="align-center" width="130" alt="" /></p></td>
<td>Policy defines how business and operational requirements, processes, and production workflows map to objects that are stored on the Chef Infra Server. Policy objects on the Chef Infra Server include roles, environments, and cookbook versions.</td>
</tr>
</tbody>
Expand All @@ -319,19 +319,19 @@ Some important aspects of policy include:
</thead>
<tbody>
<tr>
<td><p><img src="/images/icon_roles.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_roles.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/role.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_environments.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_environments.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/environment.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_cookbook_versions.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_cookbook_versions.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/cookbooks_version.md" >}}</td>
</tr>
<tr>
<td><p><img src="/images/icon_run_lists.svg" class="align-center" width="130" alt="image" /></p></td>
<td><p><img src="/images/icon_run_lists.svg" class="align-center" width="130" alt="" /></p></td>
<td>{{< readfile file="content/reusable/md/node_run_list.md" >}}</td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion content/platform_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ There is a query language available through the UI and customizable dashboards.

Here is an example of the Chef Automate dashboard.

{{< figure src="/images/automate-dashboard.png" width=700 alt="Image of Chef Automate dashboard showing the status of nodes under management with Chef Automate." >}}
{{< figure src="/images/automate-dashboard.png" width=700 alt="Chef Automate dashboard showing the status of nodes monitored with Chef Automate." >}}

### Compliance

Expand Down
Loading