DOCSEARCHbyAlgolia
Submit Docs

LocalOps Documentation

website·Indexed 32 days ago

https://docs.localops.co

Documentation for LocalOps, a platform for managing Kubernetes environments and cloud deployments. Includes guides on connecting cloud providers like AWS, GCP, and Azure, integrating GitHub and GitLab for push-to-deploy, packaging applications with Helm charts, and using the LocalOps CLI for service management and log streaming.

Tokens
71.6K
Snippets
293
Records
514
Agent score
60%

What's inside LocalOps

  1. Overview of ops.json configuration

    The ops.json file allows developers to declaratively define service configurations in a GitHub repository. LocalOps triggers a deployment based on this file. It supports the configuration of init jobs (e.g., database migrations), cron jobs, health checks, cloud dependencies (S3, RDS, SQS), volumes, and sidecar containers.

  2. Overview of LocalOps Internal Developer Platform

    LocalOps is a cloud-native Internal Developer Platform (IDP) designed to help developers offer their code as SaaS, BYOC (Bring Your Own Cloud), On-Prem, or Self-hosted versions on AWS, Google Cloud, Azure, and on-prem environments. It eliminates the need to manually write Dockerfiles, Kubernetes Helm charts, or Terraform/Pulumi scripts. Key features include pre-configured CI/CD pipelines, integrated observability, auto-scaling, auto-healing, and keyless access to cloud resources.

  3. Understand and configure Job services

    A job service in LocalOps is a one-off container designed to execute a specific piece of logic once and then shut down. You can create multiple jobs within a single environment. When creating a job service, ensure the Run command is correctly provided if the Dockerfile's CMD does not point to the intended job script.

  4. Extend LocalOps environments with additional cloud resources

    LocalOps provisions a standard set of resources for every environment: 1 VPC, 3 private subnets, 3 public subnets, and a managed Kubernetes cluster (EKS in AWS). To create additional resources (e.g., RDS, Queues, Topics) that can be accessed privately by your services, you can use the VPC and Subnet IDs provided in the LocalOps environment dashboard. These resources can be created manually via the cloud console or automated using IaC tools.

  5. Implement single-tenant dedicated infrastructure with LocalOps

    LocalOps allows SaaS companies to provide dedicated, isolated infrastructure for specific customers (single-tenant) within the vendor's own cloud account. This model provides data and compute isolation (separate VPCs, compute pools, and databases) without the complexity of manual one-off stacks or the overhead of full Bring Your Own Cloud (BYOC) deployments. It is particularly useful for regulated industries, high-security use cases, or premium enterprise plans.

  6. Understand LocalOps no-downtime deployment behavior

    LocalOps employs a no-downtime deployment strategy. When new code is deployed, the system starts new containers first. Old containers are only stopped once the new containers are confirmed to be healthy.

  7. Manage user access levels with LocalOps roles

    LocalOps uses three distinct roles to control account-wide access and resource permissions. You must assign one of these roles when inviting a new user to the account.

  8. Implement a BYOC (Bring Your Own Cloud) distribution model with LocalOps

    A BYOC deployment allows SaaS vendors to install their application inside a customer's own AWS, GCP, or Azure account. This is used to meet data residency, compliance, and security requirements where customer data must remain within their own account and isolated from other tenants. LocalOps facilitates this by providing standardized environments, GitOps-compatible deployments, region-aware provisioning, and full-stack observability across multiple customer cloud accounts.

  9. Build the Angular Docker image

    Build the Docker image using the following command. Use the --platform flag when targeting a specific architecture (e.g., linux/amd64 for cloud deployment). This flag can be omitted for local testing.
    docker build --platform linux/amd64 -t angular-app:latest .

  10. Use built-in observability in LocalOps

    LocalOps environments include a pre-integrated observability stack, removing the need for external log drains or monitoring add-ons:

    • Metrics: Prometheus collects CPU, memory, disk, and network metrics, visualized via Grafana dashboards.
    • Logs: Loki captures all STDOUT and STDERR logs automatically. Access these via the Grafana dashboard with filtering by namespace, deployment, or labels.

  11. Monitor environment metrics using Prometheus and Grafana

    Every environment is pre-installed with Prometheus for recording metrics and Grafana for visualization. Prometheus automatically collects CPU, memory, disk, and network metrics from every node running the application within Kubernetes and sends them to Grafana.

  12. Install LocalOps CLI natively on Windows via binaries

    To install LocalOps CLI natively on Windows, download the binary matching your processor architecture. If unsure of your architecture, run echo $env:PROCESSOR_ARCHITECTURE in PowerShell (AMD64 requires the amd64 build; ARM64 requires the arm64 build).

    1. Download the appropriate zip:
      • Windows x86_64 / amd64 (Intel/AMD)
      • Windows arm64 (Surface Pro X, Copilot+ PCs)
    2. Extract the binary to a folder (e.g., $HOME\localops).
    3. Add the folder to your user PATH to run the ops command from any directory.
    4. Restart your terminal for PATH changes to take effect.
    # Extract the binary (example for amd64)
cd $HOME\Downloads
Expand-Archive -Path .\ops-windows-amd64.zip -DestinationPath $HOME\localops -Force

# Add to User PATH
[Environment]::SetEnvironmentVariable(
  'Path',
  [Environment]::GetEnvironmentVariable('Path', 'User') + ';' + "$HOME\localops",
  'User'
)

# Verify installation
ops version