feat(docs): updates contribution guide to local-dev setup #1232
Conversation
This file contains hidden or 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
2 tasks
| docker run --network host -e DEV_ENV_CONTEXT=<your-context> -v ./envtest:/envtest -v /tmp/k8s-webhook-server/serving-certs:/webhook-certs ghcr.io/cloudoperators/greenhouse-dev-env:main | ||
| ``` | ||
| > [!NOTE] | ||
| > The deployed controller-manager is running in webhook only mode, but it does not receive any requests |
There was a problem hiding this comment.
We have split deployment for webhook and controller now so we only bring in the necessary component based on the command.
| apiVersion: greenhouse.sap/v1alpha1 | ||
| kind: PluginDefinition | ||
| metadata: | ||
| name: cert-manager |
There was a problem hiding this comment.
Do we need to make a note saying do not apply this Plugin in admin cluster as it will conflict with the cert-manager brought in by all the make setup commands?
but it is completely fine to apply the Plugin targeting remote cluster.
| - The manager `Deployment` has environment variables `WEBHOOK_ONLY` and `CONTROLLERS_ONLY` | ||
| - `WEBHOOK_ONLY=true` will only run the webhook server | ||
| - `CONTROLLERS_ONLY=true` will only run the controllers | ||
| - Only one of the above can be set to `true` at a time otherwise the manager will error out |
There was a problem hiding this comment.
This whole section is irrelevant as we have split the deployment and these env variables are part of the deployment.yaml for the respective components
| ## Run And Debug The Code | ||
| - Override devMode for webhook development with d=true or devMode=true | ||
| - Override helm chart installation with c=true or crdOnly=true | ||
| - Override environment variables for manager deployment with e="ENV_NAME=VALUE" or env="ENV_NAME=VALUE" (can be repeated) |
There was a problem hiding this comment.
All the overrides are irrelevant now
uwe-mayer
commented
Jun 25, 2025
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
The contribution guide on how to run the local Greenhouse setup was out of date. This PR fixes that.
What type of PR is this? (check all applicable)
Related Tickets & Documents