Getdeck Desktop

A tool suite to provide reproducible Kubernetes environments for development and testing.
Install · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Getting Started

Prerequisites

In order to use Getdeck Desktop to connect to a remote cluster, Docker Engine needs to run on your machine. Running the AppImage on Linux requires Fuse.

Installation

Note: The tarballs attached to releases are update packages.

1. Download a version of Getdeck Desktop from the releases page that fits your operating system. Currently, we support Linux, MacOS and Windows.
2. Follow the installation process for your operating system.
3. After starting Getdeck Desktop, create an account. (It's free!)
4. You are now able to create a ephemeral, remote kubernetes cluster and connect your machine to it. 🚀

(back to top)

Usage

Getdeck Desktop allows you to create virtual, remote kubernetes clusters easily through the UI. First, create a new cluster through the UI via the create dialog. Pick a name, choose ports that should be available for you later and hit create. Once the cluster is ready, you will see a green RUNNING badge in the cluster list. Next, hit the connect icon to enable port forwardings between the remote virtual cluster and your machine. As soon as the connection is established, you can copy the path to the kubeconfig, set the KUBECONFIG env variable in your favorite shell and use any tool that can talk to the Kubernetes API server!🚀

(back to top)

Roadmap

• Shelf clusters
• ...
• ...

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

If you're stuck or just want to have a chat, please join the Team Blueshoe Discord!

(back to top)