Repository Service for TUF Guide

• Introduction
  • Repository Service for TUF
    • RSTUF Components
      • Repository Service for TUF API (RSTUF API)
      • Repository Service for TUF Worker (RSTUF Worker)
      • Repository Service for TUF Command Line (RSTUF CLI)
    • TUF Metadata
• Using RSTUF
  • Adding/Removing artifacts to TUF Metadata
    • Adding artifacts
      • Add artifacts payload
    • Removing artifacts
      • Remove artifacts payload
  • Advanced Usage
    • Managing adding/removing artifacts tasks – call-backs
    • Adding artifacts for back-signing
    • Recovering a compromised key
      • Metadata Update
    • Importing existing artifacts
      • CLI usage
      • Import Artifacts (import-artifacts)
• Signing Keys
  • Root Key(s) (offline)
  • Online Key
  • Generating Keys with RSTUF
• Deployment
  • Deployment Guides
    • Docker
      • Requirements
        • Software and tools
        • Online Key
      • Steps
      • Remove RSTUF deployment
    • Kubernetes
      • Requirements
        • Software and tools
      • Online Key
        • Artifact Management (artifact)
        • Task Management (task)
      • Secrets
        • onlinekey secret
        • postgrespassword secret
        • Applying secrets
      • Volumes
        • rstuf-storage persistent volume
        • rstuf-keystorage persistent volume
        • redis-data persistent volume
        • postgres-data persistent volume
        • Applying Volumes
      • Services
        • redis service
        • postgres service
        • web-metadata
        • rstuf-api
        • Applying services
      • Deployment
        • redis deployment
        • postgres deployment
        • web-metadata deployment
        • rstuf-api deployment
        • rstuf-worker deployment
        • Applying deployment
      • RSTUF Ceremony and Bootstrap
  • Configuration and Setup
    • Service Setup
      • Ceremony and Bootstrap
        • Ceremony
        • Bootstrap
  • Deployment Planning
    • Deployment Configuration
      • Required Infrastructure Services
        • Message Queue/Broker: Redis or RabbitMQ server
        • Result Backend and RSTUF Settings: Redis server
        • Database: Postgres server
        • [Optional] Content Server: Webserver
      • RSTUF
        • RSTUF Worker configuration
        • RSTUF best practices
    • Volumes
      • Repository Service for TUF Worker (RSTUF Worker)
        • LocalStorage [Optional]
        • LocalKeyVault [Optional]
    • Services
    • Networking
• TUF Client
  • TUF client implementation
    • New client
    • Existing client
  • Bootstrap trust

Components documentation

• Repository Service for TUF API
  • Docker Image
    • Getting Started
    • Prerequisities
    • Usage
      • Container Parameters
      • Environment Variables
        • (Required) RSTUF_BROKER_SERVER
        • (Required) RSTUF_REDIS_SERVER
        • (Optional) RSTUF_REDIS_SERVER_PORT
        • (Optional) RSTUF_REDIS_SERVER_DB_RESULT
        • (Optional) RSTUF_REDIS_SERVER_DB_REPO_SETTINGS
        • (Optional) RSTUF_DISABLED_ENDPOINTS
        • (Optional) SECRETS_RSTUF_SSL_CERT
      • Volumes
      • Ports
  • Repository Service for TUF REST API Documentation
    • API Documentation
• Repository Service for TUF Worker
  • Docker Image
    • Getting Started
    • Prerequisities
      • Online Key
    • Usage
      • Container Parameters
      • Environment Variables
        • (Required) RSTUF_BROKER_SERVER
        • (Required) RSTUF_REDIS_SERVER
        • (Required) RSTUF_SQL_SERVER
        • (Optional) RSTUF_REDIS_SERVER_PORT
        • (Optional) RSTUF_REDIS_SERVER_DB_RESULT
        • (Optional) RSTUF_REDIS_SERVER_DB_REPO_SETTINGS
        • (Required) RSTUF_STORAGE_BACKEND
        • (Optional) RSTUF_LOCK_TIMEOUT
        • RSTUF_KEYVAULT_BACKEND
        • (Optional) RSTUF_ONLINE_KEY_DIR
        • (Optional) RSTUF_WORKER_ID
        • (Optional) DATA_DIR
      • Persistent data
      • Customization/Tuning
• Repository Service for TUF CLI
  • Installation
  • Administration (admin)
    • Ceremony (ceremony)
      • Step 1: Configure the Roles
      • Step 2: Load the Online Key
      • Step 3: Load Root Keys
      • Step 4: Validate Configuration
      • Finishing
    • Metadata Management (metadata)
      • update (update)
        • Step 1: Authorization
        • Step 2: Extend Root Expiration
        • Step 3: Root Keys Changes
        • Step 4: Online Key Change
        • Finishing
      • sign (sign)
    • Import Artifacts (import-artifacts)
  • Key Management (key)
    • Key Generation (generate)
    • Key Information (info)
  • Artifact Management (artifact)
    • Artifact Addition (add)
    • Artifact Download (download)
    • Artifact Repository (repository)
  • Task Management (task)
    • Task Information (info)