scaf provides developers and DevOps engineers with a complete blueprint for a new project and streamlines the development experience with Tilt.
scaf generates a new project structure with Kubernetes manifests in three Kustomize layers for dev, sandbox, and production. A new project contains the following:
- NextJS or React frontend
- Django backend
- Postgres database for local development
- CloudNativePG deployment for production
- Redis
- Mailhog
- ArgoCD
- Traefik
- Certmanger
- Certificates and Ingress Routes
- Kube Prometheus Stack
- Grafana Loki
- GitHub and Bitbucket pipelines to build and push images, run security, formatting and linting checks
- Terraform config to set up a k3s cluster on AWS
Installation is supported on Linux and macOS:
curl -sSL https://raw.githubusercontent.com/sixfeetup/scaf/main/install.sh | sh
The installation script will install kubectl, kind, and Tilt if it can't be found on your system.
Run scaf myproject, answer all the questions, and you'll have your new project!
Inside myproject/README.md, you will have more
documentation explaining how to use and configure your newly created project.
To deploy your project using Terraform and AWS, you can follow the instructions in terraform/README.md.
Note that you will need:
- an AWS account where you have access to the
OrganizationAccountAccessRole - terraform, and AWS CLI installed and configured
Scaf provides a Nix Flake to install all the required packages for development. The Nix Flake ensures all developers are using the same versions of all packages to develop on Scaf in an isolated environment.
Follow the instructions to install Nix for your OS.
Nix Flakes are a feature that comes with Nix, but they are considered experimental and are not enabled by default in stable releases of Nix. To use Nix Flakes, you need to enable them by configuring your Nix installation to allow experimental features.
- Ensure you have a recent version of Nix installed:
Nix Flakes are available in recent versions of Nix. You can check your Nix version using:
nix --versionIf you need to install or update Nix, you can follow the instructions on the Nix installation page.
- Enable experimental features:
You need to enable the experimental features in your Nix configuration. To do this, add the following lines to your ~/.config/nix/nix.conf file. If the file doesn't exist, you can create it:
experimental-features = nix-command flakes- Using Nix Flakes:
Once you have enabled the experimental features, you can use Nix Flakes with the nix command. For example:
nix flake showThis command will display information about the flake in the current directory if you have a flake.nix file.
Finally, install Direnv and run direnv allow. The
direnv configuration in .envrc will use the flake to install the required
packages.
When making changes to scaf, keep the following in mind:
- update pins in requirements/*.in files but *don't* commit the compiled requirements.txt files to the repo.
- update to the latest Python supported by Django. For Django 4.1, this is 3.8, 3.9, and 3.10.
To test the cookiecutter portion of scaf, create virtual environment ad install black, isort and cookiecutter. Create a test cookiecutter.yaml file with the following content:
---
default_context:
author_name: Joe Sixie
aws_account_id: "000000000000"
aws_region: us-east-1
create_nextjs_frontend: y
debug: n
description: Behold My Awesome Project!
domain_name: sixfeetup.com
email: joe-sixie@sixfeetup.com
mail_service: Mailgun
project_dash: my-awesome-sixie-project
project_name: My Awesome Sixie Project
project_slug: my_awesome_sixie_project
repo_name: my_awesome_sixie_project
repo_url: git@github.com:sixfeetup/my_awesome_sixie_project.git
source_control_organization_slug: sixfeetup
source_control_provider: github.com
timezone: US/Eastern
use_celery: n
use_graphql: y
use_sentry: n
version: 0.1.0
Then create a helper script to run the tests:
#! /bin/bash
SCAF_ROOT=/Users/gfranxman/sfu/ScafDev/scaf
OUTPUT_FOLDER=./scaf-test
TEST_CONFIG=./scaf-cookiecutter.yaml
rm -rf $OUTPUT_FOLDER && cookiecutter $SCAF_ROOT --no-input --config-file $TEST_CONFIG -o $OUTPUT_FOLDER -v
Run the script and check the output folder for the generated project.
To test run the project using your branch for scaf and the cookiecutter you have to tell it which branch and repo to use. Here is an example script to do that:
(You will need to adjust the paths and branch name to match your setup):
#! /bin/bash
SCAF_ROOT=/Users/gfranxman/sfu/ScafDev/scaf
OUTPUT_FOLDER=./scaf-test
TEST_CONFIG=./scaf-cookiecutter.yaml
BRANCH_NAME=gfranxman/configure-git-remote
BASE_REPO=https://github.com/sixfeetup/scaf.git
rm -rf $OUTPUT_FOLDER && \
$SCAF_ROOT/scaf myproject --no-input --checkout $BRANCH_NAME ${BASE_REPO}