Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
code_samples/java/** linguist-generated=true
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ assertation
JavaScript
Autoconfigure
requester(?('s))
rewrap(?(s))
rewrap(?(s))
ABAC
2 changes: 2 additions & 0 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ jobs:

- name: Install dependencies
run: npm ci
- name: Download latest OpenAPI specs
run: npm run update-vendored-yaml
- name: Build website
run: npm run build

Expand Down
96 changes: 96 additions & 0 deletions .github/workflows/docker-compose-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Docker Compose Stack Test

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:

jobs:
test-stack:
runs-on: ubuntu-latest
timeout-minutes: 15

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Add hosts entries
run: |
echo -e "127.0.0.1 platform.opentdf.local\n127.0.0.1 keycloak.opentdf.local" | sudo tee -a /etc/hosts

- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3

- name: Setup Docker's apt repository
run: |
# Add Docker's official GPG key:
sudo apt update
sudo apt install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
sudo tee /etc/apt/sources.list.d/docker.sources <<EOF
Types: deb
URIs: https://download.docker.com/linux/ubuntu
Suites: $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}")
Components: stable
Signed-By: /etc/apt/keyrings/docker.asc
EOF

sudo apt update

- name: Install Docker Compose
run: |
sudo apt-get update
sudo apt-get install -y docker-compose-plugin
docker compose version

- name: Start Docker Compose stack
working-directory: docs/getting-started
run: |
docker compose up -d

- name: Wait for platform health check
run: |
echo "Waiting for platform to be ready..."
timeout=300 # 5 minutes in seconds
elapsed=0
interval=15

while [ $elapsed -lt $timeout ]; do
echo "Checking health endpoint (${elapsed}s elapsed)..."

# Use -k to allow insecure connections (self-signed cert)
# Use -s for silent mode, -w for response code
response=$(curl -k -s -w "\n%{http_code}" https://platform.opentdf.local:8443/healthz 2>/dev/null || echo "")

if [ -n "$response" ]; then
http_code=$(echo "$response" | tail -n1)
body=$(echo "$response" | head -n1)

echo "HTTP Code: $http_code"
echo "Response Body: $body"

if [ "$http_code" = "200" ] && echo "$body" | grep -q '"status":"SERVING"'; then
echo "✓ Platform is ready!"
exit 0
fi
fi

sleep $interval
elapsed=$((elapsed + interval))
done

echo "✗ Timeout waiting for platform to become ready"
exit 1

- name: Show container logs on failure
if: failure()
working-directory: docs/getting-started
run: |
docker compose ps
docker compose logs
40 changes: 29 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,36 +1,54 @@
# Generated content from OpenAPI specs
specs/
specs-processed/
docs/OpenAPI-clients/
docs/reference/OpenAPI-clients/

# Generated content (legacy - can be removed if no longer used)
docs/SDK-Samples/

# Remote Content - Generated by docusaurus-plugin-remote-content
# Specifications from opentdf/spec repo
/docs/reference/trusted-data-format/specifications/index.md
/docs/reference/trusted-data-format/specifications/**/*.md
/docs/reference/trusted-data-format/specifications/**/_category_.json
# CLI documentation from opentdf/otdfctl repo
/docs/explanation/platform-architecture/components/cli/
# Platform configuration from opentdf/platform repo
/docs/how-to/getting-started/configuration.md
# Static images from opentdf/spec repo
/static/img/ecc_and_binding.svg
/static/img/nanotdf.svg
/static/img/symmetric_and_payload.svg
/static/img/filecontents.svg

# Dependencies
/node_modules
node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader
# Ignore all generated _category_.json files in docs/spec
/docs/spec/**/_category_.json
docs/.index.json
*.backup

# Misc
.DS_Store
# Environment files
.env.local
.env.development.local
.env.test.local
.env.production.local

# Logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
node_modules

# Ignore Remote Content
/docs/spec/index.md
/docs/spec/**/*.md
/docs/components/cli/
/docs/getting-started/configuration.md
# macOS
.DS_Store



/.idea/

Expand Down
Loading