Skip to content

Commit

Permalink
Merge branch 'main' into fixup_github_actions_error_messages
Browse files Browse the repository at this point in the history
  • Loading branch information
IanMadd authored Feb 2, 2023
2 parents 5c162c9 + 30b368e commit 8d0a567
Show file tree
Hide file tree
Showing 5 changed files with 137 additions and 37 deletions.
112 changes: 88 additions & 24 deletions content/aws_marketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ product = ["client", "workstation", "automate"]

Chef Automate is an enterprise platform that allows developers, operations, and security engineers to collaborate on application and infrastructure changes with speed and at scale. Chef Automate provides actionable insights across data centers and cloud providers, wherever your nodes live.

Chef Automate is the center of the modern Chef platform, providing users with a single source of truth for infrastructure, security, and application automation. The comprehensive dashboard provides real-time views of your configuration management activity. Chef Automate comes bundled with the latest Chef Infra Server, providing the core tools you need to manage your enterprise infrastructure. Data collection is enabled by default, allowing your nodes to report activity in real-time. This instance is free for 60 days or you can bring your own license (BYOL).
Chef Automate is the center of the modern Chef platform, providing users with a single source of truth for infrastructure, security, and application automation. The comprehensive dashboard offers real-time views of your configuration management activity. Chef Automate comes bundled with the latest Chef Infra Server, providing the core tools you need to manage your enterprise infrastructure. Data collection is enabled by default, allowing your nodes to report activity in real time. This instance is free for 60 days, or you can bring your own license (BYOL).

Use this instance with Chef Workstation installed on your laptop or a separate AWS instance.

Expand All @@ -28,33 +28,87 @@ Use this instance with Chef Workstation installed on your laptop or a separate A

## Installation

Select [Chef Automate](https://aws.amazon.com/marketplace/pp/prodview-r26bs6uknftps?ref_=srh_res_product_title) in the AWS Marketplace.
Select [Chef Automate](https://aws.amazon.com/marketplace/pp/prodview-r26bs6uknftps?) in the AWS Marketplace.

The Chef Automate AWS deployment uses [CloudFormation](https://aws.amazon.com/cloudformation/). [Download the CloudFormation template](https://aws-ami-chef-automate-v2.s3.amazonaws.com/cloudformation_template.yaml) or use the [view the template in CloudFormation Designer](https://console.aws.amazon.com/cloudformation/designer/home?templateURL=https://s3.amazonaws.com/awsmp-fulfillment-cf-templates-prod/658820ac-955d-4f73-bbcd-ab19b598d852/ec282ef4e8434b46a9df737571e1e0ac.template)
The Chef Automate AWS deployment uses [CloudFormation](https://aws.amazon.com/cloudformation/). [Download the CloudFormation template](https://aws-ami-chef-automate-v2.s3.amazonaws.com/cloudformation_template.yaml) or use the [view the template in CloudFormation Designer](https://us-east-1.console.aws.amazon.com/cloudformation/designer/home?region=us-east-1&templateURL=https://s3.amazonaws.com/awsmp-fulfillment-cf-templates-prod/658820ac-955d-4f73-bbcd-ab19b598d852.caadc0d6-b62a-4b83-d9b0-ec685d27c0bc.template)

Every CloudFormation Stack deployment creates a new [Virtual Private Cloud](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) (VPC).

{{< note >}}
AWS provides 5 VPCs for each region. If you require more VPCs, please contact [AWS Support](https://aws.amazon.com/contact-us/).
AWS provides five VPCs for each region. If you require more VPCs, please contact [AWS Support](https://aws.amazon.com/contact-us/).
{{< /note >}}

### Start Chef Automate with CloudFormation

1. Enter the following values for your deployment.
1. Enter the following values for your deployment:

- Stack Name: `Chef-Automate`
- EC2RootVolumeSize: `Default: 40`
- Instance Type:`Default: t2.xlarge`
- KeyName: _Enter your existing keypair_
- SecurityGroupCidrIp: `0.0.0.0/0`
- SubnetCIDR: `10.0.0.0/24`
- VpcCIDR: `10.0.0.0/16`
Stack Name
: `Chef-Automate`

1. Select **Next** and create your Chef Automate deployment. This process can take several minutes.
EC2RootVolumeSize
: `Default: 40`

1. Give Chef Automate an additional five minutes for all the services to start running.
Instance Type
: `Default: t2.xlarge`

![Select next to create stack](/images/StackDetails.png "Stack Details")
KeyName
: _Enter your existing keypair._

SecurityGroupCidrIp
: `0.0.0.0/0`

SubnetCIDR
: `10.0.0.0/24`

VpcCIDR
: `10.0.0.0/16`

1. Select **Next** after entering these values.

1. Configure the CloudFormation stack options:

1. Create a tag for your stack with **Key** set to `Name` and **Value** to `Chef-automate-stack`.

1. Set permissions for your stack:

1. Create an IAM role with `AmazonEC2FullAccess` to enable resource creation using the CloudFormation template.
1. Once that role is created, select the IAM role from the dropdown menu.

1. Configure stack failure options:

AWS provides two stack-failure options:

Roll back all stack resources
: In case of failure, it should rollback all created resources (`Default: Roll back all stack resources`).

Preserve successfully provisioned resources
: In case of failure, it will rollback only failed resources.

1. Configure advanced options:

1. Set the stack policy.

The stack policy defines the update actions that can be performed on resources.`Default: No stack policy`.

1. Set the rollback configuration.

AWS CloudFormation will monitor the state of your application during stack creation and updating. For more information, see [Amazon's documentation on rollback triggers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html).

1. Configure notification options:

Create or attach an AWS Simple Notification Service (SNS) which will send email notifications about the stack creation process.

1. Set the stack creation options:

Timeout
: If specified and stack creation is not completed in that time, CloudFormation will roll back the stack.

Termination Protection
: Termination protection prevents a user from deleting a stack.

1. Select **Next** to create your Chef Automate deployment. This process can take several minutes.

For additional information about these options, see [Amazon's documentation on CloudFormation stack options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html).

## Post-Installation

Expand Down Expand Up @@ -84,26 +138,36 @@ AWS provides 5 VPCs for each region. If you require more VPCs, please contact [A

1. Enter the server name, FQDN, and IP address. Then select **Add Chef Infra Server** to create the server.

- Name: Add Proper Name for the Sever.
- FQDN: It would be the same as Automate FQDN.
- IP Address: Public IP Address of the EC2-Instance.
Name
: Add the name of the Chef Infra Server.

FQDN
: Enter the same as the Chef Automate FQDN.

![Add Chef Infra Server Form](/images/automate/add-chef-server-popup-menu.png)
IP Address
: Public IP address of the EC2 instance.

1. The Chef Infra Server will appear in the list of servers. Select the server and view information about it.
{{< figure src="/images/automate/add-chef-server-popup-menu.png" alt="Add Chef Infra Server Form" width="500" >}}

1. The Chef Infra Server will appear in the list of servers. Selecting the server allows you to view information about it.
![Select a server from the list](/images/chef_automate_single_server.png "Single Server View")

1. Select **Add Chef Organization**.
{{< figure src="/images/chef_automate_add_org_page.png" style="width: 30%;" >}}

1. Enter the following information:

- Name: **demo**
- Admin User: **admin**
- Admin Key: _copy the key from starter kit_
Name
: demo

Admin User
: admin

Admin Key
: _copy the key from starter kit_

1. Select **Add Chef Organization**.
![Select the Add Chef Organization button to complete this action](/images/OrgPageDetails.png)
{{< figure src="/images/OrgPageDetails.png" alt="Select the Add Chef Organization button to complete this actio" width="500" >}}

## AWS Deployment Security

Expand Down
2 changes: 1 addition & 1 deletion content/style_guide/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ term

: You can include more than one definition for a term by starting another line with a colon.

: Adding square brackets and the `(@)` symbol around the term (`[another term](@)`) add a linkable ID to the term.
: Adding square brackets and the `(@)` symbol around the term (`[another term](@)`) adds a linkable ID to the term.

## Tables

Expand Down
50 changes: 39 additions & 11 deletions content/style_guide/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,14 @@ Use the `readfile` shortcode to add files to a page. This could be Markdown text
Markdown doesn't have strict rules about how to process lists. These are things to keep in
mind:

- Make sure you indent sub-list items **2 spaces**.

- To end a list and start another, you need a HTML comment block on a new line
between the lists, flush with the left-hand border. The first list won't end
otherwise, no matter how many blank lines you put between it and the second.

### Bullet Lists

Indent unordered sub-list items **2 spaces**.

- This is a list item
- This is another list item in the same list
- To make a sub-item, indent two spaces.
Expand All @@ -113,7 +113,9 @@ mind:

- And a sub-list after some block-level content

### Numbered Lists
### Ordered Lists

Indent ordered sub-list items **3 spaces**.

1. This is a list item
2. This is another list item in the same list. The number you use in Markdown
Expand All @@ -122,7 +124,7 @@ mind:
3. {{< note >}}
For single-digit numbered lists, using two spaces after the period makes
interior block-level content line up better along tab-stops.
{{< /note >}}
{{< /note >}}

<!-- separate lists -->

Expand All @@ -142,6 +144,39 @@ mind:
"level" as the paragraph and code block above, despite being indented
more.

### Description List

Use description lists to define things like commands, command flags, options, or other terms. For example:

<!-- /* cSpell:disable */ -->

plain text _(term in italics)_
: Ex quis duis deserunt commodo.

`code` _(`code` in italics **and bolded text in italics**)_ **and regular bolded text**
: Reprehenderit eu ex dolore sunt reprehenderit ut consequat amet Lorem pariatur Lorem anim.

term
: Term definition.

[another term](@)
: Another term definition.

You can include multiple paragraphs in a definition if you need to.

: You can include more than one definition for a term by starting another line with a colon.

: Adding square brackets and the `(@)` symbol around the term (`[another term](@)`) adds a linkable ID to the term.

<!-- /* cSpell:enable */ -->

### Checklists

Checklists are technically bullet lists, but the bullets are suppressed by CSS.

- [ ] This is a checklist item
- [x] This is a selected checklist item

### Tab Panels

<!-- markdownlint-disable MD031 -->
Expand Down Expand Up @@ -179,13 +214,6 @@ mind:

<!-- markdownlint-enable MD031 -->

### Checklists

Checklists are technically bullet lists, but the bullets are suppressed by CSS.

- [ ] This is a checklist item
- [x] This is a selected checklist item

## Code Blocks

You can create code blocks two different ways by surrounding the code block with
Expand Down
Binary file removed static/images/StackDetails.png
Binary file not shown.
10 changes: 9 additions & 1 deletion themes/docs-new/assets/sass/typography/_lists.scss
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,16 @@
}

dl {
margin-top: rem-calc(36px);

dt {
margin-top: rem-calc(36px);
em {
font-weight: normal;
}
code {
font-weight: bold;
}
margin-top: 1rem;
}

dd {
Expand Down

0 comments on commit 8d0a567

Please sign in to comment.