Getting started

Goal

This first tutorial will guide you from zero to having all the instanciation boilerplate ready for action.

Requirements

Install `mise` CLI

mise is a polyglot tool version manager, it replaces tools like asdf, nvm, pyenv, task or direnv.

Follow the official guide for installation.

Create a project dir

Create new directory

Run

mkdir toc-dawn-dust
cd toc-dawn-dust

Install requirements

Download this mise.toml file into the created directory.

Then run:

Run

mise trust
mise install
mise run prepare

Init TOC file tree

Run

mise toc:init <toc_workspace> <toc_parent_domain>

Tip

This directory will handle root-level secrets on your environment. Think about git-ing this directory to save these files and handle permissions on their access through your Git service portal (Github, Gitlab, Forgejo, ...).

(alt) Set your crendentials

Supplying the hosts where you will deploy TOC can be done is may ways.

The golden path for the project validation implies Terraform and Scaleway as a provider.

If you intend to use the golden path or copycat it, mind that AK/SK values are, for the least, better stored in a local environement file than hardcoded into any file.

Fill your local env

Create a mise.local.toml file like so:

mise.local.toml
[env]
# Scaleway credentials (for demo infra)
SCW_ACCESS_KEY              = "<your access key>"
SCW_SECRET_KEY              = "<your secret key>"

# Scaleway resources placement hints (for demo infra)
SCW_DEFAULT_ORGANIZATION_ID = "<your org id>"
SCW_DEFAULT_PROJECT_ID      = "<your project id>"
SCW_DEFAULT_REGION          = "<your default region>"
SCW_DEFAULT_ZONE            = "<your default zone>"

Tip

If you chose to git your directory, think about ignoring this file.

.gitignore
1	`mise.local.toml`

Achievement unlocked

TOC platform instance deployment is tooling-ready.