swift-server/guides

Guides for building, debugging and deploying Swift Server applications

guides's Issues

document setting up CI: github actions

A guide how to set up github actions to test your projects.

We could mention how to test using nightly / snapshots as well as stable versions.

Some discussion about testing macOS and linux etc?

swift service developer guide

=> choosing observability (logging, metrics, tracing) backendends and integrating them into the service
=> best practices for composition of dependencies (concurrency, observability and beyond)
=> concurrency considerations, avoiding context switches
=> handling crashes and collecting crash reports / backtraces
=> serialization considerations unique to swift
=> security considerations unique to swift

Swift on Server guides

Just want some input before spending time documenting some stuff - I’d like to expand the guides to be much more comprehensive also from a new users starting point.

See eg. https://forums.swift.org/t/the-current-state-of-swift-for-server-and-linux/47732/18 (quite awful)

I think that a lot of this friction could be removed with a better starting point in the documentation and a better starting point from swift.org for Linux. It’s not much that’s needed to make a big difference I think, but want to confirm it’s inline with the ambitions of the repo.

I made a PR for a first trivial restructuring to prepare for adding some more content.

Document memory usage testing, could point to NIO's tools

document how to set up code formatting & linting

guide around crypto and security

integrate the logging guide into one of the main pages that are linked to from the landing page

hard to find anything that is not on or linked to from one of the pages on the "main menu"

Document deploying to EKS

Document setting up Swift plugins in IDEs (Atom etc)

swift library author guide

=> API design and evolution
=> semantic versioning and SwiftPM considerations
=> observability (pull in logging guide, metrics, tracing, etc)
=> cross platform

Document deploying to AWS App Runner

Document how to set up code generation

Showcase the SwiftPM plugins

document architecture of swift based [iOS, macOS] client > server system

Document using AWS App Mesh and Cloud Map for service-to-service communication

document setting up CI: travis

We should document a few platforms where to set up CI testing, travis is also popular and we might document it

Optimizing binary size, for small runtimes (lambda etc)

We have some tricks to strip unused code

Guides like the Ubuntu guide recommend installing Swift 5.2

Swift version information should be updated.

Document using Swift with VSCode

• installing directly
• dev containter
• document any issues to make this easier, and pursue fixing / reporting to swift team as appropriate

document deployment to AWS lambda

perhaps cross post / link to the guides in https://github.com/swift-server/swift-aws-lambda-runtime/

How to approach Issues in this repository

This repository contains a number of tickets, tagged like "guides" etc.

The primary purpose of these is to collect topics we, the server side work group and community, would like to see documented. These tickets are often as much of a "call to action" as a list of things to do.

As a community member, if you see any topic you'd like to help out with, by either documenting it as a guide, or working on it or related topics -- please feel free to share your interest in the issues and reach out to collaborate on those topics!

document deployment to kubernetes

we now have a guide on how to build a docker image with the application, need a more detailed guide for deploying to k8 itself, maybe cross post / link to existing k8 docs and public cloud k8 services like EKS

Document proxy usage with Envoy

document deployment to Azure

Document setting up deployments with AWS Copilot

Document deploying to ECS

Probably with Fargate

Document static linking

@drexin has experience here and can turn this into a guide.

// cc @tomerd

guide for wrapping C APIs

document deployment to GCP

guide for writing high performance systems in swift

=> CoW
=> class vs struct tradeoffs
=> concurrency and locking

Document deploying to AWS Lambda

We probably have this in the runtime README or the plugin etc, but we should make sure it's documented centrally

deployment guide heroku

Would be nice to cover other platforms as well, Heroku is fun and might be useful to add a guide