Skip to content

README.md

Latest commit

 

History

History
60 lines (37 loc) · 2.37 KB

README.md

File metadata and controls

60 lines (37 loc) · 2.37 KB
Raw

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.

make test
# or
# make acc
# make e2e

📚 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@latest
  2. Run godoc godoc -http=:6060
  3. Visit http://localhost:6060/pkg/go-deploy/

API

The API is documented using OpenAPI 3.1.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.