yamanin/registry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
registry/registry/mossylion/templates/scaleway-instance/README.md
Mossy 24dc52fb17
feat: Add Scaleway Instance Template (#449) 
Co-authored-by: DevCats <christofer@coder.com>
Co-authored-by: Atif Ali <atif@coder.com>
2025-12-31 16:39:08 +05:00

5.6 KiB
Raw Blame History

display_name description icon verified tags
Scaleway Instance A workspace spun up on a Scaleway Instance ../../../../.icons/scaleway.svg false
scaleway
vm
linux

Scaleway Instance Template

This template provisions Coder workspaces on Scaleway cloud instances with full customization options for regions, instance types, operating systems, and storage configurations.

Features

  • Multi-region support: Choose from France (Paris), Netherlands (Amsterdam), or Poland (Warsaw)
  • Flexible instance sizing: Wide range of instance types from development to high-performance computing
  • Multiple OS options: Debian 12/13, Ubuntu 24.04, and Fedora 41
  • Customizable storage: Adjustable disk size with configurable IOPS
  • IPv4 and IPv6 networking: Dual-stack IP configuration for enhanced connectivity

Prerequisites

Scaleway Account Setup

  1. Create a Scaleway account
  2. Create a new project or use an existing one
  3. Generate API credentials:
    • Go to IAM > API Keys in the Scaleway Console
    • Create a new API key
    • Note down the Access Key and Secret Key
    • Copy your Project ID from the project settings
    • Give permissions for BlockStorageFullAccess, ProjectReadOnly, InstancesFullAccess as a starting point

Architecture

This template creates the following resources for each workspace:

Persistent Resources

  • Block Volume: Mounted as user's home directory (preserves all data, configs, and projects)

Ephemeral Resources (destroyed when workspace stops)

  • Scaleway Instance: Virtual machine created fresh on each workspace start
  • IPv4 Address: Routed IPv4 address assigned dynamically
  • IPv6 Address: Routed IPv6 address assigned dynamically
  • Cloud-init Configuration: Automated setup of the Coder agent and persistent storage mounting

Configuration Options

Region Selection

Choose from three available regions:

  • France - Paris (fr-par): Default, lowest latency for European users
  • Netherlands - Amsterdam (nl-ams): Alternative European location
  • Poland - Warsaw (pl-waw): Eastern European option

Instance Types

The template supports a comprehensive range of Scaleway instance types:

Development Instances

  • STARDUST1-S: 1 CPU, 1GB RAM - Basic development
  • DEV1-S/M/L/XL: 2-4 CPUs, 2-12GB RAM - Standard development

Production Instances

  • ENT1 Series: 2-96 CPUs, 8-384GB RAM - Enterprise workloads
  • GP1 Series: 4-48 CPUs, 16-256GB RAM - General purpose
  • PRO2 Series: 2-32 CPUs, 8-128GB RAM - Professional workloads

Specialized Instances

  • L4 Series: GPU-enabled instances for AI/ML workloads
  • COPARM1 Series: ARM64 architecture for specific use cases

Operating System Options

  • Debian 13 (Trixie): Latest Debian release
  • Debian 12 (Bookworm): Stable Debian LTS
  • Ubuntu 24.04 (Noble): Latest Ubuntu LTS
  • Fedora 41: Cutting-edge features and packages

Storage Configuration

  • Home Directory Size: 10-500GB adjustable via slider (your entire home directory)
  • IOPS: 5,000 or 15,000 IOPS options for performance tuning

Template Components

Included Tools

  • VS Code Server: Browser-based IDE with full extension support
  • System Monitoring: CPU, RAM, and disk usage metrics
  • Dotfiles Support: Automatic dotfiles synchronization on workspace start
  • Custom Environment Variables: Pre-configured welcome message

Cloud-init Setup

The template uses cloud-init for:

  • Automatic Coder agent installation and configuration
  • User account setup with proper permissions
  • Persistent home directory mounting (automatic disk partitioning and filesystem creation)
  • Development tools initialization

Usage

Creating a Workspace

  1. Select Template: Choose "Scaleway Instance" from your Coder templates
  2. Configure Region: Pick your preferred Scaleway region
  3. Choose Instance: Select instance type based on your performance needs
  4. Select OS: Pick your preferred operating system
  5. Set Home Directory Size: Adjust storage size (10-500GB) for your persistent home directory
  6. Create: Launch your workspace

Managing Costs

  • VM instances are destroyed when workspace stops (zero compute costs when not in use)
  • IP addresses are released when workspace stops (no static IP charges)
  • Home directory persists on dedicated block volume (small storage cost only)
  • Fresh OS on each workspace start with persistent user data
  • Choose appropriate instance sizes for your workload requirements

Customization

Extending the Template

You can customize this template by:

  1. Adding Software: Modify cloud-init scripts to install additional tools
  2. Custom Modules: Include additional Coder modules from the registry
  3. Network Configuration: Adjust security groups or network settings
  4. Startup Scripts: Add custom initialization logic

Maintenance

Updating Instance Types

To update the available instance types, regenerate the scaleway-config.json file:

scw instance server-type list -o json | jq 'map({name, cpu, gpu, ram, arch})' > scaleway-config.json.json

This pulls the latest instance types from Scaleway and formats them for use in the template.

References