kthcloud / go-deploy

Creation and management of resources on kthcloud

go-deploy is an API that is used to create container applications and virtual machines built on top of kthcloud using Kubernetes with KubeVirt.

It is hosted at https://api.cloud.cbh.kth.se/deploy/v2 using kthcloud authentication.

🛠️ Local environment

go-deploy can be hosted locally using the setup.sh script found under the scripts/local directory. The script will set up an entire local environment with every service installed in a Kind Kubernetes cluster on your local machine.

Refer to the local environment documentation for more information.

🤝 Contributing

Contributions, issues, and feature requests are welcome!
You can install a local development environment by following the local environment documentation.

Remember to run the tests before creating a pull request.

Acceptance Tests

go test ./test/acc/...

End-to-End Tests

go build -o go-deploy .     # Build
./go-deploy --mode=test     # Start

# Wait for the API to return 200 on /healthz
until $(curl --output /dev/null --silent --head --fail http://localhost:8080/healthz); do
    echo "Waiting for API to start"
    sleep 1
done
go test ./test/e2e/...          # Run e2e tests

📚 Docs

Codebase

The code base is documented using godoc. You can view the documentation by running the documentation server locally.

1. Install godoc go install golang.org/x/tools/cmd/godoc
2. Run godoc godoc -http=:6060
3. Visit http://localhost:6060/pkg/go-deploy/

API

The API is documented using OpenAPI 3.0 specification and is available at https://api.cloud.cbh.kth.se/deploy/v2/docs/index.html.

You can also run the API locally by setting up the local environment and visiting http://localhost:8080/v2/docs/index.html.

Contributions, issues, and feature requests are welcome!

If you have any questions or feedback, open an Issue or join Discord channel.

📝 License

go-deploy is open-source software licensed under the MIT license.

📧 Contact

If you have any questions or feedback, open an Issue or join Discord channel.

go-deploy's Issues

Add support for inter-app communication without using public URLs

Persistent storage for deployments

add cloudstack subsystem

Add support for env in deployments

View build status of deployment

Fix copyright in license

Seems the MIT license includes some copyright, this should be kthcloud and not Scott Chacon

add support for vm creation

Auto deploy nginx redirect for VMs

write tests for pfsense

Ensure docker images are private in Harbor for private deployments

Debug logs on deployments

add stream in proxy manager so any hostname may be used

Create GitHub link account routes in backend

Split go-deploy to api + workers to enable api scaling

Change GPU lease to library book reservation model

create template for vm creation

add pfsense port forwarding to vm creation

fix github webhook hook id not fetched and inserted into database if it already exists

create cloudstack vm template with preconfigured ubuntu

Update wiki

move to own keycloak client 'deploy'

add tests for cloudstack vm status

add get connection string route for vm

Create new user tiers

• Base user (KTH SSO)

  • 1 core
  • 4 GB ram
  • 20 GB storage
  • 5 deployments
  • No GPU

• Middle tier

  • 8 cores
  • 50 GB ram
  • 500 GB storage
  • 20 Deployments
  • Autoselect B tier GPU

• Power User

  • 20 cores
  • 100GB ram
  • 2 TB storage
  • 100 Deployments
  • Choose GPU (Access to A tier RTX cards)

• Admin

  • Unlimited

add kubernetes status to deployment status

currently deployment status is only one of resourceBeingCreated, resourceBeingDeleted, resourceCreated

Expose build logs

Expand disk to fill entire VM

Handle out of GPUs error

Support for deploying to Kista zone

When connecting to github, run workflow directly on create

add status route for vm

change code/status to snake or camel case

Add full API support for attaching GPU

Handle allocation lease ran out

add entries in dns to allow hostnames to be used when connecting to vm via ssh

Remove buildx and qemu from the actions yml

Create VM backup/snapshot feature

write tests for cs public ip and port forward

Allow snapshots for VMs with GPU

Detach GPU -> snapshot -> Attach GPU

add auth check when user tries to fetch all deployments/vms

currently everyone can add "all=true" parameter in the api

Template sizes for deploy

• 8 cores, 20 cores pro
• disk 500gb (pro user 2 tb)
• fix in cloud init to use 100% of disk
• 2048 mhz for all users
• 50 gb ram (100 gb pro user)

1 to 1 mapping of public IP to cloudstack

Allow custom images to be uploaded to run the VM

move app url from <app>.dev to <app>.deploy.dev

Upload key to user profile

Keep name and key

Add support for multiple deployments connected to the same github repo

change "project" to "deployment"

Allow custom domains

add json fields for ci config route

User snapshot creation and restore