gotodeploy / cdk-valheim

A high level CDK construct of Valheim dedicated server.

cdk-valheim

A high level CDK construct of Valheim dedicated server.

Features

• Fargate cluster to run a Valheim server, with EFS for persistence (schedulable)
• Hourly AWS Backup with 3 days retention (customizable)
• lloesche/valheim-server as the default container image (replaceable)

See integration test for an example.

API Doc

See API.md

References

• On-demand, serverless Valheim server setup with AWS CDK, Discord Interactions and GitLab CI
• Grantapher/discord-cdk-valheim

Examples

The construct is published to both npm and PyPI.

TypeScript

new ValheimWorld(stack, 'ValheimWorld', {
  cpu: 2048,
  memoryLimitMiB: 4096,
  schedules: [{
    start: { hour: '12', weekDay: '1-5' },
    stop: { hour: '1', weekDay: '1-5' },
  }],
  environment: {
    SERVER_NAME: 'CDK Valheim',
    WORLD_NAME: 'Amazon',
    SERVER_PASS: 'fargate',
    BACKUPS: 'false',
  },
});

Python

ValheimWorld(
    self, 
    'ValheimWorld',   
    cpu=2048,
    memory_limit_mib=4096,
    schedules=[ValheimWorldScalingSchedule(
        start=CronOptions(hour='12', week_day='1-5'),
        stop=CronOptions(hour='1', week_day='1-5'),
    )],
    environment={
        'SERVER_NAME': 'CDK Valheim',
        'WORLD_NAME': 'Amazon',
        'SERVER_PASS': 'fargate',
        'BACKUPS': 'false',
    })

Testing

• Unit test and snapshot test

npx projen test

• Integration test

npx cdk -a "npx ts-node src/integ.valheim.ts" diff
npx cdk -a "npx ts-node src/integ.valheim.ts" deploy

cdk-valheim's Issues

Container image should be replaceable

Why

The mount point of container is fixed and immutable. This makes container image not fully replaceable.

TODO

• Add containerPath prop to ValheimWorldProps

Support CDK from 1.x to 2.x

Fargate platform version can be LATEST after March 8, 2021

According to PHD, the default platform version of Fargate is changing from 1.3.0 to 1.4.0.

chore: Add pypi release

Use DataSync for moving world data between S3 and EFS

Thanks for providing this great construct! I have used it recently to setup a dedicated server and it is working well. Would it make sense to add DataSync tasks to sync data between EFS and an S3 bucket where world data can be uploaded? How would you recommend moving world data stored on local machine to EFS?

A comment says opening TCP but it's actually UDP

Valheim needs UDP ports from 2456 to 2458 to be opened. Below should be fixed.

    // Allow TCP 2456-2458 for Valheim
    this.service.connections.allowFrom(ec2.Peer.anyIpv4(), ec2.Port.udpRange(2456, 2458));

Support scaleIn/scaleOut scheduling

Summary

• To reduce running cost, scheduling server start/stop should be configuarable from props
  • BackupPlan should follow above config

Add discord slash command support for ondemand fargate task control

Slash Commands for the Fargate cluster

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ecs.html

• Task status checker
  • /vh status
• desiredCount modifier
  • /vh start
  • /vh stop

Reporting a vulnerability

Hello!

I hope you are doing well!

We are a security research team. Our tool automatically detected a vulnerability in this repository. We want to disclose it responsibly. GitHub has a feature called Private vulnerability reporting, which enables security research to privately disclose a vulnerability. Unfortunately, it is not enabled for this repository.

Can you enable it, so that we can report it?

Thanks in advance!

PS: you can read about how to enable private vulnerability reporting here: https://docs.github.com/en/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository

Set default cpu value from 512 to 1024

Summary

.5 cpu is not enough. Below are metrics of my test server.

512 cpu

1024 cpu

adminlist.txt should be injectable easily

In the cron expression of weekDay, the possible range of numbers is 1 - 7

Add AWS Backup for EFS

Add a parameter for custom log group

Log groups should be handled by users.

chore: Fix broken GitHub workflow badge

In README.md, the URL for status badge of GitHub workflow has been changed. c.f. badges/shields#8671

https://img.shields.io/github/actions/workflow/status/gotodeploy/cdk-valheim/build.yml?branch=main

Add a detailed feature description, badges and an python example to the README.md

Features

• Fargate cluster + EFS + AWS backup
• Scheduling start/stop (+ backup)
• Fully replaceable container image

Badges

https://shields.io/

Python example

cdk_valheim.ValheimWorld(
    self, 
    'ValheimWorld',   
    cpu=2048,
    memory_limit_mib=4096,
    schedules=[cdk_valheim.ValheimWorldScalingSchedule(
        start=CronOptions(hour='12', week_day='1-5'),
        stop=CronOptions(hour='1', week_day='1-5'),
    )],
    environment={
        "SERVER_NAME": 'CDK Valheim',
        "WORLD_NAME": 'Amazon',
        "SERVER_PASS": 'fargate',
        "BACKUPS": 'false',
    })

Rename members of ValheimWorldScalingSchedule

Breaking chenges:

• startAt => start
• stopAt => stop

EFS encryption should be false by default

For backward compatibility, EFS encryption should not be enabled.