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

Reorganize reusable text files #985

Merged
merged 3 commits into from
Jan 22, 2024
Merged

Reorganize reusable text files #985

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
85a463c
Reorganize reusable text files
IanMadd Dec 20, 2023
dd6a690
Update archetype file
IanMadd Dec 21, 2023
73f89f5
Additional formatting
IanMadd Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
22 changes: 17 additions & 5 deletions docs-chef-io/archetypes/resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Use the `{{ .Name }}` Chef InSpec audit resource to test the configuration of...

For additional information, including details on parameters and properties, see the [AWS documentation on the `AWS::RESOURCE::NAME` resource]().

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -46,15 +46,15 @@ end

## Examples

**EXAMPLE DESCRIPTION**
Example description.

```ruby
describe {{ .Name }} do
#...
end
```

**EXAMPLE DESCRIPTION**
Example description.

```ruby
describe {{ .Name }} do
Expand All @@ -64,7 +64,19 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### <MATCHER_NAME>

Matcher description.

```ruby
describe {{ .Name }} do
# matcher example
end
```

## AWS Permissions

Expand Down
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/aws_alb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Use the `aws_alb` InSpec audit resource to test properties of a single AWS Appli

For additional information, including details on parameters and properties, see the [AWS documentation on Elastic Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -117,9 +117,9 @@ end

## Matchers

This InSpec audit resource has no special matchers.
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

{{% inspec_matchers_link %}}
This resource has the following special matchers.

### exist

Expand All @@ -141,6 +141,6 @@ end

## AWS Permissions

{{% aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}}
{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}}

You can find detailed documentation at [Authentication and Access Control for Your Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-authentication-access-control.html)
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/aws_albs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Use the `aws_albs` InSpec audit resource to test the configuration of a collecti

For additional information, including details on parameters and properties, see the [AWS documentation on Elastic Load Balancing](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -84,9 +84,9 @@ end

## Matchers

This InSpec audit resource has no special matchers.
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

{{% inspec_matchers_link %}}
This resource has the following special matchers.

### exist

Expand All @@ -103,6 +103,6 @@ end

## AWS Permissions

{{% aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}}
{{% inspec-aws/aws_permissions_principal action="ElasticLoadBalancing:Client:DescribeLoadBalancers" %}}

You can find detailed documentation at [Authentication and Access Control for Your Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/load-balancer-authentication-access-control.html)
10 changes: 6 additions & 4 deletions docs-chef-io/content/inspec/resources/aws_ami.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Use the `aws_ami` InSpec audit resource to test properties of a single AWS AMI.

For additional information, including details on parameters and properties, see the [AWS documentation on EC2 Amazon Machine Images](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -129,7 +129,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### be_public

Expand Down Expand Up @@ -167,6 +169,6 @@ end

## AWS Permissions

{{% aws_permissions_principal action="EC2:Client:DescribeImages" %}}
{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeImages" %}}

You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html).
10 changes: 6 additions & 4 deletions docs-chef-io/content/inspec/resources/aws_amis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ parent = "inspec/resources/aws"

Use the `aws_amis` InSpec audit resource to test properties of some or all AWS AMIs.

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -190,7 +190,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

This resource has the following special matchers.

### exist

Expand All @@ -212,6 +214,6 @@ end

## AWS Permissions

{{% aws_permissions_principal action="EC2:Client:DescribeImages" %}}
{{% inspec-aws/aws_permissions_principal action="EC2:Client:DescribeImages" %}}

You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html).
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/aws_amplify_app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Use the `aws_amplify_app` InSpec audit resource to test the properties of a sing

For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify App](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -98,9 +98,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

The controls will pass if the `get` method returns at least one result.
This resource has the following special matchers.

### exist

Expand Down Expand Up @@ -132,4 +132,4 @@ end

## AWS Permissions

{{% aws_permissions_principal action="Amplify:Client:GetAppResult" %}}
{{% inspec-aws/aws_permissions_principal action="Amplify:Client:GetAppResult" %}}
8 changes: 4 additions & 4 deletions docs-chef-io/content/inspec/resources/aws_amplify_apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Use the `aws_amplify_apps` InSpec audit resource to test the properties of Multi

For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify App](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -125,7 +125,7 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

The controls will pass if the `List` method returns at least one result.

Expand Down Expand Up @@ -159,4 +159,4 @@ end

## AWS Permissions

{{% aws_permissions_principal action="Amplify:Client:ListAppsResult" %}}
{{% inspec-aws/aws_permissions_principal action="Amplify:Client:ListAppsResult" %}}
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/aws_amplify_branch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Use the `aws_amplify_branch` InSpec audit resource to test the properties of a s

For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify Branch](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -102,9 +102,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

The controls will pass if the `get` method returns at least one result.
This resource has the following special matchers.

### exist

Expand Down Expand Up @@ -136,4 +136,4 @@ end

## AWS Permissions

{{% aws_permissions_principal action="Amplify:Client:GetBranchResult" %}}
{{% inspec-aws/aws_permissions_principal action="Amplify:Client:GetBranchResult" %}}
8 changes: 4 additions & 4 deletions docs-chef-io/content/inspec/resources/aws_amplify_branches.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Use the `aws_amplify_branches` InSpec audit resource to test the properties of m

For additional information, including details on parameters and properties, see the [AWS documentation on AWS Amplify branch](https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -126,7 +126,7 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

The controls will pass if the `list` method returns at least one result.

Expand Down Expand Up @@ -160,4 +160,4 @@ end

## AWS Permissions

{{% aws_permissions_principal action="Amplify:Client:ListBranchesResult" %}}
{{% inspec-aws/aws_permissions_principal action="Amplify:Client:ListBranchesResult" %}}
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/aws_api_gateway_deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource

For additional information, including details on parameters and properties, see the [AWS ApiGateway Deployment documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -80,9 +80,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

The controls will pass if the `get` method returns at least one result.
This resource has the following special matchers.

### exist

Expand Down Expand Up @@ -114,4 +114,4 @@ end

## AWS Permissions

{{% aws_permissions_principal action="APIGateway:Client:Deployment" %}}
{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:Deployment" %}}
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/aws_api_gateway_deployments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The AWS::ApiGateway::Deployment resource deploys an API Gateway RestAPI resource

For additional information, including details on parameters and properties, see the [AWS ApiGateway Deployment documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -60,9 +60,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

The controls will pass if the `get` method returns at least one result.
This resource has the following special matchers.

### exist

Expand Down Expand Up @@ -94,4 +94,4 @@ end

## AWS Permissions

{{% aws_permissions_principal action="APIGateway:Client::Deployments" %}}
{{% inspec-aws/aws_permissions_principal action="APIGateway:Client::Deployments" %}}
10 changes: 5 additions & 5 deletions docs-chef-io/content/inspec/resources/aws_api_gateway_documentation_part.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part f

For additional information, including details on parameters and properties, see the [AWS ApiGateway Documentation Part](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html).

## Installation
## Install

{{% inspec_aws_install %}}
{{< readfile file="content/inspec/resources/reusable/md/inspec_aws_install.md" >}}

## Syntax

Expand Down Expand Up @@ -83,9 +83,9 @@ end

## Matchers

{{% inspec_matchers_link %}}
{{< readfile file="content/inspec/reusable/md/inspec_matchers_link.md" >}}

The controls will pass if the `get` method returns at least one result.
This resource has the following special matchers.

### exist

Expand Down Expand Up @@ -117,4 +117,4 @@ end

## AWS Permissions

{{% aws_permissions_principal action="APIGateway:Client:DocumentationPart" %}}
{{% inspec-aws/aws_permissions_principal action="APIGateway:Client:DocumentationPart" %}}
Loading