kubebuilder-initializer-plugin

README

Kubebuilder Initializer Plugin

A powerful Kubebuilder plugin to initialize dynamically the structure of your kubebuilder operator repositories.

Getting started

Installation

Prerequisites

This is a plugin for the kubebuilder tool. In case of you haven't installed the tool yet, please visit the kubebuilder documentation and follow the instructions to get kuberbuilder properly installed in your computer.

Homebrew

Download the executable files

1. Visit the latest release at Release page
2. Download the version that works for you
3. Extract the files in the tarball that you downloaded in the previous step
4. Copy the executable file to the path used by Kubebuilder to read the external plugins
   • OSX: ~/Library/Application\ Support/kubebuilder/plugins/kubebuilder-initializer/v1-alpha
   • Linux: $HOME/.config/kubebuilder/plugins/kubebuilder-initializer/v1-alpha

Build from the code

git clone https://github.com/astrokube/kubebuilder-initializer-plugin.git
cd kubebuilder-initializer-plugin
make build install

To check that installation was success, please check that the executable file was copied to the folder used by Kubebuilder to read the plugins

• OSX: ~/Library/Application\ Support/kubebuilder/plugins/kubebuilder-initializer/v1-alpha
• Linux: $HOME/.config/kubebuilder/plugins/kubebuilder-initializer/v1-alpha

How this plugin work

To deep dive into how Kubebuilder deals with external plugins you can visit the following article Extensible CLI and Scaffolding Plugins - Phase 2

Contributing

Visit the CONTRIBUTING.md file.