From 9d911c2358cdb603240956cf0c0dc4c9045bfba8 Mon Sep 17 00:00:00 2001 From: Nick Ferguson Date: Fri, 8 Nov 2024 21:49:54 -0500 Subject: [PATCH] add keywords --- .github/workflows/quality.yml | 14 +++++++++-- .vale.ini | 3 +-- .vscode/tasks.json | 4 +-- docs/antora.yml | 3 ++- docs/modules/ROOT/pages/cloudformation.adoc | 25 +++++++++++-------- docs/modules/ROOT/pages/index.adoc | 11 +++++--- docs/modules/ROOT/pages/kubernetes.adoc | 5 ++-- .../ROOT/partials/txprevent-description.adoc | 1 + 8 files changed, 42 insertions(+), 24 deletions(-) create mode 100644 docs/modules/ROOT/partials/txprevent-description.adoc diff --git a/.github/workflows/quality.yml b/.github/workflows/quality.yml index de754ad..2dbff43 100644 --- a/.github/workflows/quality.yml +++ b/.github/workflows/quality.yml @@ -1,10 +1,20 @@ # This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs -name: Build +name: Quality on: workflow_dispatch: + inputs: + alertLevel: + description: 'Vale Minimum Alert level' + required: true + default: 'error' + type: choice + options: + - suggestion + - warning + - error push: paths: - 'docs/**' @@ -53,7 +63,7 @@ jobs: uses: errata-ai/vale-action@v2.1.0 with: files: docs/ - fail_on_error: false + fail_on_error: true level: ${{ github.event.inputs.alertLevel }} diff --git a/.vale.ini b/.vale.ini index f078ad6..7d920e0 100644 --- a/.vale.ini +++ b/.vale.ini @@ -2,7 +2,7 @@ StylesPath = .vale/styles Vocab = ThreatX -MinAlertLevel = error +MinAlertLevel = warning IgnoredScopes = code, tt, img, url, a, body.id @@ -18,7 +18,6 @@ RedHat.ConfigMap = NO RedHat.Definitions = NO RedHat.Slash = NO RedHat.Spacing = NO -RedHat.Spelling = NO RedHat.TermsSuggestions = NO RedHat.TermsWarnings = NO RedHat.GitLinks = NO diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 5639811..7d12116 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -16,7 +16,7 @@ { "label": "Check AsciiDoc Style", "type": "shell", - "command": "./node_modules/@vvago/vale/bin/vale docs", + "command": "./node_modules/@vvago/vale/bin/vale --minAlertLevel=${input:alertLevel} docs", "group": "test", "presentation": { "reveal": "always", @@ -43,7 +43,7 @@ { "id": "alertLevel", "type": "pickString", - "default": "warning", + "default": "suggestion", "description": "Select the alert level", "options": [ { diff --git a/docs/antora.yml b/docs/antora.yml index 46ae53b..8dcd4ca 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -16,6 +16,7 @@ asciidoc: url-ecr: public.ecr.aws/threatx/raap url-xplat: xplat-production.threatx.io url-gateway: threatx-gateway-production-v1.{url-xplat} + url-repo: https://github.com/ThreatX/threatx-docs-txprevent # Asciidoc attributes experimental: true toclevels: 4 @@ -23,7 +24,7 @@ asciidoc: sectanchors: true sectids: true icons: font - source-highlighter: highlightjs + source-highlighter: highlight.js tip-caption: πŸ’‘ TIP caution-caption: πŸ”₯ CAUTION note-caption: β„Ή NOTE diff --git a/docs/modules/ROOT/pages/cloudformation.adoc b/docs/modules/ROOT/pages/cloudformation.adoc index bb4363c..629b05a 100644 --- a/docs/modules/ROOT/pages/cloudformation.adoc +++ b/docs/modules/ROOT/pages/cloudformation.adoc @@ -1,11 +1,13 @@ = TX Prevent on AWS EC2 : CloudFormation template installation guide +:keywords: ThreatX, documentation, cloudformation, AWS, eBPF // Meta (Asciidoctor) attributes :description: Step-by-step guide to deploying the ThreatX Prevent sensor and control plane services into a Amazon enviroment using a CloudFormation template. :imagesdir: ../images :favicon: images/favicon.png :table-stripes: even // Page Attributes -:page-pdf-filename: tx-prevent-on-aws-ec2-cloudformation-template-installation-guide.pdf +:page-pdf-filename: tx-prevent-on-aws-ec2-cloudformation-template-installation-guide.pdf +:page-module: ROOT :page-category: Installation :tx-prevent-cloudformation-template-url: https://threatx-prevent-cf-template.s3.amazonaws.com/threatx-prevent.yaml :product-params-otel-collector-url: https://otlp-grpc-production.xplat-aml-prod.threatx.io @@ -147,7 +149,7 @@ include::partial$cloudformation-template-params.adoc[] === πŸ“‹ Step-by-Step Console Deployment Instructions -Follow these steps ️to deploy the CloudFormation stack using the AWS Console to create the {product-name} services in your AWS environment. +Follow these steps ️to deploy the CloudFormation stack by using the AWS Console to create the {product-name} services in your AWS environment. ==== 1️⃣ Add the {product-name} CloudFormation Template @@ -173,7 +175,7 @@ __πŸ“ On the πŸ“„ *Specify stack details* Page__ . In the *Stack Name* field, enter: _ThreatXPrevent_ .. NOTE: If you choose to enter a different stack name then it must be 14 characters or less in length. This stack name is used as part of AWS resource tags and some of those have length limitations. -. Provide values for the following parameters. Descriptions of all parameters can be found here: <>. +. Provide values for the following parameters. Descriptions of all parameters can be found here: <>. .. `TenantId` .. `ApiKey` .. `VPC` @@ -182,7 +184,7 @@ __πŸ“ On the πŸ“„ *Specify stack details* Page__ .. `HostedZoneName` .. `KeyName` .. `AnalyzerTags` -. For all other parameters leave the default settings and adjust them only if instructed by ThreatX. +. For all other parameters leave the default settings and adjust them only if instructed by ThreatX. . Select btn:[Next] ==== 3️⃣ Configure the Stack Options @@ -229,6 +231,7 @@ ParameterKey=HostedZoneName,ParameterValue= \ ParameterKey=KeyName,ParameterValue= \ ParameterKey=AnalyzerTags,ParameterValue= ---- + <<< == πŸš€ Runtime Sensor Deployment @@ -260,25 +263,25 @@ docker run -i -p 80:80 -p 50051:50051 \ [cols="2", options="header", width="50%", role=center, title="Network Interface Names", id="network-interfaces"] |==== | Distribution -| Interface +| Interface | Amazon -| enX0 +| enX0 | Amazon -| eth0 +| eth0 | Ubuntu -| enX0 +| enX0 | SUSE -| eth0 +| eth0 | Debian -| enX0 +| enX0 | RHEL -| eth0 +| eth0 |==== TIP: If your distribution is not listed, you can find the correct interface name by running the `ip a` command on the EC2 instance. diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index b91a9cb..54e0bfa 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,10 +1,13 @@ = TX Prevent Documentation :description: Find the right installation guide for your environment and get started with {product-name}. +:keywords: ThreatX, documentation, eBPF, runtime, vulnerability detection +:page-build-date: {build-date} +:!toc: -image::threatx-prevent-control-plane.png[align="center",width="60%",title="TX Prevent on Kubernetes"] +== Introduction -== 🧭 Guides +include::partial$txprevent-description.adoc[] + +image::threatx-prevent-control-plane.png[align="center",width="60%",title="", caption=""] -* link:kubernetes.html[Install on Kubernetes with Helm] -* link:cloudformation.html[Install on AWS EC2 with CloudFormation] diff --git a/docs/modules/ROOT/pages/kubernetes.adoc b/docs/modules/ROOT/pages/kubernetes.adoc index d3debe8..18fa126 100644 --- a/docs/modules/ROOT/pages/kubernetes.adoc +++ b/docs/modules/ROOT/pages/kubernetes.adoc @@ -1,12 +1,13 @@ = TX Prevent on Kubernetes : Helm installation guide :description: Step-by-step guide to deploying the {product-name} sensor and control plane services into a Kuberntes environment. +:table-stripes: even :imagesdir: ../images :favicon: images/favicon.png // Page attributes :page-category: Installation :page-module: ROOT :page-origin-type: git -:page-edit-url: https://github.com/ThreatX/txprevent-docs/edit/main/docs/modules/ROOT/pages/kubernetes.adoc +:page-edit-url: https://github.com/ThreatX/txprevent-docs/edit/1.1/docs/modules/ROOT/pages/kubernetes.adoc :page-product-name: {product-name} :page-pdf-filename: tx-prevent-on-kubernetes-helm-installation-guide.pdf :prereqs-k8s-version: >=1.27.0-0 @@ -262,7 +263,7 @@ NOTE: Each of the _Deployed Sensors_ represents a single instance of an *Analyze The `analyzer.enableSampling` property controls the sampling of API Analyzer events. -When enabled, it caches duplicate API Analyzer Events to reduce the number reported to the ThreatX backend. It is enabled by default to reduce egress traffic +When enabled, it caches duplicate API Analyzer Events to reduce the number reported to the ThreatX backend. It is enabled by default to reduce egress traffic We recommend setting the sampling to `false` when initially testing out a deployment, but then flipping it back to `true` after the deployment has been verified. diff --git a/docs/modules/ROOT/partials/txprevent-description.adoc b/docs/modules/ROOT/partials/txprevent-description.adoc new file mode 100644 index 0000000..496ccac --- /dev/null +++ b/docs/modules/ROOT/partials/txprevent-description.adoc @@ -0,0 +1 @@ +TX Prevent is ThreatX's eBPF-powered API and application vulnerability prevention product with first-class support for Kubernetes environments. \ No newline at end of file