Skip to main content

Quick Start

Get up and running with Sluice in under 5 minutes.

Quick Start

This guide will help you create your first CI/CD pipeline with Sluice.

Prerequisites

Before you begin, make sure you have:

  • A Sluice account (sign up at sluice.dev)
  • A Git repository with your application code
  • Docker installed locally (for local builds)

Step 1: Create a Pipeline

  1. Navigate to the Pipelines page in your dashboard
  2. Click Create Pipeline
  3. Enter a name for your pipeline (e.g., “my-app-pipeline”)
  4. Click Create

Step 2: Configure Your Pipeline

Once your pipeline is created, you’ll see the pipeline editor. Add stages to define your workflow:

Add a Source Stage

The source stage defines where your code comes from:

name: source
type: source
config:
  repository: https://github.com/your-org/your-repo
  branch: main

Add a Build Stage

The build stage creates a container image from your code:

name: build
type: build
config:
  dockerfile: ./Dockerfile
  context: .
  image: your-registry/your-app
  tag: '{{.Version}}'

Add a Deploy Stage

The deploy stage pushes your application to Kubernetes:

name: deploy
type: deploy
config:
  type: kubernetes
  namespace: production
  manifests:
    - ./k8s/deployment.yaml
    - ./k8s/service.yaml

Step 3: Save and Run

  1. Click Save to save your pipeline configuration
  2. Click Run Pipeline to trigger a manual run
  3. Monitor the progress in the run details view

Step 4: Set Up Webhooks (Optional)

To trigger pipelines automatically when you push code:

  1. Go to your pipeline’s Settings tab
  2. Copy the Webhook URL
  3. Add the webhook to your Git repository settings
  4. Select events like “Push” and “Pull Request”

Next Steps