Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Latest commit

 

History

History
117 lines (91 loc) · 5.15 KB

github-actions.md

File metadata and controls

117 lines (91 loc) · 5.15 KB
id title hide_title hide_table_of_contents description tags draft unlisted
github-actions
GitHub Actions - StackQL Deploy
false
false
Documentation for using the StackQL Deploy GitHub Action to automate infrastructure deployment and testing.
false
false

stackql-deploy GitHub Action

The stackql-deploy GitHub Action allows you to execute stackql-deploy commands to deploy or test a stack within your CI/CD pipelines in a GitHub Actions workflow.

Usage

The stackql-deploy GitHub Action will pull the latest stackql-deploy package from the PyPi repository. The action invokes a stackql-deploy command with inputs (detailed below). Here is a basic examplf of using the stackql-deploy GitHub Action in a workflow.

jobs:
  stackql-actions-test:
    name: StackQL Actions Test
    runs-on: ubuntu-latest
    env:
      GOOGLE_CREDENTIALS: ${{ secrets.GOOGLE_CREDENTIALS }} # add additional cloud provider creds here as needed
    
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Deploy a Stack
        uses: stackql/setup-deploy@v1.0.1
        with:
          command: 'build'
          stack_dir: 'examples/k8s-the-hard-way'
          stack_env: 'dev'
          env_vars: 'GOOGLE_PROJECT=stackql-k8s-the-hard-way-demo'

:::note[Provider Authentication]

Authentication to StackQL providers is managed through environment variables sourced from GitHub Actions Secrets. Ensure you configure the necessary secrets in your repository settings to authenticate with your cloud provider(s).

For more information on provider-specific authentication, refer to the setup instructions available in the StackQL Provider Registry Docs.

:::

Inputs

The following inputs can be configured for the stackql-deploy GitHub Action:

Input Description Example
command The stackql-deploy command to run (build or test) build
stack_dir The repository directory containing stackql_manifest.yml and resources examples/k8s-the-hard-way
stack_env The environment to deploy or test (e.g., dev, prod) dev
env_vars (Optional) Environment variables or secrets to import into a stack GOOGLE_PROJECT=stackql-k8s-the-hard-way-demo
env_file (Optional) Environment variables sourced from a file .env.prod
show_queries (Optional) Show the queries executed in the output logs true
log_level (Optional) Set the logging level (INFO or DEBUG, defaults to INFO) DEBUG
dry_run (Optional) Perform a dry run of the operation true
custom_registry (Optional) Custom registry URL to be used for StackQL https://myreg
on_failure (Optional) Action to take on failure (not implemented yet) rollback

Examples

Deploy a Stack

This example shows how to build a stack (located in examples/k8s-the-hard-way) for a development (dev) environment:

jobs:
  stackql-actions-test:
    name: StackQL Actions Test
    runs-on: ubuntu-latest
    env:
      GOOGLE_CREDENTIALS: ${{ secrets.GOOGLE_CREDENTIALS }} # add additional cloud provider creds here as needed
    
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Deploy a Stack
        uses: stackql/setup-deploy@v1.0.1
        with:
          command: 'build'
          stack_dir: 'examples/k8s-the-hard-way'
          stack_env: 'dev'
          env_vars: 'GOOGLE_PROJECT=stackql-k8s-the-hard-way-demo'

Test a Stack

This example shows how to test a stack for a staging (sit) environment:

jobs:
  stackql-actions-test:
    name: StackQL Actions Test
    runs-on: ubuntu-latest
    env:
      GOOGLE_CREDENTIALS: ${{ secrets.GOOGLE_CREDENTIALS }} # add additional cloud provider creds here as needed
    
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Test a Stack
        uses: stackql/setup-deploy@v1.0.1
        with:
          command: 'test'
          stack_dir: 'examples/k8s-the-hard-way'
          stack_env: 'sit'
          env_vars: 'GOOGLE_PROJECT=stackql-k8s-the-hard-way-demo'