Skip to content

Commit

Permalink
[APT-1699] Add link to docs for CIS compliant services (#230)
Browse files Browse the repository at this point in the history
* [APT-1699] Add link to docs for CIS compliant services

This refactors the Modal component into a general purpose one, and introduces
two custom flavors for displaying 'subscription required' notices of general
and CIS flavor. These two types of modals appear independently, and we track
the warning preferences for each.

* Regenerate docs with new docs-sourcer
  • Loading branch information
ebeneliason authored Mar 24, 2022
1 parent 8c2e620 commit 4f904b2
Show file tree
Hide file tree
Showing 39 changed files with 330 additions and 175 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.0"/>

# Amazon ECS Cluster


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/ecs-cluster" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/ecs-cluster" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Fecs-cluster" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -836,5 +836,5 @@ The CloudWatch Dashboard metric widget for the ECS cluster workers' Memory utili


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"a815cd878c403173ad13acb9c63c1e67"}
{"sourcePlugin":"service-catalog-api","hash":"78d7b40f248256164ef928cba33cd3a4"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.66.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.66.0"/>

# Amazon ECS Fargate Cluster


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/ecs-fargate-cluster" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/ecs-fargate-cluster" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Fecs-fargate-cluster" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -159,5 +159,5 @@ The name of the ECS cluster.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"9e62fb0f1f86b9023d6916a9ce211f84"}
{"sourcePlugin":"service-catalog-api","hash":"901668771669b87221faec37cea88dea"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.0"/>

# Amazon ECS Service


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/ecs-service" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/ecs-service" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Fecs-service" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -1318,5 +1318,5 @@ The names of the ECS service's load balancer's target groups


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"36da9325a5bfd779d7672900d4710a51"}
{"sourcePlugin":"service-catalog-api","hash":"a2d359f3c099ae386aeb5f1ac2eee542"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.84.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.84.0"/>

# Amazon EKS Core Services


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/eks-core-services" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/eks-core-services" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Feks-core-services" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -897,5 +897,5 @@ Name of the CloudWatch Log Group used to store the container logs.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"e462345e2656af39b09cf7f8d15449d2"}
{"sourcePlugin":"service-catalog-api","hash":"bb540d28afefb55027edc87bbf0a1986"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.0"/>

# Amazon EKS Workers


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/eks-workers" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/eks-workers" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Feks-workers" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -1154,5 +1154,5 @@ The list of names of the ASGs that were deployed to act as EKS workers.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"72b20e5751be8aeed0c0aebc815c0497"}
{"sourcePlugin":"service-catalog-api","hash":"753dd3928d0cc35804b78a0053ffcb1b"}
##DOCS-SOURCER-END -->
6 changes: 3 additions & 3 deletions docs/reference/services/app-orchestration/amazon-eks.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.0"/>

# Amazon EKS


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/eks-cluster" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/eks-cluster" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Feks-cluster" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -1585,5 +1585,5 @@ The ID of the AWS Security Group associated with the self-managed EKS workers.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"91dc3965d8d3289738189c21c478508e"}
{"sourcePlugin":"service-catalog-api","hash":"d5adf775136815202f1c2f7945d59ba7"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.0"/>

# Auto Scaling Group


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/asg-service" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/asg-service" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Fasg-service" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -892,5 +892,5 @@ The ID of the Security Group that belongs to the ASG.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"6e0fe67e4011f23a7194fdcf2847ea68"}
{"sourcePlugin":"service-catalog-api","hash":"ed918f42fef483fbbee6b6ebabd5942c"}
##DOCS-SOURCER-END -->
6 changes: 3 additions & 3 deletions docs/reference/services/app-orchestration/ec-2-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.84.4"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.84.4"/>

# EC2 Instance


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/ec2-instance" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/ec2-instance" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Fec2-instance" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -681,5 +681,5 @@ The input parameters for the EBS volumes.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"82cb1593fa3f63a7da97b27b3bc4eeca"}
{"sourcePlugin":"service-catalog-api","hash":"e213b1d2b53d679f78d15b17c0247e97"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.83.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.83.0"/>

# Kubernetes Namespace


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/k8s-namespace" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/k8s-namespace" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Fk8s-namespace" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -263,5 +263,5 @@ The name of the rbac role that grants read only permissions on the namespace.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"59292fa9e2371a98e1ce702c193d839a"}
{"sourcePlugin":"service-catalog-api","hash":"41f809a48c8b79255cb879730763f7b4"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.0"/>

# Kubernetes Service


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/k8s-service" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/k8s-service" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Fk8s-service" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -925,5 +925,5 @@ Number of seconds to wait for Pods to become healthy before marking the deployme


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"6d7e1ee238bf4d10a59ff0a46d345aea"}
{"sourcePlugin":"service-catalog-api","hash":"7cf1f72106874d7645d701df03de2f3a"}
##DOCS-SOURCER-END -->
26 changes: 23 additions & 3 deletions docs/reference/services/app-orchestration/lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.1"/>

# Lambda


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/lambda" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/lambda" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Flambda" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -361,6 +361,26 @@ The function entrypoint in your code. This is typically the name of a function o
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="iam_policy" requirement="optional" type="map">
<HclListItemDescription>

An object defining the policy to attach to `iam_role_name` if the IAM role is going to be created. Accepts a map of objects, where the map keys are sids for IAM policy statements, and the object fields are the resources, actions, and the effect ('Allow' or 'Deny') of the statement. Ignored if `iam_role_arn` is provided. Leave as null if you do not wish to use IAM role with Service Accounts.

</HclListItemDescription>
<HclListItemTypeDetails>

```hcl
map(object({
resources = list(string)
actions = list(string)
effect = string
}))
```

</HclListItemTypeDetails>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="image_uri" requirement="optional" type="string">
<HclListItemDescription>

Expand Down Expand Up @@ -762,5 +782,5 @@ Latest published version of your Lambda Function


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"c3091f9fb46ecb27b84c21fcaf82ca0f"}
{"sourcePlugin":"service-catalog-api","hash":"40d26f388b45e61002d060c10a39d218"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.83.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.83.0"/>

# Public Static Website


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/public-static-website" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/services/public-static-website" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=services%2Fpublic-static-website" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -332,5 +332,5 @@ The ARN of the created S3 bucket associated with the website.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"6bd75027a663f966af6140b2289c4408"}
{"sourcePlugin":"service-catalog-api","hash":"a635ae7b0fc5b40276b30f0dc3772c23"}
##DOCS-SOURCER-END -->
6 changes: 3 additions & 3 deletions docs/reference/services/ci-cd-pipeline/ecs-deploy-runner.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.0"/>

# ECS Deploy Runner


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/mgmt/ecs-deploy-runner" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/mgmt/ecs-deploy-runner" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=mgmt%2Fecs-deploy-runner" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -1107,5 +1107,5 @@ Security Group ID of the ECS task


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"8865e555bfc21258727130ef0564a7a0"}
{"sourcePlugin":"service-catalog-api","hash":"3038344db7fcee0a09110df54f042e23"}
##DOCS-SOURCER-END -->
6 changes: 3 additions & 3 deletions docs/reference/services/ci-cd-pipeline/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import TabItem from '@theme/TabItem';
import VersionBadge from '../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue } from '../../../../src/components/HclListItem.tsx';

<VersionBadge version="0.85.0" lastModifiedVersion="0.85.0"/>
<VersionBadge version="0.85.1" lastModifiedVersion="0.85.0"/>

# Jenkins CI Server


<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/mgmt/jenkins" className="link-button">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/master/modules/mgmt/jenkins" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-service-catalog/releases?q=mgmt%2Fjenkins" className="link-button" title="Release notes for only the service catalog versions which impacted this service.">Release Notes</a>

Expand Down Expand Up @@ -848,5 +848,5 @@ The ID of the Security Group attached to the Jenkins EC2 Instance


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"service-catalog-api","hash":"aa5db15404ec1af2a6d8f33bc43a2f56"}
{"sourcePlugin":"service-catalog-api","hash":"e41872c31946588df431c65c6a167877"}
##DOCS-SOURCER-END -->
Loading

0 comments on commit 4f904b2

Please sign in to comment.