feat(dev-env): Setup local development environment using greenhousectl #452
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KinD cluster creation functionality. Additionally, can get a kind cluster, list kind clusters
cluster command to create kind cluster and optionally create a namespace after cluster creation
manifests cmd explodes the specified chart by doing a helm template and applies it to the KinD cluster using kubectl apply
webhook command will deploy the operator to run in webhook only mode so that local development of controllers can be done without running webhooks. Validation and mutation of CR(s) will happen in-cluster
setup command uses a config file to spin up a full development environment
auto-generates docs for cobra commands
in order to reduce complexity and encourage contributions by end users, dev CLI commands are moved from standalone to greenhousectl
…enhouse into feat/localenv
make command to build greenhousectl locally and setup the dev env
IvoGoman
requested changes
Aug 28, 2024
Co-authored-by: IvoGoman <ivo.gosemann@sap.com>
Co-authored-by: IvoGoman <ivo.gosemann@sap.com>
IvoGoman
approved these changes
Aug 29, 2024
kengou
approved these changes
Aug 29, 2024
uwe-mayer
approved these changes
Aug 29, 2024
andypf
pushed a commit
that referenced
this pull request
Sep 4, 2024
#452) * (chore): init local env cli * (chore): adds kind cluster creation KinD cluster creation functionality. Additionally, can get a kind cluster, list kind clusters * (chore): adds cluster command cluster command to create kind cluster and optionally create a namespace after cluster creation * (chore): common variables * (chore): adds environment variables to disable webhooks and controllers * (chore): adds cluster list and delete commands * (chore): adds manifests command manifests cmd explodes the specified chart by doing a helm template and applies it to the KinD cluster using kubectl apply * (chore): adds webhook command webhook command will deploy the operator to run in webhook only mode so that local development of controllers can be done without running webhooks. Validation and mutation of CR(s) will happen in-cluster * (chore): adds setup command setup command uses a config file to spin up a full development environment * (chore): adds CLI markdown docs auto-generates docs for cobra commands * (chore): move commands to greenhousectl in order to reduce complexity and encourage contributions by end users, dev CLI commands are moved from standalone to greenhousectl * (chore): adds error handling and logging * (fix): fixes typo * Automatic application of license header * (chore): adds review dog lint * (fix): address lint issues * (chore): use review dog linting * (chore): update reviewdog lint version * (chore): run lint as a separate job * (chore): adds make setup dev make command to build greenhousectl locally and setup the dev env * (chore): adds dev setup configuration * (chore): adds dev setup docs * (chore): adds dev setup make commands * (chore): reverts changes to unit-tests.yml * (chore): tidy up! * (chore): move to greenhousectl dev subcommands * (chore): tidy up * Automatic application of license header * (chore): tidy up * tidy up * (chore): use method chains * (chore): regenerate docs * Automatic application of license header * (fix): fix linting errors * (chore): regenerate docs * (revert): revert greenhousectl worklflow * (chore): go fmt and tidy up! * Automatic generation of CRD API Docs * (chore): remove unused method * Automatic generation of CRD API Docs * (chore): re-run manifest generation * Automatic generation of CRD API Docs * (chore): refactor helm install * Automatic generation of CRD API Docs * Update dev-env/localenv/README.md Co-authored-by: IvoGoman <ivo.gosemann@sap.com> * Automatic generation of CRD API Docs * Apply suggestions from code review Co-authored-by: IvoGoman <ivo.gosemann@sap.com> * (chore): provides back-off options * (chore): removes unnecessary var assignment * (chore): reuse existing build command * (chore): provide helm client options as single slice * (chore): generate dev setup markdown with templates * (chore): allow one of webhook or controller modes or regular * Automatic generation of CRD API Docs * (chore): adds docker and kubectl check to persistent pre-run dev cmds * (chore): tidy up * Automatic generation of CRD API Docs * (chore): go fmt * (chore): go fmt * Automatic generation of CRD API Docs * (chore): upd variables * Automatic generation of CRD API Docs --------- Co-authored-by: License Bot <license_bot@github.com> Co-authored-by: CRD API Docs Bot <crd_api_docs_bot@github.com> Co-authored-by: IvoGoman <ivo.gosemann@sap.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Introduces a
devsub-command ingreenhousectlCLI to bootstrap local development environment usingKinDclusters.config.jsonAdditional commands to -
WEBHOOK_ONLYmode to focus on controller development locallyValidatingWebhookConfigurationandMutatingWebhookConfigurationto do webhook development locallyWhat type of PR is this? (check all applicable)
Related Tickets & Documents
Checklist