Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Getdeck/getdeck
A CLI that creates reproducible Kubernetes environments for development and testing
https://github.com/Getdeck/getdeck
cli hacktoberfest kubernetes terminal
Last synced: 2 months ago
JSON representation
A CLI that creates reproducible Kubernetes environments for development and testing
- Host: GitHub
- URL: https://github.com/Getdeck/getdeck
- Owner: Getdeck
- License: apache-2.0
- Created: 2022-03-25T18:54:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-12T08:03:31.000Z (over 1 year ago)
- Last Synced: 2024-11-01T02:06:08.262Z (3 months ago)
- Topics: cli, hacktoberfest, kubernetes, terminal
- Language: Python
- Homepage: https://getdeck.dev
- Size: 1.21 MB
- Stars: 90
- Watchers: 8
- Forks: 2
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Coverage Information][coveralls-shield]][coveralls-url]
Getdeck
A CLI that creates reproducible Kubernetes environments for development and testing!
Explore the docs »
Getting started
·
Report Bug
·
Request Feature
Table of Contents
## About the project
Getdeck is like docker-compose for Kubernetes: Find a Deckfile that is describing your setup,
run `deck get ...` and you are ready to work. No Kubernetes knowledge required.
**Simple to use**
Just install the binary executable `deck` and you are good to go.
**All dependencies managed**
Helm, kustomize, k3d, kubectl? Getdeck manages all dependencies for your setup so you don't have to.
### Built with
Getdeck builds on top of the following popular open-source technologies:
### Docker
[*Docker*](https://docker.io) is currently used to run all the required tooling from the Kubernetes ecosystem, so you
don't have to install _everything_ yourself.
### k3d
[*k3d*](https://k3d.io) is supported to run local Kubernetes cluster.
### kind
[*kind*](https://kind.sigs.k8s.io/) is supported to run local Kubernetes cluster.
## Getting Started
You can easily try Getdeck yourself following this small example.
### Prerequisites
1) Follow the [installation](https://getdeck.dev/docs/installation/) for your preferred platform.
### Running Getdeck
We provide a sophisticated demo project you can deploy locally using `Getdeck`:
```bash
deck get https://github.com/gefyrahq/gefyra-demos.git
```
This might take a few minutes. When it's done, open your browser at
[http://dashboard.127.0.0.1.nip.io:8080/#/workloads?namespace=oauth2-demo](http://dashboard.127.0.0.1.nip.io:8080/#/workloads?namespace=oauth2-demo).
You should see a kubernetes dashboard with some information about the namespace we just deployed using `deck`!
### Cleaning up
To clean it up (i.e. remove the cluster), just run the following command:
```bash
deck remove --cluster https://github.com/gefyrahq/gefyra-demos.git
```
Now go and write your own [Deckfile](https://getdeck.dev/docs/deckfile-specs/)!
## Usage
The following actions are available in Getdeck's CLI:
- `get`: setup local development infrastructure, install a [deck](https://getdeck.dev/docs/overview/what-is-a-deck/)
- `remove`: remove Getdeck's development infrastructure and/or just the deck
- `list`: list the available decks of a [Deckfile](https://getdeck.dev/docs/deckfile-specs/)
- `version`: print the current version and exit
_For more examples, please refer to the [CLI documentation](https://getdeck.dev/docs/cli-reference/)_
## License
Distributed under the Apache License 2.0. See `LICENSE` for more information.
## Reporting Bugs
If you encounter issues, please create a new issue on GitHub or talk to us on the
[Unikube Slack channel](https://unikubeworkspace.slack.com/).
When reporting a bug please include the following information:
Getdeck version or Git commit that you're running (`deck version`),
description of the bug and logs from the relevant `deck` command (if applicable),
steps to reproduce the issue, expected behavior.
If you're reporting a security vulnerability, please follow the process for reporting security issues.
## Acknowledgments
Getdeck is sponsored by the [Blueshoe GmbH](https://blueshoe.io).
[contributors-shield]: https://img.shields.io/github/contributors/Getdeck/getdeck.svg?style=for-the-badge
[contributors-url]: https://github.com/Getdeck/getdeck/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Getdeck/getdeck.svg?style=for-the-badge
[forks-url]: https://github.com/Getdeck/getdeck/network/members
[stars-shield]: https://img.shields.io/github/stars/Getdeck/getdeck.svg?style=for-the-badge
[stars-url]: https://github.com/Getdeck/getdeck/stargazers
[issues-shield]: https://img.shields.io/github/issues/Getdeck/getdeck.svg?style=for-the-badge
[issues-url]: https://github.com/Getdeck/getdeck/issues
[license-shield]: https://img.shields.io/github/license/Getdeck/getdeck.svg?style=for-the-badge
[license-url]: https://github.com/Getdeck/getdeck/blob/master/LICENSE.txt
[coveralls-shield]: https://img.shields.io/coveralls/github/Getdeck/getdeck/main?style=for-the-badge
[coveralls-url]: https://coveralls.io/github/Getdeck/getdeck