https://github.com/sesispla/generator-kubegen
A Kubernetes config generation tool that deals with boilerplate code and let's you focus on the important details
https://github.com/sesispla/generator-kubegen
generator istanbul kubernetes mocha nodejs yeoman yeoman-generator
Last synced: 6 months ago
JSON representation
A Kubernetes config generation tool that deals with boilerplate code and let's you focus on the important details
- Host: GitHub
- URL: https://github.com/sesispla/generator-kubegen
- Owner: sesispla
- License: mit
- Created: 2017-07-01T09:58:00.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-23T13:39:30.000Z (almost 9 years ago)
- Last Synced: 2025-05-11T11:37:47.441Z (about 1 year ago)
- Topics: generator, istanbul, kubernetes, mocha, nodejs, yeoman, yeoman-generator
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 50
- Watchers: 4
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-kubernetes-configuration-management - generator-kubegen
README
# Yeoman generator for you Kubernetes boilerplate code
[](https://travis-ci.org/sesispla/generator-kubegen)
[](https://coveralls.io/github/sesispla/generator-kubegen)
[](https://www.npmjs.com/package/generator-kubegen)
kubegen is a tool that aims to simplify your Kubernetes day-to-day, writing the boilerplate code for you and letting you focus on the important things.
kubegen is a [Yeoman](http://yeoman.io) generator, so you'll need to have [NodeJS](https://nodejs.org/) installed.
# Installation
To install kubegen, you need to execute the following command:
```bash
npm install -g generator-kubegen
```
# Usage
Quite easy! The follwing commands are available at the moment:
| Command | Description | Arguments |
| ---------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| yo kubegen | Starts a full Kubernetes file generation wizard. All generated files are stored in a new folder. | --apply: Spawns a "kubectl apply -f " to all files generated immediately |
| yo kubegen:deployment | Starts the Deployment subgenerator. 'deployment.yml' file is created, in the current folder. | |
| yo kubegen:rc | Starts the Replication Controller subgenerator. 'rc.yml' file is created, in the current folder. | |
| yo kubegen:service | Starts the Service subgenerator. 'service.yml' file is created, in the current folder. | |
| yo kubegen:ingress | Starts the Replication Controller subgenerator. 'deployment.yml' file is created, in the current folder. | |
| yo kubegen:lego | Starts the Let's Encrypt subgenerator. All the internal components required by a TLS Ingress with kube-lego is created by this subgen | |
```bash
yo kubegen
| |/ / | | | | | _ \ | ____| / _____|| ____|| \ | |
| ' / | | | | | |_) | | |__ | | __ | |__ | \| |
| < | | | | | _ < | __| | | |_ | | __| | . ` |
| . \ | `--' | | |_) | | |____ | |__| | | |____ | |\ |
|__|\__\ \______/ |______/ |_______| \______| |_______||__| \__|
Welcome to Kubernetes Generator (kubegen)!
? How the service should be named? nginx
? In which Namespace should be deployed? default
? Which type of Pod controller mechanism whould you like to use? Replication Controller
? (Replication Controller) Which Docker image should the Deployment use? nginx
? (Replication Controller) How much container replicas should be created? 1
? (Service) In which port is the Container listening? 80
? (Service) In which port should the Service listen? 80
? (Ingress) Would like to expose the service out of the cluster? yes
? (Ingress) Which class of expose would you like?
❯ external
internal
nginx
tls-lego
```
# Contributing
Contribution is welcome! Just:
- Fork this project
- install the NPM dependencies:
```bash
npm install
```
- Link this folder to npm
```bash
npm link
/usr/local/lib/node_modules/generator-kubegen -> /Users/User/generator-kubegen
```
- Edit the project with your favorite text editor or tool
# Debugging
For your conveniente, this project comes with a pre-built configuration to debug the solution with [Visual Studio Code](https://code.visualstudio.com). Just go to the "Debug" menu on the left, select "Yeoman generator" in the dropdown (beside "play button") and then click "play" to start debugging.
