gk

generator-kubegen

A Kubernetes config generation tool that deals with boilerplate code and let's you focus on the important details

Showing:

Popularity

Downloads/wk

9

GitHub Stars

51

Maintenance

Last Commit

4yrs ago

Contributors

0

Package

Dependencies

2

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Yeoman generator for you Kubernetes boilerplate code

Build Status Coveralls Version npm

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 generator, so you'll need to have NodeJS installed.

Installation

To install kubegen, you need to execute the following command:

npm install -g generator-kubegen

Usage

Quite easy! The follwing commands are available at the moment:

CommandDescriptionArguments
yo kubegenStarts 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:deploymentStarts the Deployment subgenerator. 'deployment.yml' file is created, in the current folder.
yo kubegen:rcStarts the Replication Controller subgenerator. 'rc.yml' file is created, in the current folder.
yo kubegen:serviceStarts the Service subgenerator. 'service.yml' file is created, in the current folder.
yo kubegen:ingressStarts the Replication Controller subgenerator. 'deployment.yml' file is created, in the current folder.
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? Deployment
? (Deployment) Which Docker image should the Deployment use? nginx
? (Deployment) 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) Does the service have a hostname? nginx.sesispla.net
? (Ingress) Ingress root path? /
? (Ingress) In which port should the Ingress listen? 80
   create deployment.yml
   create svc.yml
   create ing.yml

Contributing

Contribution is welcome! Just:

  • Fork this project
  • install the NPM dependencies:
npm install
  • Link this folder to npm
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. 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.

debug with VSCode

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100