deploy

Deploying Projects

Overlord is designed with GitOps in mind, so the workflow is very simple but efficient: create a deployment file, deploy the project and check the status. This is very useful in combination with a CI/CD where every change in your deployment file means a new deployment with new changes.

1. Create a deployment file.

   hello-http.yml:

    kind: directorProject
    datacenters:
      main:
        entrypoint: 'http://127.0.0.1:8888'
        access_token: '<access token>'
    deployIn:
      labels:
        - desktop
    projectName: hello-http
    projectFile: |
      options:
        - virtualnet: ':<random> default'
        - nat:
      services:
        hello-http:
          makejail: gh+DtxdF/hello-http-makejail

2. Deploy.

   overlord apply -f hello-http.yml

3. Check status.

   $ overlord get-info -f hello-http.yml -t projects --filter-per-project
   datacenter: http://127.0.0.1:8888
     entrypoint: main
     chain: None
     labels:
       - all
       - desktop
       - vm-only
     projects:
       hello-http:
         state: DONE
         last_log: 2025-03-03_13h41m39s
         locked: False
         services:
           - {'name': 'hello-http', 'status': 0, 'jail': 'a667371b48'}
         up:
           operation: COMPLETED
           output:
            rc: 0
            stdout: {'errlevel': 0, 'message': None, 'failed': []}
           last_update: 44.29 seconds
           job_id: 1
           labels:
            error: False
            message: None
            load-balancer:
              services:
                hello-http:
                  error: False
                  message: None
            skydns:
              services:
                hello-http:
                  error: False
                  message: None

4. Destroy project.

   overlord destroy -f hello-http.yml