Page not found :(
+The requested page could not be found.
+| Repository Name | +More Info | +
|---|---|
| {{repo.repo-name}} | ++ + {{ repo.name }} - {{ repo.description }} + + | +
+ {% if page.last_modified_date %} {{ page.last_modified_date | date: + "%Y-%m-%d"}} | {% else %} 2022-07-01 | {% endif %} ๐ {{ wordCount }} words + | โฑ {{readTime}} mins {% if site.gh_edit_link and site.gh_edit_link_text and + site.gh_edit_repository and site.gh_edit_branch and site.gh_edit_view_mode + %} | + ๐งพ History + + {% endif %} | {% if page.author %} โ {{page.author}} {% else %} โ Ross + Buggins {% endif %} | {% if page.owner %} ๐ {{page.owner}} {% else %} ๐ + Ross Buggins {% endif %} +
+ ++ {% for tag in page.tags %}{{tag}},{% endfor %} +
+ + {% if wordCount < wordWarning %} ++ ๐ง This page has less that {{wordWarning}} words. So it looks like this page + is still under construction. +
+ {% endif %} {% if page.description %} +{{page.description}}
+ {% endif %} {% if page.todo or is_draft %} +Known Issues / Todo
+ +{{ page.summary }}
+ {% else %} +Error: File not found: #{@markup}
[| no | -## Modules -No modules. ## Outputs | Name | Description | |------|-------------| | [log\_subscription\_role\_arn](#output\_log\_subscription\_role\_arn) | The ARN of the log subscription IAM role. | + diff --git a/infrastructure/terraform/modules/s3bucket/README.md b/infrastructure/terraform/modules/s3bucket/README.md index 8e0e793..c596e57 100644 --- a/infrastructure/terraform/modules/s3bucket/README.md +++ b/infrastructure/terraform/modules/s3bucket/README.md @@ -2,11 +2,13 @@ + ## Requirements | Name | Version | |------|---------| | [terraform](#requirement\_terraform) | >= 1.9.0 | + ## Inputs | Name | Description | Type | Default | Required | @@ -31,9 +33,7 @@ | [public\_access](#input\_public\_access) | Object representing the public access rules of the bucket |
"AWS::CloudWatch::Metric",
"AWS::Logs::LogGroup"
]
object({
block_public_acls = bool
block_public_policy = bool
ignore_public_acls = bool
restrict_public_buckets = bool
}) | {
"block_public_acls": true,
"block_public_policy": true,
"ignore_public_acls": true,
"restrict_public_buckets": true
} | no |
| [region](#input\_region) | The AWS Region | `string` | n/a | yes |
| [versioning](#input\_versioning) | Toggle for versioning the bucket. Defaults to true | `bool` | `true` | no |
-## Modules
-No modules.
## Outputs
| Name | Description |
@@ -47,6 +47,7 @@ No modules.
| [id](#output\_id) | The ID of the S3 bucket |
| [policy](#output\_policy) | The policy of the S3 bucket |
| [region](#output\_region) | The AWS region where the S3 bucket is located |
+
diff --git a/infrastructure/terraform/modules/sqs/README.md b/infrastructure/terraform/modules/sqs/README.md
index a898c54..7510278 100644
--- a/infrastructure/terraform/modules/sqs/README.md
+++ b/infrastructure/terraform/modules/sqs/README.md
@@ -2,11 +2,13 @@
+
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.9.0 |
+
## Inputs
| Name | Description | Type | Default | Required |
@@ -35,9 +37,7 @@
| [sqs\_kms\_key\_arn](#input\_sqs\_kms\_key\_arn) | ARN of the KMS key to encrypt SQS queue messages | `string` | n/a | yes |
| [sqs\_policy\_overload](#input\_sqs\_policy\_overload) | Optional additional policy to extend the SQS Resource Policy | `string` | `""` | no |
| [visibility\_timeout\_seconds](#input\_visibility\_timeout\_seconds) | The visibility timeout for the queue. An integer from 0 to 43200 (12 hours) | `number` | `300` | no |
-## Modules
-No modules.
## Outputs
| Name | Description |
@@ -52,6 +52,7 @@ No modules.
| [sqs\_queue\_oldest\_message\_alarm\_arn](#output\_sqs\_queue\_oldest\_message\_alarm\_arn) | The ARN of the CloudWatch alarm for oldest visible message age in the SQS queue |
| [sqs\_queue\_oldest\_message\_alarm\_name](#output\_sqs\_queue\_oldest\_message\_alarm\_name) | The name of the CloudWatch alarm for oldest visible message age in the SQS queue |
| [sqs\_queue\_url](#output\_sqs\_queue\_url) | The URL of the SQS queue |
+
diff --git a/infrastructure/terraform/modules/ssl/README.md b/infrastructure/terraform/modules/ssl/README.md
index d7ecda3..3d3a41d 100644
--- a/infrastructure/terraform/modules/ssl/README.md
+++ b/infrastructure/terraform/modules/ssl/README.md
@@ -2,12 +2,14 @@
+
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.10.1 |
| [tls](#requirement\_tls) | 4.1.0 |
+
## Inputs
| Name | Description | Type | Default | Required |
@@ -25,9 +27,7 @@
| [subject\_organization](#input\_subject\_organization) | Organization for certificate subject | `string` | `"NHS England"` | no |
| [subject\_organizational\_unit](#input\_subject\_organizational\_unit) | Organizational unit for certificate subject | `string` | `"NHS Notify"` | no |
| [subject\_province](#input\_subject\_province) | Province for certificate subject | `string` | `"West Yorkshire"` | no |
-## Modules
-No modules.
## Outputs
| Name | Description |
@@ -35,6 +35,7 @@ No modules.
| [cacert\_pem](#output\_cacert\_pem) | Truststore |
| [server\_crt](#output\_server\_crt) | Server Certificate |
| [server\_key](#output\_server\_key) | Server Key |
+
diff --git a/scripts/config/terraform-docs.yml b/scripts/config/terraform-docs.yml
index e49d91f..9151101 100644
--- a/scripts/config/terraform-docs.yml
+++ b/scripts/config/terraform-docs.yml
@@ -11,10 +11,13 @@ sections:
content: |-
{{ .Header }}
+
{{ .Requirements }}
+
{{ .Inputs }}
- {{ .Modules }}
+
{{ .Outputs }}
+
{{ .Footer }}
output:
diff --git a/scripts/config/vale/styles/config/vocabularies/words/accept.txt b/scripts/config/vale/styles/config/vocabularies/words/accept.txt
index f02f1fa..88d99fc 100644
--- a/scripts/config/vale/styles/config/vocabularies/words/accept.txt
+++ b/scripts/config/vale/styles/config/vocabularies/words/accept.txt
@@ -1,28 +1,39 @@
[A-Z]+s
+[Bb]undler
Bitwarden
bot
Cognito
+config
Cyber
Dependabot
draw.io
drawio
endcapture
endfor
+endif
endraw
+external_markdown
+fmt
+frontmatter
Git[Hh]ub
GitHub
Gitleaks
Grype
idempotence
Jira
+markdownlint
+npm
OAuth
Octokit
onboarding
Podman
Python
rawContent
+relative_url
+[Rr]epo
sed
Syft
-Terraform
toolchain
+Trivy
Trufflehog
+[Tt]erraform
diff --git a/scripts/docker/examples/python/.tool-versions.example b/scripts/docker/examples/python/.tool-versions.example
deleted file mode 100644
index 9209311..0000000
--- a/scripts/docker/examples/python/.tool-versions.example
+++ /dev/null
@@ -1,2 +0,0 @@
-# python, SEE: https://hub.docker.com/_/python/tags
-# docker/python 3.11.4-alpine3.18@sha256:0135ae6442d1269379860b361760ad2cf6ab7c403d21935a8015b48d5bf78a86
diff --git a/scripts/docker/examples/python/Dockerfile b/scripts/docker/examples/python/Dockerfile
deleted file mode 100644
index d0780aa..0000000
--- a/scripts/docker/examples/python/Dockerfile
+++ /dev/null
@@ -1,33 +0,0 @@
-# `*:latest` will be replaced with a corresponding version stored in the '.tool-versions' file
-# hadolint ignore=DL3007
-FROM python:latest as base
-
-# === Builder ==================================================================
-
-FROM base AS builder
-COPY ./assets/hello_world/requirements.txt /requirements.txt
-WORKDIR /packages
-RUN set -eux; \
- \
- # Install dependencies
- pip install \
- --requirement /requirements.txt \
- --prefix=/packages \
- --no-warn-script-location \
- --no-cache-dir
-
-# === Runtime ==================================================================
-
-FROM base
-ENV \
- LANG="C.UTF-8" \
- LC_ALL="C.UTF-8" \
- PYTHONDONTWRITEBYTECODE="1" \
- PYTHONUNBUFFERED="1" \
- TZ="UTC"
-COPY --from=builder /packages /usr/local
-COPY ./assets/hello_world /hello_world
-WORKDIR /hello_world
-USER nobody
-CMD [ "python", "app.py" ]
-EXPOSE 8000
diff --git a/scripts/docker/examples/python/Dockerfile.effective b/scripts/docker/examples/python/Dockerfile.effective
deleted file mode 100644
index 3f1ea6b..0000000
--- a/scripts/docker/examples/python/Dockerfile.effective
+++ /dev/null
@@ -1,54 +0,0 @@
-# `*:latest` will be replaced with a corresponding version stored in the '.tool-versions' file
-FROM python:3.11.4-alpine3.18@sha256:0135ae6442d1269379860b361760ad2cf6ab7c403d21935a8015b48d5bf78a86 as base
-
-# === Builder ==================================================================
-
-FROM base AS builder
-COPY ./assets/hello_world/requirements.txt /requirements.txt
-WORKDIR /packages
-RUN set -eux; \
- \
- # Install dependencies
- pip install \
- --requirement /requirements.txt \
- --prefix=/packages \
- --no-warn-script-location \
- --no-cache-dir
-
-# === Runtime ==================================================================
-
-FROM base
-ENV \
- LANG="C.UTF-8" \
- LC_ALL="C.UTF-8" \
- PYTHONDONTWRITEBYTECODE="1" \
- PYTHONUNBUFFERED="1" \
- TZ="UTC"
-COPY --from=builder /packages /usr/local
-COPY ./assets/hello_world /hello_world
-WORKDIR /hello_world
-USER nobody
-CMD [ "python", "app.py" ]
-EXPOSE 8000
-
-# === Metadata =================================================================
-
-ARG IMAGE
-ARG TITLE
-ARG DESCRIPTION
-ARG LICENCE
-ARG GIT_URL
-ARG GIT_BRANCH
-ARG GIT_COMMIT_HASH
-ARG BUILD_DATE
-ARG BUILD_VERSION
-LABEL \
- org.opencontainers.image.base.name=$IMAGE \
- org.opencontainers.image.title="$TITLE" \
- org.opencontainers.image.description="$DESCRIPTION" \
- org.opencontainers.image.licenses="$LICENCE" \
- org.opencontainers.image.url=$GIT_URL \
- org.opencontainers.image.ref.name=$GIT_BRANCH \
- org.opencontainers.image.revision=$GIT_COMMIT_HASH \
- org.opencontainers.image.created=$BUILD_DATE \
- org.opencontainers.image.version=$BUILD_VERSION
diff --git a/scripts/docker/examples/python/VERSION b/scripts/docker/examples/python/VERSION
deleted file mode 100644
index 8acdd82..0000000
--- a/scripts/docker/examples/python/VERSION
+++ /dev/null
@@ -1 +0,0 @@
-0.0.1
diff --git a/scripts/docker/examples/python/assets/hello_world/app.py b/scripts/docker/examples/python/assets/hello_world/app.py
deleted file mode 100644
index 4844e89..0000000
--- a/scripts/docker/examples/python/assets/hello_world/app.py
+++ /dev/null
@@ -1,12 +0,0 @@
-from flask import Flask
-from flask_wtf.csrf import CSRFProtect
-
-app = Flask(__name__)
-csrf = CSRFProtect()
-csrf.init_app(app)
-
-@app.route("/")
-def index():
- return "Hello World!"
-
-app.run(host='0.0.0.0', port=8000)
diff --git a/scripts/docker/examples/python/assets/hello_world/requirements.txt b/scripts/docker/examples/python/assets/hello_world/requirements.txt
deleted file mode 100644
index d36bdce..0000000
--- a/scripts/docker/examples/python/assets/hello_world/requirements.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-blinker==1.6.2
-click==8.1.7
-Flask-WTF==1.2.0
-Flask==3.1.3
-itsdangerous==2.1.2
-Jinja2==3.1.6
-MarkupSafe==2.1.3
-pip==26.0
-setuptools==65.5.1
-Werkzeug==3.1.6
-wheel==0.46.2
-WTForms==3.0.1
diff --git a/scripts/docker/examples/python/tests/goss.yaml b/scripts/docker/examples/python/tests/goss.yaml
deleted file mode 100644
index 589db37..0000000
--- a/scripts/docker/examples/python/tests/goss.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-package:
- python:
- installed: true
-
-command:
- pip list | grep -i flask:
- exit-status: 0
- timeout: 60000