proposal(crossplane project): add configuration options to support users in closed networks and devcontainers
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- docker, go, kubernetes
- Domain
- cli, infrastructure
Research direction
Start in internal/project/controlplane/controlplane.go, especially the kubeconfig export around line 419, cluster creation around line 449, and createKindClusterConfig around line 472. Trace the existing project command and KinD configuration, then validate the proposed internal kubeconfig, Docker network, and registry-mirror options in a devcontainer or closed-network setup.
Written by the indexing model from the issue text.
Description
Hi, awesome that crossplane project has been added and cant wait to try it out more, but unfortunately it is currently unusable for people who develop in devcontainers and in a closed company networks.
I've done some digging and i believe i would have to add 3 functionalities for this to work seamlessly.
- Configuring internal kubeconfig
Currently the crossplane project command only exports the kubeconfig with the external addresses:
https://github.com/crossplane/cli/blob/main/internal/project/controlplane/controlplane.go#L419
This could be fixed by adding an option to configure the export of the KinD kubeconfig with an --internal flag to use the internal addresses which are reachable inside devcontainer.
This fixes the following error on startup:
crossplane: error: failed to create crossplane-system namespace: failed to get server groups: Get "https://127.0.0.1:35341/api": dial tcp 127.0.0.1:35341: connect: connection refused
- Configuring kind docker network
While this solves the initial connectivity issue from a devcontainer, the cluster creation will still not work seamlessly as the "kind" docker network is automatically created. And this docker network does not automatically have connectivity to the dev-container.
A simple solution for this is that the user is allowed to specify the docker-network that kind should use when starting the up the containers. Perhaps with a --docker-network="" flag?
But KinD does not expose this as a configuration option in the go-library.
The only solution that i have found is to set the environment variable KIND_EXPERIMENTAL_DOCKER_NETWORK.
I quickly tested to set this environment-variable before the cluster creation before this line and it worked:
os.Setenv("KIND_EXPERIMENTAL_DOCKER_NETWORK", "the-network-my-devcontainer-is-in")
- Configure containerd registry mirrors
The last hurdle to overcome i believe, is configuring the containerd registry mirrors so that KinD fetches images from the configured registry-proxies.
In closed network environments, it is usually required that container-images are fetched via a central registry, so for example docker.io cannot be reached directly.
With the assumption that if a user passes ImageConfigs via the --init-resources flag, the user also most likely would like to configure the containerd registry mirrors, it seems like the best option is to parse the ImageConfigs the user supplies and configure the containerd with the containerdConfigPatches option in KinD like this:
containerdConfigPatches:
- |
[plugins."io.containerd.grpc.v1.cri".registry.mirrors]
[plugins."io.containerd.grpc.v1.cri".registry.mirrors."docker.io"]
endpoint = ["https://docker-remote.my-registry-proxy.com"]
This could be done in the existing createKindClusterConfig function.
What do you think? I'd be happy to send in a PR and test it more, but is this something you want to add support for?
Let me know if you have any questions!
What problem are you facing?
Running crossplane project in a dev-container and closed company network.
- Dominant language
- Go
- Stars
- 19
- Forks
- 31
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 53
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from crossplane/cli
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
crossplane/cli#282 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
crossplane/cli#384 ·
-
crossplane/cli#379 · 1 assignee ·
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 68/100
crossplane/cli#370 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 28/100
crossplane/cli#369 ·
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 60/100
github/gh-aw-mcpg#13748 ·
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
googleapis/librarian#7670 · 2 comments ·