Content Index

A back-of-book topic index for the docs: find where a subject is covered by keyword, including common synonyms. For a guided, narrative table of contents see docs/README.md; for the full grammar/reference of a feature, follow the links below.

• How to use: scan for the term you’d search for (e.g. “mTLS”, “secret naming”, “buildArgs”, “SSO”). Each entry points to the specific doc and section.
• Tip: in most editors Ctrl/Cmd-F on this page jumps straight to a keyword.

Maintainers: this index is curated. When you add a doc or a major section, add a line here so the subject stays findable.

---

A

• Access control / access modifier (public vs private) — Permissions, CDK: IAM Roles
• Admin UIs (pgAdmin, Mongo Express) — Env vars: Admin UIs
• AI pipeline generation (prompt → pipeline) — Developer Guide: AI Prompt, API: AI Generation, AI Plugins
• Ambient mesh — see Service mesh → Service Mesh
• API reference (REST endpoints) — API Reference
• Architecture / system diagram / data flow — Architecture Flow, Service topology
• Artifact passing between steps — CDK: Artifact Passing, Artifact & Registry Plugins
• Audit events / audit log / tamper-evidence — Audit Events, Integrity, Action catalog
• Authentication (login, JWT, OAuth) — Authentication & SSO, Env vars: Authentication
• AWS deployment — AWS Deployment, EC2, EKS
• AWS Marketplace (metering, private offers) — Billing Discounts: Marketplace, Env vars: Marketplace metering

B

• Backups & disaster recovery — Deploy Operations: Backups & DR
• Billing (plans, usage, credits) — Organization Benefits: Billing, Env vars: Billing
• Bundles / add-on packs (seats, pipelines, API) — Billing Add-on Bundles
• buildArgs (Docker build args, templatable) — Templates: build plugin with buildArgs
• BuildKit (rootless) / why rootless — Env vars: Why rootless BuildKit
• Build queue (BullMQ / KEDA scaling) — Env vars: Build Queue, Mesh: Queues, KEDA & buildkit
• Build types (Dockerfile vs shared base) — Architecture: Build Types, Plugins: Build Types
• BuilderProps (pipeline JSON shape) — CDK: BuilderProps Reference, Architecture: BuilderProps Structure

C

• Caching (server-side) — Env vars: Caching
• CDK construct / Infrastructure-as-Code — CDK Usage Guide, Infrastructure Plugins
• CLI (pipeline-manager) — Pipeline Manager (CLI), Command reference
• CodeBuild step configuration — Metadata Keys: CodeBuild Step
• CodeCommit source — CDK: CodeCommit
• CodePipeline configuration — Metadata Keys: CodePipeline
• CodeStar connection (GitHub/Bitbucket/GitLab) — CDK: CodeStar Connection
• Compliance / policy-as-code / rules — Compliance Service, Rule Schema, Enforcement
• Compute size (LARGE/MEDIUM) — Developer Guide: Custom Compute Size, Metadata Keys: Build Environment
• Cross-account deployment — CDK: Cross-Account Deployments
• Cron / scheduled operator audits, drift — Pipeline Manager: Schedule drift detection

D

• Databases (Postgres, Mongo, Redis config) — Env vars: Databases
• Deploy plugins (cloud, k8s, serverless) — Deploy Plugins
• Deployment modes (public vs private) — AWS Deployment: Deployment modes
• Deploy operations runbook — Deploy Operations
• Developer guide / getting started (dev) — Developer Guide, Five ways to create a pipeline
• Developer portal (catalog ownership, scorecards) — Developer Portal
• Discounts / promo codes / referrals — Billing Discounts, Promotions
• Docker registry (config, tags) — Env vars: Docker Registry, Registry audit events
• DORA metrics (deploy freq, lead time, MTTR, CFR) — DORA Metrics, Performance levels
• Build health (per-pipeline stage success rate + timing percentiles) — DORA Metrics: Build health
• Drift detection (CloudFormation stacks) — AWS Deployment: Drift Detection

E

• EBS volume / expanding storage — AWS Deployment: Expanding EBS Volume
• EC2 deployment — AWS Deployment: EC2
• EKS deployment — AWS Deployment: EKS, EKS vs other k8s targets
• Egress (external, allow-any) — Service Mesh: External egress
• Email / SES (sending, bounces, sandbox) — AWS Deployment: Email (SES), Env vars: Email
• Event reporting / setup-events (EventBridge → SQS → Lambda) — Onboarding: Set up event reporting, AWS: EventBridge Reporting
• Encryption (per-team secret, KMS) — Metadata Keys: Encryption, Env vars: Multi-team secret encryption
• Environment variables (full reference) — Environment Variables
• Error handling / typed errors / error catalog — Error Handling Convention, Template error catalog
• Exemptions (compliance waivers) — Compliance: Exemptions

F

• Failure behavior (fail / warn / ignore) — Developer Guide: Failure Behavior Options
• Feature tiers (developer/pro/team/enterprise) — Docs: Feature Tiers, Organization Benefits
• Filters (template | default, | number, | bool, | json) — Templates: Filters

G

• GitHub source / token — CDK: GitHub, Samples: GitHub source token
• Golden-path templates (reusable starters) — Developer Portal: Golden-path templates, Templates: Golden pipeline templates
• Grammar (template syntax) — Templates: Grammar

I

• IAM roles (pipeline / step / action, OIDC) — CDK: IAM Roles, Metadata Keys: IAM Role, Samples: IAM Role Levels
• Infrastructure plugins (CDK synth, multi-region) — Infrastructure Plugins
• Initialize platform (post-deploy) — AWS Deployment: Initialize the Platform, Docs: Post-Deploy
• Interpolation (mixed literal + ``) — Templates: Grammar, plugin pipeline.* interpolation
• Isolation (multi-team / per-org) — Architecture: Multi-Team Isolation, Plugins: Multi-Organization Isolation
• Istio — see Service mesh → Service Mesh (Istio Ambient)

K

• KEDA (autoscaling the build queue) — Service Mesh: Queues, KEDA & buildkit
• Kiali (mesh visualization, optional) — Service Mesh: Optional Kiali
• Kubernetes deploy plugins — Deploy Plugins: Kubernetes

L

• Incident webhook (PagerDuty/Datadog/Alertmanager → automated CFR + MTTR) — Incident Webhook, Correlation window
• Incident reporting setup (admin UI, self-serve token, per-org window) — Admin UI, Getting a token, Per-org window
• Incident webhook — Alertmanager adapter (native payload) — Alertmanager adapter
• Language plugins / version managers — Language Plugins
• Lead time (DORA caveat) — DORA Metrics: Lead Time caveat
• LEAN mode (trim footprint — minikube & ec2) — Service Mesh: LEAN mode

M

• Metadata keys (all scopes) — Metadata Keys, Scope Levels
• Monitoring plugins — Monitoring Plugins
• mTLS (mutual TLS between services) — Service Mesh: mTLS posture
• Multi-region strategies (sequential/parallel/canary) — Infrastructure Plugins: Multi-Region
• Multi-team / RLS context — Env vars: Multi-team RLS context

N

• Network / VPC configuration — CDK: VPC and Network, Metadata Keys: Network
• Notifications (Slack, email, alerts) — Compliance: Notifications, Notification Plugins, Developer Guide: Slack Notifications

O

• OAuth / social login — Authentication: OAuth social login, Env vars: OAuth
• OIDC (enterprise SSO, IAM role trust) — Authentication: Per-org SSO (OIDC), CDK: Role Types
• Onboarding a new organization (initial login → PAT → events) — Onboarding
• Organizations / teams / hierarchy — Docs: Organizations, Organization Benefits, Permissions: Teams

P

• Pagination & limits — Env vars: Pagination & Limits, API: Common Query Parameters
• PAT / Personal Access Token (CLI/automation credential) — Onboarding: Create a PAT, Pipeline Manager: auth
• Permissions / RBAC / roles — Roles & Permissions, Permission catalog
• Pipeline creation (5 ways) — Developer Guide: Five Ways, Docs: Creating Pipelines
• Plugins (catalog, categories, structure) — Plugin Catalog, Categories, by type: AI · Artifact · Deploy · Infrastructure · Language · Monitoring · Notification · Quality · Security · Testing
• Plugin contract (requiredMetadata / requiredVars / metadataTypes) — Templates: Plugin contract
• Policies (compliance) — Compliance: Policies
• Private vs public deployment — AWS Deployment: Deployment modes
• Promotions / referrals — Billing Discounts: Promotions

Q

• Quality plugins (lint, format, coverage) — Code Quality Plugins
• Quotas & rate limiting — Env vars: Quotas & Rate Limiting

R

• Redis (config, sentinel, HA) — Env vars: Redis
• Registry (Docker image registry, tag copy/delete) — Env vars: Docker Registry, Registry audit events
• Reporting (execution & plugin reports) — AWS Deployment: Report API, API: Reporting Endpoints
• Roles — RBAC (org permissions) — Roles & Permissions; Roles — IAM (AWS) — CDK: IAM Roles
• Rule schema (operators, computed fields) — Compliance: Rule Schema

S

• Samples (pipeline + CDK examples) — Samples, Loading Samples
• Scheduled pipelines (cron/EventBridge) — CDK: Scheduled Pipelines
• Scopes (compliance / metadata scope levels) — Compliance: Scopes, Metadata: Scope Levels
• Secrets — usage & injection — CDK: Secrets Management, Plugins: How Secrets Work, Env vars
• Service token (store-token, JWT in Secrets Manager) — Onboarding: Store the service token, AWS: Store Service Credentials
• Secret naming convention (pipeline-builder/{orgId}/{name}) — Plugins: Naming Convention
• Secrets — rotation runbook — Deploy Operations: Rotation runbook
• Security plugins (SAST, SCA, secret detection) — Security Plugins
• Self-references (pipeline.json cross-refs) — Templates: pipeline-level self-references
• Service mesh (Istio ambient, mTLS, AuthZ) — Service Mesh, also AWS / Ops
• Session invalidation (token revocation) — Permissions: Session invalidation
• SSE / Server-Sent Events — Env vars: Server-Sent Events
• SSO (single sign-on) — see OAuth / OIDC → Authentication & SSO
• Stages and steps — CDK: Stages and Steps
• Storage requirements (disk sizing) — AWS Deployment: Storage (EC2), Storage (EKS)
• Synth-time templating — see Templates → Templates: Process overview

T

• Teams (org → team hierarchy, seats) — Docs: Teams, Permissions: Teams
• Teardown (destroy a deployment) — AWS: EC2 Teardown, Deploy Operations: Teardown
• Templates — syntax (``, vars, scopes) — Template Syntax, Scope reference
• Templates — golden pipeline (starters) — Templates: Golden pipeline templates
• Testing plugins (unit, e2e, load, smoke) — Testing Plugins
• Timeouts (build, upload chain) — Env vars: Timeouts
• TLS (certs, renewal) — AWS: EC2 TLS, EKS TLS Renewal
• Troubleshooting — AWS Deployment, Service Mesh, Templates

V

• Variables / vars (pipeline-level template variables) — Templates: Scope reference, pipeline-level self-references
• Version management (plugin versions) — Plugins: Version Management
• VPC / network — CDK: VPC and Network

---

Documents at a glance

Document	Covers
README	Narrative TOC — getting started, guides, key concepts
api-reference	REST endpoints per service, query params, response format
architecture-flow	End-to-end flows: plugin build, pipeline create, synth, execution
audit-events	Audit action catalog, integrity, sensitive-data scrubbing
authentication	OAuth social login, per-org enterprise SSO (OIDC)
aws-deployment	EC2 & EKS deploy, public/private modes, SES, reporting
billing-bundles	Stackable add-on packs raising pooled caps
billing-discounts	Discount codes, promotions, referrals, Marketplace offers
cdk-usage	BuilderProps, sources, IAM, VPC, secrets, cross-account
compliance	Policy-as-code rules, scans, enforcement, exemptions
content-index	This page — keyword/topic index
deploy-operations	Ops runbook: preflight, secrets rotation, backups, teardown
developer-guide	Five ways to create a pipeline, plugin cut-and-paste patterns
developer-portal	Catalog ownership, golden-path templates, scorecards
dora-metrics	Deploy freq, lead time, MTTR, change-fail rate, build health
incidents-webhook	Incident webhook → automated post-deploy CFR + real MTTR
environment-variables	Every env var by subsystem
error-handling	Typed AppError convention
metadata-keys	All aws:cdk:* and step/pipeline metadata keys
onboarding	New-org walkthrough: initial login → org → members → PAT → store-token → setup-events → first pipeline
organization-benefits	Value story, orgs/teams/billing, impact by role
permissions	RBAC model, permission catalog, enforcement, sessions
pipeline-manager	CLI install, commands, workflows
plugins/README	Plugin catalog, secrets, structure, versioning
samples	Language pipeline samples + CDK examples
service-mesh	Istio ambient, mTLS, L4 authorization, egress
templates	`` synth-time templating, scopes, filters, golden templates