VastOps Templates

This repo assists Vast's users in deploying infrastructure through the Ops method, see the issue get more information.

Only the operator host required nix, and make sure you have enabled the ssh service on your deploy target host. The target host doesn't need to install any dependencies.

Required files

• exmaple: ./profiles/demo

files
config.toml	hosts's information
deploy.env	env variables for deploying process
flake.lock	No need modify, just for locking the files
vast.yaml	You just need to add some necessary values and it will be updated/merged in the final template

Create your custom profile for deploying.

1. fork the tempalte repo and mkdir -p ./profiles/<name>

2. cp the required files to your specific profile directory, and modify those files to your expectation.

3. add those files to git staged

4. write your own justfile commands, then run just deploy <profile-name> <task>

   • Optional: nix develop or direnv

     nix develop ./devshell
     just deploy <profile-name> <task>
     # example command
     just profiles demo all
     

   • Optional: run native command with:

   nix run -Lv github:gtrunsec:vast2nix#x86_64-linux.user.entrypoints.deploy --override-input user    ./profiles/test -- all

Env variables

Deployment

# can be  [ "vast-bin" "vast-release" "vast-latest"]
[email protected]
SSH_OPT1="-p 22 -o StrictHostKeyChecking=no"
DIR1="/opt/vast-env"

[email protected]
SSH_OPT2="-p 22 -o StrictHostKeyChecking=no"
# target directory
DIR2="/usr/share/vast-env"

Command Actions

• example to profiles/demo

$ nix run -Lv github:gtrunsec/vast2nix\#x86_64-linux.user.entrypoints.deploy 
\ --override-input lock ./profiles/demo \
-- --env-file=./profiles/demo/deploy.env -t all

• user interface:

$ nix run -Lv github:gtrunsec/vast2nix\#x86_64-linux.user.entrypoints.deploy
\ --override-input lock ./<profiles-dir> \
-- --env-file=<profiles-dir>/<env-file> -t <task-name>

• display documentation for the current command/action

$ nix run -Lv github:gtrunsec/vast2nix\#x86_64-linux.workflows.entrypoints.deploy 
\--override-input lock ./<profiles-dir> \
-- doc