From f5ccca2e56555dcb7941de36b08b9a7b9b24f492 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Thu, 19 Oct 2023 12:33:50 -0400 Subject: [PATCH] Correct alt text (#4191) * Correct alt text Signed-off-by: Ian Maddaus * linting Signed-off-by: Ian Maddaus * More linting fixes Signed-off-by: Ian Maddaus --------- Signed-off-by: Ian Maddaus --- content/chef_client_overview.md | 2 +- content/chef_overview.md | 76 +++++++++++++++---------------- content/platform_overview.md | 2 +- content/reusable/md/node_types.md | 16 +++---- content/server_orgs.md | 18 ++++---- 5 files changed, 57 insertions(+), 57 deletions(-) diff --git a/content/chef_client_overview.md b/content/chef_client_overview.md index 28a1a83e3b..fcabd12a41 100644 --- a/content/chef_client_overview.md +++ b/content/chef_client_overview.md @@ -35,7 +35,7 @@ Chef Infra Client's Compliance Phase lets you automatically execute compliance a -

image

+

{{< readfile file="content/reusable/md/chef_client_summary.md" >}}

{{< readfile file="content/reusable/md/security_key_pairs_chef_client.md" >}}

diff --git a/content/chef_overview.md b/content/chef_overview.md index e68fc2ef8b..918260a11f 100644 --- a/content/chef_overview.md +++ b/content/chef_overview.md @@ -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. @@ -58,33 +58,33 @@ Chef Infra has the following major components: -

image

+

One (or more) workstations are configured to allow users to author, test, and maintain cookbooks.

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.

-

image

+

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.

-

image

-

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.

+

+

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.

-

image

+

{{< readfile file="content/reusable/md/node.md" >}}

-

image

-

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.

+

+

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.

-

image

+

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.

-

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.

+

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.

-

image

+

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. @@ -127,12 +127,12 @@ Some important tools and components of Chef Workstation include: -

image

+

{{< readfile file="content/workstation/reusable/md/chef_workstation.md" >}} -

image

-

image

+

+

Chef Workstation includes important command-line tools:

  • 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
    • @@ -145,7 +145,7 @@ Some important tools and components of Chef Workstation include:
-

image

+

The chef-repo is the repository structure in which cookbooks are authored, tested, and maintained:

  • Cookbooks contain recipes, attributes, custom resources, libraries, files, templates, tests, and metadata
    • @@ -154,11 +154,11 @@ Some important tools and components of Chef Workstation include:

    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.

    -

    image

    +

    {{< readfile file="content/workstation/reusable/md/test_kitchen.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/chefspec_summary.md" >}} @@ -192,39 +192,39 @@ Cookbooks are comprised of the following components: -

    image

    +

    {{< readfile file="content/reusable/md/cookbooks_attribute.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/resource_cookbook_file_summary.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/libraries_summary.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/cookbooks_metadata.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/cookbooks_recipe.md" >}}

    -

    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.

    +

    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.

    {{< readfile file="content/reusable/md/infra_lang_summary.md" >}}

    -

    image

    +

    {{< readfile file="content/reusable/md/resources_common.md" >}}

    -

    Chef has many built-in resources that cover all of the most common actions across all of the most common platforms. You can build your own resources to handle any situation that is not covered by a built-in resource.

    +

    Chef has many built-in resources that cover all of the most common actions across all of the most common platforms. You can build your own resources to handle any situation that's not covered by a built-in resource.

    -

    image

    +

    {{< readfile file="content/reusable/md/template.md" >}} -

    image

    -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. +

    +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. @@ -254,12 +254,12 @@ The key components of nodes that are under management by Chef include: -

    image

    +

    {{< readfile file="content/reusable/md/chef_client_summary.md" >}}

    {{< readfile file="content/reusable/md/security_key_pairs_chef_client.md" >}}

    -

    image

    +

    {{< readfile file="content/reusable/md/ohai_summary.md" >}} @@ -282,19 +282,19 @@ The key components of nodes that are under management by Chef include: -

    image

    +

    {{< readfile file="content/reusable/md/search.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/chef_manager.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/data_bag.md" >}} -

    image

    +

    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. @@ -319,19 +319,19 @@ Some important aspects of policy include: -

    image

    +

    {{< readfile file="content/reusable/md/role.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/environment.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/cookbooks_version.md" >}} -

    image

    +

    {{< readfile file="content/reusable/md/node_run_list.md" >}} diff --git a/content/platform_overview.md b/content/platform_overview.md index f3861da6f0..23bdd72224 100644 --- a/content/platform_overview.md +++ b/content/platform_overview.md @@ -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 diff --git a/content/reusable/md/node_types.md b/content/reusable/md/node_types.md index 2a384f7db8..f41e51e4aa 100644 --- a/content/reusable/md/node_types.md +++ b/content/reusable/md/node_types.md @@ -16,24 +16,24 @@ limited to, the following: -

    image

    -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. +

    +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. -

    image

    +

    A cloud-based node is hosted in an external cloud-based service, such as Amazon Web Services (AWS), OpenStack, Rackspace, Google Compute Engine, or Microsoft Azure. Plugins are available for knife that provide support for external cloud-based services. knife can use these plugins to create instances on cloud-based services. Once created, Chef Infra Client can be used to deploy, configure, and maintain those instances. -

    image

    +

    A virtual node is a machine that runs only as a software implementation, but otherwise behaves much like a physical machine. -

    image

    -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. +

    +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. -

    image

    -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. +

    +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. diff --git a/content/server_orgs.md b/content/server_orgs.md index 11f7dfff34..8528786335 100644 --- a/content/server_orgs.md +++ b/content/server_orgs.md @@ -30,21 +30,21 @@ role-based access control: -

    image

    -An organization is the top-level entity for role-based access control in the Chef Infra Server. Each organization contains the default groups (admins, clients, and users, plus billing_admins 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. +

    +An organization is the top-level entity for role-based access control in the Chef Infra Server. Each organization contains the default groups (admins, clients, and users, plus billing_admins 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. -

    image

    +

    A group is used to define access to object types and objects in the Chef Infra Server and also to assign permissions that determine what types of tasks are available to members of that group who are authorized to perform them. Groups are configured by organization.

    Individual users who are members of a group will inherit the permissions assigned to the group. The Chef Infra Server includes the following default groups: admins, clients, and users. For users of the hosted Chef Infra Server, an additional default group is provided: billing_admins.

    -

    image

    -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 admins group. +

    +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 admins group. -

    image

    -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. +

    +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. @@ -215,7 +215,7 @@ The Chef Infra Server includes the following default groups: clients -The clients group defines the list of nodes on which a Chef Infra Client is installed and under management by Chef. In general, think of this permission as "all of the non-human actors---Chef Infra Client, in almost every case---that get data from, and/or upload data to, the Chef server". Newly-created Chef Infra Client instances are added to this group automatically. +The clients group defines the list of nodes on which a Chef Infra Client is installed and under management by Chef. In general, think of this permission as "all of the non-human actors---Chef Infra Client, in almost every case---that get data from, and/or upload data to, Chef Infra Server." Newly-created Chef Infra Client instances are added to this group automatically. public_key_read_access @@ -223,7 +223,7 @@ The Chef Infra Server includes the following default groups: users -The users 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". +The users 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 Chef Infra Server."