kubernetes-client/python

`LocationParseError` on autogenerated kubectl from Juju

Open

#2,031 opened on Mar 20, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (3,323 forks)batch import
help wantedkind/feature

Repository metrics

Stars
 (6,225 stars)
PR merge metrics
 (Avg merge 10d 3h) (2 merged PRs in 30d)

Description

What happened (please include outputs or screenshots): Juju generates kubectl configs for users when adding them to a Juju controller and supports multiple main controllers resulting in an array output in the hostname. When running config.load_kube_config() a urllib3.exceptions.LocationParseError is returned as it cannot parse the array correctly.

The configuration file works perfectly well with kubectl.

What you expected to happen: One of the following:

  1. A standard failover attempt system when connecting
  2. All IPs validated, random one used
  3. All IPs validated, first one used

How to reproduce it (as minimally and precisely as possible):

Add square brackets around the IP/hostname in your kubectl config file as shown below

apiVersion: v1
clusters:
- cluster:
    certificate-authority-data: ...
    server: https://[10.1.x.x, 10.1.x.y]:443
  name: juju-cluster

Environment:

  • Kubernetes version (kubectl version):
Client Version: v1.26.3
Kustomize Version: v4.5.7
Server Version: v1.25.8
  • OS (e.g., MacOS 10.13.6): Ubuntu 20.04
  • Python version (python --version) 3.9.13
  • Python client version (pip list | grep kubernetes) 26.1.0

Contributor guide

Research direction
Trace how the kubeconfig loader parses server URLs and investigate the handling of array like hostnames (e.g., [ip1, ip2]). Identify where LocationParseError is raised in urllib3 and modify the parsing to accept such formats or perform validation and selection of a single IP.
Tech stack
python
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonKuberneteskubectlurllib3
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65