(Fixes #19) Added documentation for running the operator locally #20
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
joshlreese
reviewed
Jun 18, 2025
README.md
Outdated
Comment on lines
74
to
78
| 1. Create a symbolic link to your kubeconfig: | ||
| ```sh | ||
| ln -s ~/.kube/config ./infra.kubeconfig | ||
| ``` |
Contributor
There was a problem hiding this comment.
I would not recommend making this symlink - the KUBECONFIG env var can be used, or option 2 as noted below.
README.md
Outdated
| 2. Or modify the configuration in `config/dev/config.yaml` to point to your kubeconfig file: | ||
| ```yaml | ||
| downstreamResourceManagement: | ||
| kubeconfigPath: /path/to/your/kubeconfig |
Contributor
There was a problem hiding this comment.
This should be the path to the .kind-nso-infra.yaml kubeconfig.
Maybe we can update the Makefile to have those exported somewhere automatically, or add sub commands for some of the actions below, to avoid manual steps and env var juggling?
|
|
||
| # The topology of the location | ||
| topology: | ||
| topology.datum.net/city-code: "us-central1" |
Contributor
There was a problem hiding this comment.
Should use a city code that'll work for IPAM today (Only DFW, DLS, and LHR will work at the moment):
Suggested change
| topology.datum.net/city-code: "us-central1" | |
| topology.datum.net/city-code: "DFW" |
Collaborator
Author
|
@joshlreese updated! |
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.
This PR adds a step-by-step guide for running the network-services-operator locally, covering prerequisites, cluster setup, CRD installation, and local execution using make run. It’s aimed at improving the local development experience and onboarding for new contributors.