How To¶

Welcome to the How To section! Here you will find all necessary information to leverage fabric-cicd. If there is any missing information, raise a documentation issue on GitHub.

Contents¶

• Getting Started
  • Installation
  • Authentication
  • Directory Structure
  • GIT Flow
• Configuration Deployment
  • Overview
  • Configuration File Setup
    • Core Settings
    • Publish Settings
    • Unpublish Settings
    • Features Setting
    • Constants Setting
  • Environment-Specific Values
    • Required vs Optional Fields
    • Selective Environment Configuration
    • Logging Behavior
  • Sample config.yml File
  • Configuration File Deployment
    • Basic Usage
    • Custom Authentication
    • Configuration Override
  • Troubleshooting Guide
• Parameterization
  • Overview
  • Parameter Inputs
    • find_replace
    • key_value_replace
    • spark_pool
    • semantic_model_binding
  • Advanced Find and Replace
    • find_value Regex
    • Dynamic Replacement
    • Environment Variable Replacement
    • File Filters
    • _ALL_ Environment Key in replace_value
  • Optional Fields
    • Case-Insensitive Matching
      • ignore_case
    • Regex Pattern Match
      • is_regex
    • Supported File Filters
      • item_type
      • item_name
      • file_path
  • Parameter File Validation
  • Parameter File Templates
  • Sample Parameter File
  • Examples by Item Type
    • Notebooks
      • find_replace Parameterization Case
      • Advanced find_replace Parameterization Case
      • TSQL Notebook with SQL Endpoint Parameterization Case
    • Data Pipelines
      • key_value_replace Parameterization Case
    • Schedules
      • key_value_replace Parameterization Case
    • Environments
      • spark_pool Parameterization Case
    • Dataflows
      • Parameterization Overview
      • Parameterization Guidance
      • Advanced find_replace Parameterization Case
    • Reports
      • Parameterization Overview
      • find_replace Parameterization Case
      • key_value_replace Parameterization Case
    • Paginated Reports
      • find_replace Parameterization Case
• Optional Features
  • Feature Flags
  • Debugging
  • Bulk Publish
    • How it works
    • Authentication Requirements
    • Automatic Fallback to Standard Publish
    • Other Limitations
  • Selective Deployment Features
    • Folder-Level Filtering
    • Item-Level Filtering
    • Filter Precedence
    • Lakehouse Shortcut Filtering
  • Git-Based Change Detection
• Troubleshooting
  • Debugging Deployments
    • Enable Debug Logging
    • Testing Deployments Locally
    • Sample Workspace Directory
    • Understanding Error Logs
      • Accessing API Traces
      • Example Error Log Entry
    • Common Issues and Solutions
      • Authentication Failures
      • Item Deployment Failures
      • Bulk Publish Failures
      • Parameter Substitution Issues
      • Private Link Connection Failures
      • API Rate Limiting
    • Debug Scripts
      • debug_local.py
      • debug_local config.py
      • debug_parameterization.py
      • debug_api.py
      • debug_trace_deployment.py
  • Getting Help
  • Additional Resources