DOCSEARCHbyAlgolia
Submit Docs

Northflank Documentation

website·Indexed 37 days ago

https://northflank.com/docs

A full-stack cloud platform to build, deploy, and scale code, jobs, and databases. Documentation covers Git integration with GitHub, GitLab, Bitbucket, and Azure DevOps, building with Dockerfiles or buildpacks, managing production workloads, and programmatic control via the Northflank API and CLI.

Tokens
1.5M
Snippets
5.3K
Records
9.1K
Agent score
65%

What's inside Northflank

  1. Overview of Northflank Log Sinks

    v1
    Log sinks allow you to forward logs from containers in specific projects or your entire account to external log aggregators and observability platforms. This enables unified log processing, real-time alerting, and auditing. Supported destinations include managed services (Datadog, Loki, Papertrail, Mezmo, Better Stack, Honeycomb, Logz.io, New Relic, Axiom), AWS S3, and custom HTTP endpoints.

  2. Overview of CI/CD on Northflank

    v1
    Northflank provides tools to manage application delivery from development to production. It supports two primary patterns: simple CI/CD enabled on individual services for automatic builds and deployments from a repository, or complex release processes using environments and workflows to orchestrate multiple resources.

  3. Overview of Northflank platform capabilities

    v1

    Northflank is a full-stack cloud platform designed to build, deploy, and scale code, jobs, and databases. Key capabilities include:

    • Code Deployment: Supports any language/framework via Dockerfile or buildpacks. Integrates with GitHub, GitLab, and Bitbucket for automatic deployments on commit or specific branch/PR rules.
    • Container Registry Support: Deploy Docker images from external registries like Docker Hub, Google Container Registry, or GitHub Packages.
    • Add-on Services: One-click deployment of databases and services such as MinIO and RabbitMQ.
    • Scheduled Workloads: Run code on a schedule or manually using cron and manual jobs (via repository or Docker image).
    • Environment Management: Create dedicated development, staging, and production environments using pipelines with one-click promotion between stages.
    • Configuration: Save groups of build and runtime variables for inheritance and use templating for dynamic variables.
    • Collaboration: Team accounts with real-time UI updates and granular role-based access control (RBAC).

  4. Overview of Northflank programmatic management tools

    v1
    Northflank provides three primary ways to build, deploy, and scale infrastructure (code, jobs, and databases) in real-time: a REST API, a Command Line Interface (CLI), and a JavaScript client.

  6. Overview of Northflank platform capabilities

    v1

    Northflank is a platform for building, deploying, and scaling code. Key capabilities include:

    • Build & Run: Build code from Git repositories using Docker or buildpacks, and deploy services or jobs from builds and container registries.
    • Release Management: CI/CD configuration, release flows, and pipeline management.
    • Infrastructure: Support for Infrastructure as Code (IaC) via templates and the ability to 'Bring Your Own Cloud' (BYOC) to use Northflank features on other cloud providers.
    • Specialized Workloads: Support for GPU workloads (AI/ML/HPC) and stateful workloads using integrated databases and persistent storage.
    • Operations: Observability (logs, metrics, health checks), scaling of resources and instances, and domain management.
    • Networking & Security: Configuration of public/private ports, IP policies, basic authentication, MFA, secret injection, and Role-Based Access Control (RBAC).
    • Collaboration: Team invitations and RBAC for the application and API.

  7. Overview of GPU deployment options on Northflank

    v1

    Northflank supports GPU access for services and jobs to handle high-performance computing tasks such as AI, ML, data analysis, simulations, and graphics rendering. Users can choose between two primary deployment models:

    1. Northflank Managed Cloud: Create GPU-enabled projects and pay only for consumed resources without managing Kubernetes clusters.
    2. Bring Your Own Cloud (BYOC): Deploy and manage GPU-enabled nodes on other cloud providers. This allows users to maintain control over infrastructure and billing while using Northflank for deployment. For AWS clusters, Capacity Blocks can be used via launch templates to reserve GPU nodes for specific time periods.

  8. Overview of Northflank notification integrations

    v1
    Northflank allows you to create integrations with external services to receive alerts for platform events such as backups, job runs, billing events, and infrastructure alerts (container crashes, high CPU/memory usage, or limited volume space). Notifications can be configured at the Organisation, Account, or Team level.

  9. Overview of Northflank Enterprise features

    v1

    Northflank Enterprise provides contractual uptime guarantees (99.99% SLA), direct engineering support via a dedicated Slack channel, and advanced capabilities for security, compliance, and infrastructure. Key feature areas include:

    • Compliance & Risk: SSO/SAML, SCIM/JIT provisioning, audit logs (platform and infrastructure), WAF/DDoS protection, workload identities, and microVM-based sandboxing.
    • Platform API & White Labeling: Ability to white-label the platform, VCS, notifications, and workload domains. Supports GitHub Enterprise and Azure DevOps (including PAT linking).
    • Infrastructure: Org-level clusters, custom AWS launch templates, managed Ceph CSI drivers, multi read-write volumes, and TLS passthrough mode.
    • Disaster Recovery: High-frequency backup schedules, custom backup/dump destinations, and global disaster recovery across regions.

  10. Overview of Managed External Addons

    v1
    Managed external addons are preconfigured OpenTofu resources used to simplify the setup of common cloud resources (e.g., Amazon S3 Buckets, Amazon RDS). Unlike regular addons, external addons are hosted in your own cloud account. They provide infrastructure-as-code benefits while exposing a simplified subset of configuration fields for easier management.

  11. Overview of Infrastructure as Code (IaC) on Northflank

    v1
    Northflank uses templates as its primary Infrastructure as Code (IaC) primitive. Templates allow developers to define resources, services, databases, pipelines, and integrations programmatically. They can be created using a visual drag-and-drop node editor or written directly in JSON. Templates are repeatable, versionable, and can be triggered manually or automatically.

  12. Overview of GitOps on Northflank

    v1
    GitOps on Northflank enables the management of infrastructure, releases, and deployments using templates stored in a Git repository. It features bidirectional synchronization: changes made to a template in the Git repository are automatically reflected in Northflank, and changes made within the Northflank UI are committed back to the repository upon saving. This ensures a single source of truth for infrastructure and release flows.